Skip to main content
POST
Create KYC session

Authorizations

x-contro-api-key
string
header
required

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

Body

application/json
externalUserId
string

Your unique identifier for this user, for tracking

Example:

"user_42"

Response

KYC session created

id
string
required

KYC session ID

Example:

"ks_abc123"

status
enum<string>
required

Session status

Available options:
creating,
pending,
completed,
expired,
failed
externalUserId
string | null
required

Partner's user identifier

url
string | null
required

Web URL for the user to complete KYC (provider-hosted)

expiresAt
string
required

ISO 8601 session expiry timestamp

createdAt
string
required

ISO 8601 creation timestamp