Retrieve a Beneficial Owner

Changed on
get/entity_beneficial_owners/{entity_beneficial_owner_id}

Request

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

Path parameters

entity_beneficial_owner_idstring required

The identifier of the Beneficial Owner to retrieve.

Response

Beneficial Owner

company_titlestring nullable required

This person's role or title within the entity.

created_atstring date-time required

The ISO 8601 time at which the Beneficial Owner was created.

entity_idstring required

The identifier of the Entity to which this beneficial owner belongs.

idstring required

The identifier of this beneficial owner.

idempotency_keystring nullable required

The idempotency key you chose for this object. This value is unique across Increase and is used to ensure that a request is only processed once. Learn more about idempotency.

prongsstring[] required

Why this person is considered a beneficial owner of the entity.

type'entity_beneficial_owner' required

A constant representing the object's type. For this resource it will always be entity_beneficial_owner.

Example response

{
  "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"
}

Changes

  • 17aa1bcd9faeRevision changes
    • warning

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

  • 64a92a8cc343Revision changes
    • info

      added subschema #8 subschema #10 to the /// response property anyOf list for the response status

    • info

      added subschema #8 subschema #10 to the /// response property anyOf list for the response status

    • info

      removed subschema #8 subschema #10 from the /// response property anyOf list for the response status

    • info

      removed subschema #8 subschema #10 from the /// response property anyOf list for the response status