v1

latestOpenAPI 3.1.02026-07-263644911022.4 KB

Holders API

Open a holder-owned account (with optional instrument)

post/v1/organizations/{organization_id}/ledgers/{ledger_id}/holders/{holder_id}/accounts

Path parameters

organization_idstring uuid required

The unique identifier of the Organization associated with the Ledger.

ledger_idstring uuid required

The unique identifier of the associated Ledger.

holder_idstring required

Holder ID (UUID)

Headers

Content-Typestring

The type of media of the resource. Recommended value is application/json.

X-Request-Idstring uuid

A unique identifier used to trace and track each request.

Authorizationstring

Bearer JWT token for authentication. Required when PLUGIN_AUTH_ENABLED=true (enforced in multi-tenant deployments). Optional in default OSS single-tenant mode. Format: Bearer <token>

Response

Example response

{
  "account": {
    "alias": "@treasury_checking",
    "assetCode": "USD",
    "createdAt": "2021-01-01T00:00:00Z",
    "deletedAt": "2021-01-01T00:00:00Z",
    "entityId": "EXT-ACC-12345",
    "holderId": "00000000-0000-0000-0000-000000000000",
    "id": "00000000-0000-0000-0000-000000000000",
    "ledgerId": "00000000-0000-0000-0000-000000000000",
    "name": "Corporate Checking Account",
    "organizationId": "00000000-0000-0000-0000-000000000000",
    "parentAccountId": "00000000-0000-0000-0000-000000000000",
    "portfolioId": "00000000-0000-0000-0000-000000000000",
    "segmentId": "00000000-0000-0000-0000-000000000000",
    "status": {
      "code": "ACTIVE",
      "description": "Active status"
    },
    "type": "deposit",
    "updatedAt": "2021-01-01T00:00:00Z"
  },
  "instrument": {
    "accountId": "00000000-0000-0000-0000-000000000000",
    "bankingDetails": {
      "account": "123450",
      "bankId": "12345",
      "branch": "0001",
      "closingDate": "2025-12-31",
      "countryCode": "US",
      "iban": "US12345678901234567890",
      "openingDate": "2025-01-01",
      "type": "CACC"
    },
    "createdAt": "2025-01-01T00:00:00Z",
    "deletedAt": "2025-01-01T00:00:00Z",
    "document": "91315026015",
    "holderId": "00000000-0000-0000-0000-000000000000",
    "id": "00000000-0000-0000-0000-000000000000",
    "ledgerId": "00000000-0000-0000-0000-000000000000",
    "regulatoryFields": {
      "participantDocument": "12345678912345"
    },
    "relatedParties": [
      {
        "document": "12345678900",
        "endDate": "2026-01-01",
        "id": "00000000-0000-0000-0000-000000000000",
        "name": "John Smith",
        "role": "PRIMARY_HOLDER",
        "startDate": "2025-01-01"
      }
    ],
    "type": "NATURAL_PERSON",
    "updatedAt": "2025-01-01T00:00:00Z"
  },
  "instrumentError": {
    "reason": "0001",
    "status": "FAILED"
  }
}