post
https://test-accounts.payu.in/api/v3/merchants/kyc_document/create_vkyc_profile
The Create VKYC Profile API creates a Video KYC profile and returns a VCIP capture link (Step 11 of 16).
Notes:
- Prerequisite: Step 10 (addresses). Signatory details (Step 08) must also be completed.
- Entity applicability: All entities — PayU may trigger VKYC based on risk profile; some merchants can skip.
- Share
capture_linkwith the merchant to complete video verification. Track status via GetMerchant (vkyc_status).
HTTP Method: POST
Environment
| URL | |
|---|---|
| Test Environment | https://test-partner.payu.in/api/v3/merchants/kyc_document/create_vkyc_profile |
| Production Environment | https://partner.payu.in/api/v3/merchants/kyc_document/create_vkyc_profile |
Sample Request
Sample request
curl --location 'https://test-partner.payu.in/api/v3/merchants/kyc_document/create_vkyc_profile' \
--header 'Authorization: Bearer {{access_token}}' \
--header 'Content-Type: application/json' \
--data '{
"merchant_id": "{{mid}}"
}'Sample Response
Success scenario
Success scenario
{
"uuid": "11ef-vkyc-profile-uuid",
"status": "link_generated",
"profile_id": "vendor-profile-id",
"capture_link": "https://vcip.example.com/session/...",
"scheduled_at": null
}Failure scenario
Failure scenario
- 422 — Signatory details not completed
{
"error": "Please complete (Signing authority details captured step) before initiating VKYC"
}Response parameters
Response parameters
| Parameter | Description | Example |
|---|---|---|
| uuid | string — VKYC profile UUID | 11ef-vkyc-profile-uuid |
| status | string — e.g. link_generated; later approved / declined | link_generated |
| profile_id | string — Vendor profile ID | vendor-profile-id |
| capture_link | string — VCIP video call URL to share with the merchant | https://vcip.example.com/session/... |
| scheduled_at | string/null — Scheduled time if applicable | null |
Request parameters
Header parameters
Header parameters
| Header | Description | Example |
|---|---|---|
Authorizationmandatory | string — Bearer token from Step 00 (GetToken) | Bearer {{access_token}} |
Content-Typemandatory | string — Must be application/json | application/json |
Body parameters
Body parameters
| Parameter | Description | Example |
|---|---|---|
merchant_idmandatory | string — Numeric merchant ID (mid) | 8390925 |
Bad Request
Unauthorized - Invalid or expired token
Forbidden - No access to this resource
Not Found
Validation Failed
Internal Server Error