Skip to main content
POST
/
ppi
/
kyc
/
vkyc
Initiate Video KYC
curl --request POST \
  --url https://api.cashfree.com/ppi/kyc/vkyc \
  --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",
  "notification_modes": [
    "SMS",
    "WHATSAPP"
  ],
  "security_questions": [
    {
      "order": 1,
      "question": "What is the name of your father?",
      "answer": "John Snow"
    },
    {
      "order": 2,
      "question": "What is your salary?",
      "answer": "1000000"
    }
  ]
}
'
{
  "verification_id": "TestVkycVerification",
  "cf_verification_id": "8901234567890123458",
  "user_id": "USER827364",
  "status": "INITIATED",
  "sub_status": "LINK_GENERATED",
  "vkyc_link": "https://vkyc.cashfree.com/session/abc123",
  "link_expiry": "2026-06-03",
  "notification_modes": [
    "SMS",
    "WHATSAPP"
  ],
  "security_questions": [
    {
      "order": 1,
      "question": "What is the name of your father?",
      "answer": "John Snow"
    },
    {
      "order": 2,
      "question": "What is your salary?",
      "answer": "1000000"
    }
  ],
  "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 initiate Video KYC verification for a user and generate a VKYC link.

​
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 that you create to identify the VKYC verification request in your system. Maximum 50 characters. Only alphanumeric characters, periods (.), hyphens (-), and underscores (_) are allowed.

Required string length: 1 - 50
Example:

"TestVkycVerification"

​
notification_modes
enum<string>[]
required

Notification channels on which VKYC link is sent.

Minimum array length: 1
Available options:
SMS,
WHATSAPP
Example:
["SMS", "WHATSAPP"]
​
security_questions
object[]
required

Security questions and answers for VKYC verification. Each entry must include order, question, and answer. The order value must be unique across all entries and sequential starting from 1 (1, 2, 3, and so on).

Minimum array length: 1

Response

Success response for initiating Video KYC verification.

​
verification_id
string

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

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-03"

​
notification_modes
enum<string>[]

Notification channels used for sharing VKYC link, passed in the request.

Available options:
SMS,
WHATSAPP
​
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"

​
security_questions
object[]

Security questions and answers as passed in VKYC verification request.