Skip to main content
GET
/
vkyc
Get status of Video KYC
curl --request GET \
  --url https://sandbox.cashfree.com/verification/vkyc \
  --header 'x-api-version: <x-api-version>' \
  --header 'x-client-id: <api-key>' \
  --header 'x-client-secret: <api-key>'
{
  "verification_id": "vkyc_verification_id",
  "reference_id": 1358,
  "user_reference_id": 11174,
  "user_id": "vkyc_user_id1",
  "status": "RECEIVED",
  "sub_status": "LINK_GENERATED",
  "vkyc_link": "https://forms.cashfree.com/verification/p8r6jehan8bg",
  "link_expiry": "2025-08-03T00:00:00.000Z",
  "recording_link": "https://storage.cashfree.com/vkyc/recordings/test333.mp4",
  "meeting_schedule": null,
  "auditor_remarks": null,
  "agent_remarks": "Pan not available during call"
}

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.

​
x-api-version
string
default:2024-12-01
required

API version to be used. Format is in YYYY-MM-DD.

Example:

"2024-12-01"

Query Parameters

​
verification_id
string

It is the unique ID generated by the merchant to identify the verification request in the Initiate Video KYC Request API.

​
reference_id
string

It is the unique ID created by Cashfree Payments that you receive in the response of Initiate Video KYC Request API.

Response

Success response of Get VKYC Link API.

​
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. format: int64

Example:

10042

​
status
string

It displays the status of the API request. Refer to this link for all possible values and their meanings.

Example:

"PRE_VIDEO_CALL"

​
sub_status
string

It displays the sub status of the API request. Refer to this link for all possible values and their meanings.

Example:

"AADHAAR_VERIFICATION_SUCCESS"

​
vkyc_link
string

It displays the URL of the vKYC form.

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"

​
user_reference_id
string

The reference ID of the user for whom the VKYC link is generated.

Example:

123456

​
user_id
string

The user ID of the user for whom the VKYC link is generated.

Example:

"User0123"

​
recording_link
string | null

A link to the VKYC session recording. Returns null until the video call is completed.

Example:

"https://storage.cashfree.com/vkyc/recordings/test333.mp4"

​
meeting_schedule
string | null

Scheduled UTC timestamp for the VKYC meeting. Returns null if no meeting is scheduled.

Example:

"2025-07-19T14:30:00Z"

​
auditor_remarks
string | null

Remarks provided by the auditor during the Video KYC process.

Example:

"Verification completed successfully"

​
agent_remarks
string | null

Remarks provided by the agent during the Video KYC process.

Example:

"Customer was cooperative"