POST
/
form
{
  "name": "John Doe",
  "phone": 9999999999,
  "email": "test@cashfree.com",
  "verification_id": "testverificationid",
  "reference_id": 235461,
  "form_link": "https://forms.cashfree.com/",
  "form_status": "PENDING"
}

Headers

x-client-id
string
required

Client App ID

x-client-secret
string
required

Client App Secret

Body

application/json

Request Body Schema for VRS GenerateFormLink

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 templates are Cashfree_Onboarding, Aadhaar_verification, Cashfree_Bank_Account_Verification, Cashfree_User_Aadhaar, All_Verification.

verification_id
string
required

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

name
string

It is the name of the individual.

email
string

It is the email address of the individual.

It is the expiry date of the link.

notification_types
string[]

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

Response

200 - application/json

Find the success response of Generate Form Link

name
string

It displays the name of the individual.

phone
string

It displays the phone number of the individual.

email
string

It displays the email address of the individual.

verification_id
string

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

reference_id
integer

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

It displays the URL of the form.

form_status
string

It displays the status of the form.