POST
/
form
{
  "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.

Body

application/json

Request Body Schema for Generate KYC Link

phone
string
required

It is the phone number of the individual.

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.

verification_id
string
required

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

email
string

It is the email address of the individual.

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

name
string

It is the name of the individual.

notification_types
string[]

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

Response

200 - application/json

Find the success response of Generate KYC Link

email
string

It displays the email address of the individual.

It displays the URL of the KYC Link.

form_status
string

It displays the status of the form.

name
string

It displays the name of the individual.

phone
string

It displays the phone number of the individual.

reference_id
integer

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

verification_id
string

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