Skip to main content
POST
/
api
/
v4
/
sub-account
/
create
Create Sub-Account
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": "trading_bot",
  "permissions": {
    "spotEnabled": true,
    "collateralEnabled": false
  },
  "email": "sub@example.com",
  "shareKyc": false
}
'
{
  "id": "8e667b4a-0b71-4988-8af5-9474dbfaeb51",
  "alias": "trading_bot",
  "userId": "u-12345",
  "email": "s***@example.com",
  "status": "active",
  "color": "#FF5733",
  "kyc": {
    "shareKyc": false,
    "kycStatus": "verified"
  },
  "permissions": {
    "spotEnabled": true,
    "collateralEnabled": false
  }
}
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

Example:

"trading_bot"

​
permissions
object
required
​
email
string

Sub-account email (required when shareKyc is false)

Example:

"sub@example.com"

​
shareKyc
boolean

If KYC shared with main account

Example:

false

Response

Sub-account created successfully

​
id
string

Sub-account identifier

Example:

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

​
alias
string

Sub-account alias/name

Example:

"trading_bot"

​
userId
string

User identifier associated with account

Example:

"u-12345"

​
email
string

Sub-account email (masked)

Example:

"s***@example.com"

​
status
string

Sub-account status

Example:

"active"

​
color
string

Sub-account color

Example:

"#FF5733"

​
kyc
object

KYC information

​
permissions
object

Sub-account permissions