Sign in
Beneficial Owners

Get beneficial owner by ID

Changed on

Returns a single beneficial owner.

get/api/beneficial-owners/{id}

Request

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

Path parameters

idstring uuid required

Beneficial owner ID

Response

Beneficial owner

account_holder_idstring uuid required
beneficial_owner_numberstring nullable
control_type'shareholder' | 'director' | 'officer' | 'trustee' required
external_idstring nullable
idstring uuid
inserted_atstring date-time
ownership_pctnumber nullable
tenant_idstring uuid
updated_atstring date-time
verification_status'pending' | 'verified' | 'failed' nullable

Example response

{
  "account_holder_id": "02ef9c5f-29e6-48fc-9ec3-7ed57ed351f6",
  "beneficial_owner_number": "",
  "control_type": "shareholder",
  "external_id": "",
  "id": "02ef9c5f-29e6-48fc-9ec3-7ed57ed351f6",
  "inserted_at": "2020-04-20T16:20:00Z",
  "legal_entity": null,
  "ownership_pct": 0,
  "tenant_id": "02ef9c5f-29e6-48fc-9ec3-7ed57ed351f6",
  "updated_at": "2020-04-20T16:20:00Z",
  "verification_status": "pending"
}

Changes

  • e99ccd17df53Revision changes
    • breaking

      removed the required property from 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