POST
/
vkyc
curl --request POST \
--url https://sandbox.cashfree.com/verification/vkyc \
--header 'Content-Type: application/json' \
--header 'x-client-id: <api-key>' \
--header 'x-client-secret: <api-key>' \
--data '{
"verification_id": "vkyc_verification_id",
"user_template": "vkyc_user_template",
"agent_template": "vkyc_agent_template",
"user_reference_id": 1234,
"notification_types": [
"sms",
"email",
"whatsapp"
]
}'
{
"verification_id": "vkyc_verification_id",
"reference_id": 1358,
"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>"
}
}

Authorizations

x-client-id
string
header
required

Client ID. You can find your ID in the Merchant Dashboard.

x-client-secret
string
header
required

Client secret key. You can find your secret key in the Merchant Dashboard.

Headers

x-cf-signature
string

Send the signature if IP is not whitelisted.

Body

application/json

Request parameters to generate Video KYC link.

The body is of type object.

Response

200
application/json

Success response for retrieving the list of information associated with the mobile number.

The response is of type object.