Skip to main content
POST
/
api
/
v4
/
sub-account
/
kyc-url
Get Sub-Account KYC URL
curl --request POST \
  --url https://whitebit.com/api/v4/sub-account/kyc-url \
  --header 'Content-Type: application/json' \
  --header 'X-TXC-APIKEY: <api-key>' \
  --header 'X-TXC-PAYLOAD: <api-key>' \
  --header 'X-TXC-SIGNATURE: <api-key>' \
  --data '
{
  "id": "8e667b4a-0b71-4988-8af5-9474dbfaeb51"
}
'
{ "url": "https://kyc-provider.example.com/verify/abc123", "expiresIn": 3600 }
A KYC URL can only be generated when all of the following conditions are met:
  • The sub-account is activated (has an associated user).
  • The sub-account is active (not locked or blocked).
  • The sub-account does not have shared KYC enabled. When shared KYC is enabled, the sub-account inherits identity verification from the main account, and a separate KYC link is not applicable.

Authorizations

​
X-TXC-APIKEY
string
header
required

The public WhiteBIT API key.

​
X-TXC-PAYLOAD
string
header
required

Base64-encoded JSON request body.

​
X-TXC-SIGNATURE
string
header
required

HMAC-SHA512 signature of the payload, hex-encoded. Computed as hex(HMAC-SHA512(payload, api_secret)).

Body

application/json
​
id
string
required

Sub-account external ID. Must belong to the authenticated main account.

Example:

"8e667b4a-0b71-4988-8af5-9474dbfaeb51"

Response

KYC URL generated successfully

​
url
string
required

Temporary KYC verification URL

Example:

"https://kyc-provider.example.com/verify/abc123"

​
expiresIn
integer
required

Time in seconds until the link expires

Example:

3600