Skip to main content
POST

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.

​
verification_id
string
default:vkyc_verification_id
required

It is the unique ID you create to identify the verification request. The maximum character limit is 50. Only alphaumeric, period (.), hyphen (-), and underscore ( _ ) are allowed.

Example:

"vkyc_verification_id"

​
user_template
string
default:vkyc_standard_template

It is the name of users vkyc template.

Example:

"vkyc_standard_template"

​
agent_template
string
default:vkyc_agent_template

It is the name of agents vkyc template.

Example:

"vkyc_agent_template"

​
user_reference_id
integer
default:1358

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

Example:

1358

​
user_id
string
default:User0123

It is the unique ID you create to identify the user.

Example:

"User0123"

​
notification_types
string[]

Types of notifications.

Example:
​
aadhaar_details
object
​
security_questions
object

Response

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

​
verification_id
string

It displays the unique ID you created to identify the verification request.

Example:

"test053"

​
reference_id
integer

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

Example:

10042

​
status
string

It displays the status of the API request.

Example:

"RECEIVED"

​
sub_status
string

It displays the sub status of the API request.

Example:

"LINK_GENERATED"

​
vkyc_link
string

It displays the URL of the vKYC form to be filled by the user.

Example:

"https://forms.cashfree.com/verification/M8go0i1k9fvg"

​
link_expiry
string<date>

The date on which the vKYC link will expire.

Example:

"2025-05-30T00:00:00.000Z"

​
aadhaar_details
object

Aadhaar information associated with the user.

​
security_questions
object[]

List of security questions and answers.