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"
    }
  ]
}

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.

The body is of type object.

Response

200
application/json

Success response for generating a Video KYC link.

The response is of type object.