Create Sub-Account

Create a new sub-account under a main WhiteBIT account via the V4 API.

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>' \
  --header 'X-TXC-PAYLOAD: <api-key>' \
  --header 'X-TXC-SIGNATURE: <api-key>' \
  --data '
{
  "alias": "trading_bot",
  "permissions": {
    "spotEnabled": true,
    "collateralEnabled": false
  },
  "email": "[e-mail]",
  "shareKyc": false
}
'

import requests

url = "https://whitebit.com/api/v4/sub-account/create"

payload = {
    "alias": "trading_bot",
    "permissions": {
        "spotEnabled": True,
        "collateralEnabled": False
    },
    "email": "[e-mail]",
    "shareKyc": False
}
headers = {
    "X-TXC-APIKEY": "<api-key>",
    "X-TXC-PAYLOAD": "<api-key>",
    "X-TXC-SIGNATURE": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'X-TXC-APIKEY': '<api-key>',
    'X-TXC-PAYLOAD': '<api-key>',
    'X-TXC-SIGNATURE': '<api-key>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    alias: 'trading_bot',
    permissions: {spotEnabled: true, collateralEnabled: false},
    email: '[e-mail]',
    shareKyc: false
  })
};

fetch('https://whitebit.com/api/v4/sub-account/create', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://whitebit.com/api/v4/sub-account/create",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'alias' => 'trading_bot',
    'permissions' => [
        'spotEnabled' => true,
        'collateralEnabled' => false
    ],
    'email' => '[e-mail]',
    'shareKyc' => false
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-TXC-APIKEY: <api-key>",
    "X-TXC-PAYLOAD: <api-key>",
    "X-TXC-SIGNATURE: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://whitebit.com/api/v4/sub-account/create"

	payload := strings.NewReader("{\n  \"alias\": \"trading_bot\",\n  \"permissions\": {\n    \"spotEnabled\": true,\n    \"collateralEnabled\": false\n  },\n  \"email\": \"[e-mail]\",\n  \"shareKyc\": false\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-TXC-APIKEY", "<api-key>")
	req.Header.Add("X-TXC-PAYLOAD", "<api-key>")
	req.Header.Add("X-TXC-SIGNATURE", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://whitebit.com/api/v4/sub-account/create")
  .header("X-TXC-APIKEY", "<api-key>")
  .header("X-TXC-PAYLOAD", "<api-key>")
  .header("X-TXC-SIGNATURE", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"alias\": \"trading_bot\",\n  \"permissions\": {\n    \"spotEnabled\": true,\n    \"collateralEnabled\": false\n  },\n  \"email\": \"[e-mail]\",\n  \"shareKyc\": false\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://whitebit.com/api/v4/sub-account/create")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-TXC-APIKEY"] = '<api-key>'
request["X-TXC-PAYLOAD"] = '<api-key>'
request["X-TXC-SIGNATURE"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"alias\": \"trading_bot\",\n  \"permissions\": {\n    \"spotEnabled\": true,\n    \"collateralEnabled\": false\n  },\n  \"email\": \"[e-mail]\",\n  \"shareKyc\": false\n}"

response = http.request(request)
puts response.read_body

201

Example

{ "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

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

alias · string · required

Name for sub-account

Example:

"trading_bot"

permissions · object · required

Show child attributes

email · string

Sub-account email (required when shareKyc is false)

Example:

"[e-mail]"

shareKyc · boolean

If KYC shared with main account

Example:

false

Response

201

application/json

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

Show child attributes

permissions · object

Sub-account permissions

Show child attributes