Skip to main content
POST
Create accounts

Authorizations

Api-Access-Key
string
header
required

An API key associated with a security role

Headers

Idempotency-Key
string
required

Client-supplied key that deduplicates retried requests. Reusing a key returns the original result instead of repeating the action.

Api-Signature
string
required

A hex-encoded Ed25519 signature of timestamp_epoch_seconds + uppercase(http_method) + request_path + request_body.

Pattern: ^[0-9A-Fa-f]{128,160}$
Api-Timestamp
integer<int64>
required

Current timestamp, represented as unix epoch seconds

Body

application/json

Accounts to create

Minimum array length: 1

Details of the FBO (for-benefit-of) account to create: a parent container that segregated accounts reference via parentId.

type
enum<string>
required

Set to FBO to create an FBO account.

Available options:
FBO
complianceProfileId
string<uuid>

Reference to the Compliance Profile holding this account's tax classification, customers, and signers. Optional; immutable once the account is created.

Example:

"3486b413-93d3-4447-afce-2b9c9dc34a32"

isDisclosed
boolean

Whether the underlying segregatedAccounts are disclosed. Each value of this flag must be contractually approved — operating disclosed vs undisclosed is a contractual matter. On create, required on a top-level account and must be absent on an account with a parentId: it is inherited from the top of the branch.

name
string

The name of the account.

Minimum string length: 1
externalId
string

The external unique identifier used to identify this account.

Minimum string length: 1
parentId
string

Optional. The account id of the parent account this account is under. The parent must be an FBO or an omnibus with SEGREGATED ledgering. A pure omnibus (SELF ledgering) is always top level. An account's children are either all accounts that hold accounts (FBO or omnibus) or all segregated accounts.

Response

Accepted

Per-item results for a batch account creation request.

data
(Batch Item Success Result · object | Batch Item Error Result · object)[]
required

Successful outcome for one item of a batch request.