Sign in
Account Holders

Create account holder

Changed on

Creates a new account holder linked to an existing legal entity.

The legal_entity_id must reference an existing LegalEntity in the same tenant.

post/api/account-holders

Request

  • Base URL: http://localhost:4100
  • URL: http://localhost:4100/api/account-holders
  • Auth: none required

Request body

account_holder_numberstring nullable
account_holder_type'individual' | 'business' | 'trust' | 'nonprofit' required
chain_screeningboolean

When true (default), enqueues a compliance screening job after creation. Set to false to skip.

enabled_currenciesstring[] nullable
enabled_regimesstring[] nullable
external_idstring nullable
kyc_status'not_started' | 'in_progress' | 'approved' | 'rejected' | 'expired' nullable
last_reviewed_atstring date-time nullable
onboarded_atstring date-time nullable
risk_level'low' | 'medium' | 'high' | 'very_high' | 'prohibited' nullable
status'pending' | 'active' | 'suspended' | 'closed' | 'flagged' nullable
tenant_idstring uuid

Example request

{
  "account_holder_number": "",
  "account_holder_type": "individual",
  "chain_screening": false,
  "enabled_currencies": [
    ""
  ],
  "enabled_regimes": [
    ""
  ],
  "external_id": "",
  "kyc_status": "not_started",
  "last_reviewed_at": "2020-04-20T16:20:00Z",
  "legal_entity": null,
  "onboarded_at": "2020-04-20T16:20:00Z",
  "risk_level": "low",
  "status": "pending",
  "tenant_id": "02ef9c5f-29e6-48fc-9ec3-7ed57ed351f6"
}

Changes

  • e99ccd17df53Revision changes
    • warning

      removed the request property /

    • warning

      removed the request property

    • info

      added the new optional request property

    • info

      added the new prohibited enum value to the request property

  • 1ee17680f63eRevision changes
    • breaking

      added the new required request property

    • warning

      removed the request property