List Beneficial Owners

Changed on
get/entity_beneficial_owners

Request

  • Base URL
    https://api.increase.com
  • URL
    https://api.increase.com/entity_beneficial_owners
  • Auth
    HTTP bearer

Query parameters

cursorstring

Return the page of entries after this one.

limitinteger

Limit the size of the list that is returned. The default (and maximum) is 100 objects.

entity_idstring required

The identifier of the Entity to list beneficial owners for. Only corporation entities have beneficial owners.

idempotency_keystring

Filter records to the one with the specified idempotency_key you chose for that object. This value is unique across Increase and is used to ensure that a request is only processed once. Learn more about idempotency.

Response

Beneficial Owner List

next_cursorstring nullable required

A pointer to a place in the list. Pass this as the cursor parameter to retrieve the next page of results. If there are no more results, the value will be null.

Example response

{
  "data": [
    {
      "company_title": "CEO",
      "created_at": "2020-01-31T23:59:59Z",
      "entity_id": "entity_n8y8tnk2p9339ti393yi",
      "id": "entity_beneficial_owner_vozma8szzu1sxezp5zq6",
      "idempotency_key": null,
      "individual": {
        "address": {
          "city": "New York",
          "country": "US",
          "line1": "33 Liberty Street",
          "line2": null,
          "state": "NY",
          "zip": "10045"
        },
        "date_of_birth": "1970-01-31",
        "identification": {
          "method": "social_security_number",
          "number_last4": "1120"
        },
        "name": "Ian Crease"
      },
      "prongs": [
        "control",
        "ownership"
      ],
      "type": "entity_beneficial_owner"
    }
  ],
  "next_cursor": "v57w5d"
}

Changes

  • 17aa1bcd9faeRevision changes
    • warning

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

  • df2b1ead4c49Revision changes
    • breaking

      for the query request parameter limit, default value 100 was added