Skip to main content
POST
/
partner
/
kyc-sessions
Create KYC session
curl --request POST \
  --url https://api.contro.me/v1/partner/kyc-sessions \
  --header 'Content-Type: application/json' \
  --header 'x-contro-api-key: <api-key>' \
  --data '
{
  "externalUserId": "user_42"
}
'
{
  "id": "ks_abc123",
  "status": "creating",
  "externalUserId": "<string>",
  "url": "<string>",
  "expiresAt": "<string>",
  "createdAt": "<string>"
}

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

Sumsub WebSDK URL for the user to complete KYC

​
expiresAt
string
required

ISO 8601 session expiry timestamp

​
createdAt
string
required

ISO 8601 creation timestamp