Sign in
Account Holders

Get account holder by ID

Changed on

Returns a single account holder.

get/api/account-holders/{id}

Request

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

Path parameters

idstring uuid required

Account holder ID

Response

Account holder

account_holder_numberstring nullable
account_holder_type'individual' | 'business' | 'trust' | 'nonprofit' required
enabled_currenciesstring[] nullable
enabled_regimesstring[] nullable
external_idstring nullable
idstring uuid
inserted_atstring date-time
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
updated_atstring date-time

Example response

{
  "account_holder_number": "",
  "account_holder_type": "individual",
  "beneficial_owners": [
    null
  ],
  "enabled_currencies": [
    ""
  ],
  "enabled_regimes": [
    ""
  ],
  "external_id": "",
  "id": "02ef9c5f-29e6-48fc-9ec3-7ed57ed351f6",
  "inserted_at": "2020-04-20T16:20:00Z",
  "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",
  "updated_at": "2020-04-20T16:20:00Z"
}

Changes

  • e99ccd17df53Revision changes
    • warning

      removed the optional property from the response with the status

    • warning

      added the new account_holder_beneficial_owner enum value to the / response property for the response status

    • warning

      added the new counterparty enum value to the / response property for the response status

    • warning

      added the new counterparty_beneficial_owner enum value to the / response property for the response status

    • warning

      added the new prohibited enum value to the response property for the response status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      the response optional property / became read-only for the status

    • info

      removed the beneficial_owner enum value from the / response property for the response status

  • 1ee17680f63eRevision changes
    • breaking

      removed the required property from the response with the status

    • info

      added the required property to the response with the status