Skip to content
API status
API reference

Bulk-create trading accounts

POST
/api/v1/management/servers/{serverId}/accounts/bulk
curl --request POST \
  --url https://api.koneth.com/api/v1/management/servers/6be9a699-2f28-402e-b64e-93ba6bdafe1b/accounts/bulk \
  --header 'Authorization: <Authorization>' \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: account-create-client-1042' \
  --header 'X-Request-Id: onboarding-client-1042' \
  --data '{ "accounts": [ { "accountName": "example", "password": "example", "initialBalance": 1, "leverage": 1, "requestId": "example" } ] }'

Queues between 1 and 100 account creation commands. Koneth appends each account’s array index to the supplied idempotency key. Requires accounts:create.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
serverId
required
string format: uuid

UUID of a trading server owned by your organization.

Example
6be9a699-2f28-402e-b64e-93ba6bdafe1b

Header Parameters

Section titled “Header Parameters”
Idempotency-Key
required
string
>= 1 characters <= 100 characters

Unique key for this logical mutation. Reuse it only when retrying the same operation. Maximum 100 characters.

Example
account-create-client-1042
X-Request-Id
string

Optional correlation ID used for API request billing and logs.

Example
onboarding-client-1042

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
accounts
required
Array<object>
>= 1 items <= 100 items
object
accountName
required
string
>= 1 characters <= 100 characters
password

Omit to generate a password.

string format: password
>= 8 characters <= 128 characters
initialBalance
required
number
<= 1000000000
leverage
required
integer
>= 1 <= 10000
requestId
required
string
>= 1 characters <= 100 characters
Examplegenerated
{
  "accounts": [
    {
      "accountName": "example",
      "password": "example",
      "initialBalance": 1,
      "leverage": 1,
      "requestId": "example"
    }
  ]
}

Responses

Section titled “Responses”

202

Section titled “202”

Account creation commands queued.

Media typeapplication/json
object
results
required
Array<object>
object
command
required
object
id
required
string format: uuid
operation
required
string
Allowed values: account.create account.update account.enable account.disable account.archive account.delete account.password_reset account.investor_password_reset account.history_export finance.deposit finance.withdraw
status
required
string
Allowed values: queued leased succeeded failed expired
managedAccountId
One of:
string format: uuid
attempts
required
integer
payload
object
key
additional properties
any
result
One of:
object
key
additional properties
any
errorCode
One of:
string
errorMessage
One of:
string
idempotencyKey
required
string
createdAt
required
string format: date-time
completedAt
One of:
string format: date-time
key
additional properties
any
credentials

Returned only for a newly queued account creation.

object
tradingPassword
required

One-time trading password returned with a newly queued account creation.

string
investorPassword
required

One-time investor password returned with a newly queued account creation.

string
duplicate
required
boolean
Example
{
  "results": [
    {
      "command": {
        "operation": "account.create",
        "status": "queued"
      }
    }
  ]
}

400

Section titled “400”

Invalid request.

Media typeapplication/json
object
error
required
string
issues

Validation issue details when the request fails schema validation.

Array<object>
object
key
additional properties
any
Examplegenerated
{
  "error": "example",
  "issues": [
    {}
  ]
}

401

Section titled “401”

Management API authentication is missing or invalid.

Media typeapplication/json
object
error
required
string
issues

Validation issue details when the request fails schema validation.

Array<object>
object
key
additional properties
any
Example
{
  "error": "Management API authentication required"
}

402

Section titled “402”

The organization cannot cover the active API request price.

Media typeapplication/json
object
error
required
string
issues

Validation issue details when the request fails schema validation.

Array<object>
object
key
additional properties
any
Example
{
  "error": "Insufficient API credits"
}

403

Section titled “403”

The key lacks the required scope or server access.

Media typeapplication/json
object
error
required
string
issues

Validation issue details when the request fails schema validation.

Array<object>
object
key
additional properties
any
Example
{
  "error": "Missing API scope: accounts:read"
}

404

Section titled “404”

The requested resource was not found.

Media typeapplication/json
object
error
required
string
issues

Validation issue details when the request fails schema validation.

Array<object>
object
key
additional properties
any
Examplegenerated
{
  "error": "example",
  "issues": [
    {}
  ]
}

409

Section titled “409”

The request conflicts with the current resource state.

Media typeapplication/json
object
error
required
string
issues

Validation issue details when the request fails schema validation.

Array<object>
object
key
additional properties
any
Examplegenerated
{
  "error": "example",
  "issues": [
    {}
  ]
}

500

Section titled “500”

Unexpected server error.

Media typeapplication/json
object
error
required
string
issues

Validation issue details when the request fails schema validation.

Array<object>
object
key
additional properties
any
Example
{
  "error": "Internal server error"
}