Skip to main content
POST
/
partner
/
cardholders
/
{id}
/
kyc
Initiate KYC
curl --request POST \
  --url https://api.contro.me/v1/partner/cardholders/{id}/kyc \
  --header 'Content-Type: application/json' \
  --header 'x-contro-api-key: <api-key>' \
  --data '
{
  "cardProgramId": "cp_xyz789"
}
'
{
  "status": "pending",
  "cardholderId": "ch_abc123",
  "cardProgramId": "cp_xyz789"
}

Documentation Index

Fetch the complete documentation index at: https://partner-docs.contro.dev/llms.txt

Use this file to discover all available pages before exploring further.

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"