Create sub-account

Create a new subaccount to organize your account’s instruments or to delegate transaction authority to an authorized third party. All accounts have a "Default" subaccount.

SecurityJWT
Request
path Parameters
ledgerIdentifier
required
string <uuid>

Ledger identifier, can be found using /api/ledger endpoint

Example: 4b7375e9-79b0-4b8b-a89e-a21607f0239f
Request Body schema: application/json
required

Subaccount payload

object (Account)

Account record

name
required
string

Sub-account name

description
string

Sub-account description

_default
boolean
object (ReferenceDatum)

A reference datum data object

object (ExternalPlatform)

If this is a managed sub-account, information on the external platform managing this sub-account.

managingExternalPlatformAccountId
string

If this is a managed sub-account, the relevant account ID in the external platform for the account associated with this sub-account.

managingExternalPlatformSubaccountMetadata
string

Optional JSON payload of managing external platform subaccount metadata.

Responses
200

OK

post/api/ledger/{ledgerIdentifier}/subaccount
Request samples
application/json
{
  • "account": {
    },
  • "name": "Allocated",
  • "description": "Holdings to retired & retired",
  • "_default": true,
  • "status": "GOC",
  • "managingExternalPlatform": {
    },
  • "managingExternalPlatformAccountId": "string",
  • "managingExternalPlatformSubaccountMetadata": "string"
}