Skip to main content
POST
/
vkyc
curl --request POST \ --url https://sandbox.cashfree.com/verification/vkyc \ --header 'Content-Type: application/json' \ --header 'x-api-version: <x-api-version>' \ --header 'x-client-id: <api-key>' \ --header 'x-client-secret: <api-key>' \ --data ' { "verification_id": "vkyc_verification_id", "user_template": "vkyc_user_template_v1", "agent_template": "vkyc_agent_template_v1", "user_reference_id": 1234, "notification_types": [ "sms", "whatsapp" ] } '
{
  "verification_id": "vkyc_verification_id",
  "reference_id": 1358,
  "user_reference_id": 11174,
  "status": "RECEIVED",
  "sub_status": "LINK_GENERATED",
  "vkyc_link": "https://forms.cashfree.com/verification/s7ml5i0",
  "user_id": "vkyc_user_id1",
  "link_expiry": "2024-02-02T00:00:00.000Z",
  "aadhaar_details": {
    "last_verified_at": "2025-05-06 15:04:05",
    "care_of": "S/O: Fakkirappa Dollin",
    "dob": "02-02-1995",
    "gender": "M",
    "name": "Mallesh Fakkirappa Dollin",
    "address_details": {
      "country": "India",
      "dist": "Haveri",
      "house": "Shri Kanaka Nilaya",
      "pincode": 581115,
      "po": "Ranebennur",
      "state": "Karnataka",
      "street": "Umashankar Nagar 1st Main 5th Cross",
      "subdist": "Ranibennur",
      "vtc": "Ranibennur"
    },
    "photo_link": "<link where aadhaar image is hosted on merchants end>"
  },
  "security_questions": [
    {
      "order": 1,
      "question": "What is Your name ?",
      "answer": "John Doe"
    }
  ]
}
Template Behavior: Including Aadhaar details in this request skips the DigiLocker verification step, reducing the user journey from 3 steps to 2. See User Templates for details.

Authorizations

​
x-client-id
string
header
required

Your unique client identifier issued by Cashfree. You can find this in your Merchant Dashboard.

​
x-client-secret
string
header
required

The secret key associated with your client ID. Use this to authenticate your API requests. You can find this in your Merchant Dashboard.

Headers

​
x-cf-signature
string

Send the signature if two-factor authentication is selected as Public Key. More details

​
x-api-version
string
default:2024-12-01
required

API version to be used. Format is in YYYY-MM-DD.

Example:

"2024-12-01"

Body

application/json

Request parameters to generate Video KYC link.

​
verification_id
string
default:vkyc_verification_id
required

It is the unique ID you create to identify the verification request. The maximum character limit is 50. Only alphaumeric, period (.), hyphen (-), and underscore ( _ ) are allowed.

Example:

"vkyc_verification_id"

​
user_template
string
default:vkyc_user_template_v1

It is the name of users vkyc template more details.

Example:

"vkyc_user_template_v1"

​
agent_template
string
default:vkyc_agent_template_v1

It is the name of agents vkyc template more details.

Example:

"vkyc_agent_template_v1"

​
user_reference_id
integer
default:1358

It is the unique ID created by Cashfree Payments that you receive in the response of Create User for Secure ID API.

Example:

1358

​
user_id
string
default:User0123

It is the unique ID you create to identify the user in Create User for Secure ID API.

Example:

"User0123"

​
notification_types
string[]

List of notification types that should be triggered for this request.

Example:
["sms", "whatsapp"]
​
aadhaar_details
object
​
security_questions
object[]

Response

Success response for generating a Video KYC link.

​
verification_id
string

It displays the unique ID you created to identify the verification request.

Example:

"test053"

​
reference_id
integer

It displays the unique ID created by Cashfree Payments for reference purposes. format: int64

Example:

10042

​
status
string

It displays the status of the API request. Refer to this link for all possible values and their meanings.

Example:

"PRE_VIDEO_CALL"

​
sub_status
string

It displays the sub status of the API request. Refer to this link for all possible values and their meanings.

Example:

"AADHAAR_VERIFICATION_SUCCESS"

​
vkyc_link
string

It displays the URL of the vKYC form to be filled by the user.

Example:

"https://forms.cashfree.com/verification/M8go0i1k9fvg"

​
link_expiry
string<date>

The date on which the vKYC link will expire.

Example:

"2025-05-30T00:00:00.000Z"

​
user_reference_id
string

The reference ID of the user for whom the VKYC link is generated.

Example:

123456

​
user_id
string

The user ID of the user for whom the VKYC link is generated.

Example:

"User0123"

​
aadhaar_details
object

Aadhaar information associated with the user.

​
security_questions
object[]

List of security questions and answers.