Create Sub-Account

This endpoint creates new sub-account.

Rate limit: 1000 requests/10 sec.

POST /api/v4/sub-account/create

Create Sub-Account

cURL

curl --request POST \
  --url https://whitebit.com/api/v4/sub-account/create \
  --header 'Content-Type: application/json' \
  --header 'X-TXC-APIKEY: <api-key>' \
  --data '
{
  "alias": "<string>",
  "permissions": {
    "spotEnabled": true,
    "collateralEnabled": true
  },
  "email": "<string>",
  "shareKyc": true
}
'

201

{
  "id": "<string>",
  "alias": "<string>",
  "userId": "<string>",
  "email": "<string>",
  "status": "<string>",
  "color": "<string>",
  "kyc": {
    "shareKyc": true,
    "kycStatus": "<string>"
  },
  "permissions": {
    "spotEnabled": true,
    "collateralEnabled": true
  }
}

The email field requirement depends on the shareKyc parameter:

• When shareKyc is false or not provided: email is required
• When shareKyc is true: email is optional

Authorizations

X-TXC-APIKEY · string · header · required

API key authentication using signed requests

Body

application/json

alias · string · required

Name for sub-account

permissions · object · required

Show child attributes

email · string

Sub-account email (required when shareKyc is false)

shareKyc · boolean

If KYC shared with main account

Response

201

application/json

Sub-account created successfully

id · string

alias · string

userId · string

email · string

status · string

color · string

kyc · object

Show child attributes

permissions · object

Show child attributes