Skip to main content
POST
/
v3
/
financial-services
/
credit-bureau
/
equifax
/
credit-report
/
sdk
/
session
Handle Create Sdk Session
curl --request POST \
  --url https://production.deepvue.tech/v3/financial-services/credit-bureau/equifax/credit-report/sdk/session \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "redirect_uri": "<string>",
  "mobile_number": "<string>",
  "full_name": "<string>",
  "version": "v2",
  "enrich": false
}
'
{
  "code": 201,
  "timestamp": 1751922499674,
  "transaction_id": "a73af0b7accc4c3fbaa3dd2dc2cab550",
  "sub_code": "SUCCESS",
  "message": "SDK session created successfully.",
  "data": {
    "redirect_url": "https://sdk.deepvue.ai/v1/credit-report/equifax?session_id=bee5325d10124a18a322ca268542aa06&signature=ddfc046359adca4e8d31cbce13597b1307f7c61923da3b4ee78f60e6f9524123&redirect_uri=https://deepvue.tech"
  }
}

Authorizations

​
Authorization
string
header
required

ACCESS_TOKEN generated from the authorize endpoint. Should be included in the header as Bearer .

​
x-api-key
string
header
required

The CLIENT_SECRET provided to you. This header parameter is required for authentication purposes.

Body

application/json

Defines the body for the session initiation request.

​
redirect_uri
string<uri>
required

This is the URL to your own application where you want the end user to be finally redirected once the consent is given.

Required string length: 1 - 2083
​
mobile_number
string

Pass Mobile Number if you wish this to be pre-filled in the UI form

​
full_name
string

Pass user's Full Name as per PAN if you wish this to be pre-filled in the UI form

​
version
string
default:v2

Pass version=v3 to fetch the credit report as per the latest version during download

​
enrich
boolean
default:false

Pass enrich=true if you wish to generate a report even when there is no existing credit history.

Response

Successful Response