Get KYC Link Status

Use this API to get the status of the verification form. You need to input either the verification_id or reference_id to get the KYC Link status.

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

Query Parameters

verificationID · string · default: ABC00123

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

Example:

"ABC00123"

referenceID · string · default: 235461

It is the unique ID you receive in the response of Generate KYC Link API.

Example:

"235461"

Response

200

application/json

Response Body of VRS GetFormStatus API

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:

"[e-mail]"

verification_id · string

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

Example:

"testverificationid"

reference_id · integer

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

Example:

235461

link_expiry · string

It displays the expiry date of the link.

Example:

"2025-12-02"

form_link · string

It displays the URL of the form.

Example:

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

form_status · string

It displays the status of the form.

Example:

"PENDING"

verification_details · object[]

Option 1

Show child attributes