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://cf-prod-cfvkyc-video-recording.s3.ap-south-1.amazonaws.com/watermarkedRecording/51826/11203/10771/watermarkedRecording.mp4?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIASWG7WQ7NV3ALAN6F%2F20250709%2Fap-south-1%2Fs3%2Faws4_request&X-Amz-Date=20250709T084809Z&X-Amz-Expires=3600&X-Amz-SignedHeaders=host&X-Amz-Signature=733957e5bf492c40d609614f4c2807268ccae44a35f690ac29681f4a1909daaaa",
  "meeting_schedule": "2025-07-09T14:50:00.000Z"
}

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

200
application/json

Success response of Get VKYC Link API.

The response is of type object.