v1

latestOpenAPI 3.0.32026-07-2613529376.3 KB
Sub-Account

Create Sub-Account

The endpoint creates new sub-account.

<Note> 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** </Note> <Note> Crypto deposits are disabled by default. Once deposits are enabled for the account, the capability applies to the account and its sub-accounts; enablement is not available via API. To request it, contact your assigned Account Manager or email institutional@whitebit.com. Once enabled, a sub-account generates deposit addresses through the standard [deposit-address endpoint](/api-reference/account-wallet/get-cryptocurrency-deposit-address) using its own API key with deposit permission. </Note> <Warning> Rate limit: 1000 requests/10 sec. </Warning> <Note> The API does not cache the response. </Note>
post/api/v4/sub-account/create

Request body

aliasstring required

Name for sub-account

emailstring

Sub-account email (required when shareKyc is false)

shareKycboolean

If KYC shared with main account

Example request

{
  "alias": "trading_bot",
  "email": "sub@example.com",
  "permissions": {
    "spotEnabled": true
  }
}

Response

Sub-account created successfully

idstring

Sub-account identifier

aliasstring

Sub-account alias/name

userIdstring

User identifier associated with account

emailstring

Sub-account email (masked)

statusstring

Sub-account status

colorstring

Sub-account color

Example response

{
  "id": "8e667b4a-0b71-4988-8af5-9474dbfaeb51",
  "alias": "trading_bot",
  "userId": "u-12345",
  "email": "s***@example.com",
  "status": "active",
  "color": "#FF5733",
  "kyc": {
    "kycStatus": "verified"
  },
  "permissions": {
    "spotEnabled": true
  }
}