Skip to main content
GET
/
partner
/
cardholders
/
{id}
/
kyc
Get KYC status
curl --request GET \
  --url https://api.contro.me/v1/partner/cardholders/{id}/kyc \
  --header 'x-contro-api-key: <api-key>'
{
  "kycStatus": "approved",
  "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"

Query Parameters

​
cardProgramId
string
required

Card program ID to check KYC status for

Minimum string length: 1
Example:

"cp_xyz789"

Response

KYC status

​
kycStatus
string
required

KYC verification status. One of: pending, approved, rejected

Example:

"approved"

​
cardProgramId
string
required

Card program ID

Example:

"cp_xyz789"