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_v2",
"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"
}
],
"auditor_remarks": null,
"agent_remarks": "Pan not available during video call"
}Initiate Video KYC Request
Use this API to generate a Video KYC verification link for a user and send it through the configured notification channels (SMS, email, or WhatsApp). The message content can be configured using user and agent templates.
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_v2",
"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"
}
],
"auditor_remarks": null,
"agent_remarks": "Pan not available during video call"
}Authorizations
Your unique client identifier issued by Cashfree. You can find this in your Merchant Dashboard.
The secret key associated with your client ID. Use this to authenticate your API requests. You can find this in your Merchant Dashboard.
Headers
Send the signature if two-factor authentication is selected as Public Key. More details.
API version to be used. Format is in YYYY-MM-DD.
"2024-12-01"
Body
Request parameters to generate Video KYC link.
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.
"vkyc_verification_id"
It is the name of users vkyc template more details.
"vkyc_user_template_v1"
It is the name of agents vkyc template more details.
"vkyc_agent_template_v2"
It is the unique ID created by Cashfree Payments that you receive in the response of Create User for Secure ID API.
1358
It is the unique ID you create to identify the user in Create User for Secure ID API.
"User0123"
List of notification types that should be triggered for this request.
["sms", "whatsapp"]
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Response
Success response for generating a Video KYC link.
It displays the unique ID you created to identify the verification request.
"test053"
It displays the unique ID created by Cashfree Payments for reference purposes. format: int64
10042
It displays the URL of the vKYC form to be filled by the user.
"https://forms.cashfree.com/verification/M8go0i1k9fvg"
The date on which the vKYC link will expire.
"2025-05-30T00:00:00.000Z"
The reference ID of the user for whom the VKYC link is generated.
123456
The user ID of the user for whom the VKYC link is generated.
"User0123"
Aadhaar information associated with the user.
Show child attributes
Show child attributes
List of security questions and answers.
Show child attributes
Show child attributes
Remarks provided by the auditor during the Video KYC process.
"Verification completed successfully"
Remarks provided by the agent during the Video KYC process.
"Pan not available during video call"
Was this page helpful?