Skip to main content
POST
Initiate KYC

Authorizations

x-contro-api-key
string
header
required

Partner API key (sk_live_* for production, sk_test_* for sandbox)

Path Parameters

id
string
required

Cardholder ID

Example:

"ch_abc123"

Body

application/json
cardProgramId
string
required

Card program ID to initiate KYC for

Minimum string length: 1
Example:

"cp_xyz789"

Response

KYC initiated

status
string
required

KYC initiation status

Example:

"pending"

cardholderId
string
required

Cardholder ID

Example:

"ch_abc123"

cardProgramId
string
required

Card program ID

Example:

"cp_xyz789"