Skip to main content
POST
Create a custody account group

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
idempotencyKey
string<uuid>
required

Universally unique identifier (UUID v4) idempotency key. This key is utilized to ensure exactly-once execution of mutating requests.

Example:

"ba943ff1-ca16-49b2-ba55-1057e70ca5c7"

name
string
required

Display name.

Maximum string length: 32
Example:

"Team A"

accountIds
integer[]

Optional list of accounts to assign to the new group at creation time. Each account must belong to the caller's entity. Accounts already assigned to another group are reassigned. Max 100 entries.

Maximum array length: 100
Example:

Response

Successfully created the custody account group.

data
object

A customer-defined grouping of custody accounts owned by a single entity. Each account can belong to at most one group at a time. The approximateBalanceInUsd and accountsPreview fields are aggregate views populated by the list-groups endpoint. The single-group detail endpoint returns the metadata-only view and omits both fields.