Skip to main content
POST
/
ppi
/
kyc
/
vkyc
/
status
Get Video KYC Status
curl --request POST \
  --url https://api.cashfree.com/ppi/kyc/vkyc/status \
  --header 'Content-Type: application/json' \
  --header 'x-api-version: <x-api-version>' \
  --header 'x-client-id: <api-key>' \
  --header 'x-client-secret: <api-key>' \
  --data '
{
  "user_id": "USER827364",
  "verification_id": "TestVkycVerification"
}
'
{
  "verification_id": "TestVkycVerification",
  "cf_verification_id": "8901234567890123458",
  "user_id": "USER827364",
  "status": "RECEIVED",
  "sub_status": "LINK_GENERATED",
  "vkyc_link": "https://vkyc.cashfree.com/session/abc123",
  "link_expiry": "2026-06-27",
  "meeting_schedule": null,
  "auditor_remarks": null,
  "agent_remarks": null
}

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-api-version
string
default:2025-11-01
required

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

Example:

"2025-11-01"

Body

application/json

Request parameters to fetch the current status and details of a Video KYC verification request.

​
user_id
string
required

Unique identifier for the user, as provided by you during PPI user creation.

Required string length: 1 - 50
Example:

"USER827364"

​
verification_id
string
required

Unique identifier for the VKYC verification request, as provided by you during VKYC verification initiation.

Required string length: 1 - 50
Example:

"TestVkycVerification"

Response

Success response for fetching the Video KYC verification status.

​
verification_id
string

Unique identifier for the VKYC verification request, as provided by you during VKYC verification initiation.

Example:

"TestVkycVerification"

​
cf_verification_id
string

Unique identifier for the VKYC verification request, generated by Cashfree.

Example:

"8901234567890123458"

​
user_id
string

Unique identifier for the user, as provided by you during PPI user creation.

Example:

"USER827364"

​
status
string

Status of the VKYC verification process.

Example:

"RECEIVED"

​
sub_status
string

Sub status of the VKYC verification process.

Example:

"LINK_GENERATED"

​
vkyc_link
string

Generated VKYC session link for the user.

Example:

"https://vkyc.cashfree.com/session/abc123"

​
link_expiry
string

The date on which the VKYC link will expire.

Example:

"2026-06-27"

​
meeting_schedule
string | null

Scheduled meeting details when available.

Example:

"2026-06-04T10:15:30Z"

​
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:

"Pan not available during video call"