POST
/
form
curl --request POST \
  --url https://sandbox.cashfree.com/verification/form \
  --header 'Content-Type: application/json' \
  --header 'x-client-id: <api-key>' \
  --header 'x-client-secret: <api-key>' \
  --data '{
  "name": "John Doe",
  "phone": "9999999999",
  "email": "test@cashfree.com",
  "template_name": "Aadhaar_verification",
  "link_expiry": "2025-06-01",
  "notification_types": [
    "sms"
  ],
  "verification_id": "ABC00123"
}'
{
  "name": "John Doe",
  "phone": "9999999999",
  "email": "test@cashfree.com",
  "verification_id": "ABC00123",
  "reference_id": 235461,
  "form_link": "https://forms-test.cashfree.com/verification/Y7tpcan5ksm0",
  "form_status": "RECEIVED"
}

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
Find the request parameters for Generate KYC Link.

Request Body Schema for Generate KYC Link

​
phone
string
required

It is the phone number of the individual.

Example:

"9999999999"

​
template_name
string
required

It is the name of the template you created using the merchant dashboard. You can also use the default template found there to generate the verification form. The default template is Aadhaar_verification. Using merchant dashboard, customized KYC Link templates can be created.

Example:

"Aadhaar_verification"

​
verification_id
string
required

It is the unique ID you created to identify the KYC link.

Example:

"ABC00123"

​
name
string

It is the name of the individual.

Example:

"John Doe"

​
email
string

It is the email address of the individual.

Example:

"test@cashfree.com"

​
link_expiry
string

It is the expiry date of the link. Its value can be max 30 days from the current date.

Example:

"2025-06-01"

​
notification_types
string[]

It is the type(s) of notification used for sending the link.

SMS string

Response

200
application/json
Response Body for Generate KYC Link API

Find the success response of Generate KYC Link

​
name
string

It displays the name of the individual.

Example:

"John Doe"

​
phone
string

It displays the phone number of the individual.

Example:

"9999999999"

​
email
string

It displays the email address of the individual.

Example:

"test@cashfree.com"

​
verification_id
string

It displays the unique ID you created to identity the form.

Example:

"ABC00123"

​
reference_id
integer

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

Example:

235461

​
form_link
string

It displays the URL of the KYC Link.

Example:

"https://forms-test.cashfree.com/verification/Y7tpcan5ksm0"

​
form_status
string

It displays the status of the form.

Example:

"RECEIVED"

Was this page helpful?