Sign in
Beneficial Owners

List beneficial owners

Changed on

Returns a paginated list of beneficial owners scoped to the authenticated tenant.

Supports Flop pagination and filtering:

  • page - Page number (1-indexed, default: 1)
  • page_size - Items per page (default: 20, max: 100)
  • order_by - Field to sort by
  • order_directions - Sort direction (asc or desc)
  • filters - Flop filters (account_holder_id, control_type, verification_status)
get/api/beneficial-owners

Request

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

Query parameters

pageinteger

Page number (1-indexed)

page_sizeinteger

Items per page (max: 100)

order_bystring

Field to sort by

order_directionsstring

Sort direction (asc or desc)

Response

Beneficial owner list

Example response

{
  "data": [
    {
      "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"
    }
  ],
  "meta": {
    "page": 1,
    "page_size": 50,
    "total_count": 125,
    "total_pages": 3
  }
}

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