API Reference — Increase

Beneficial owners are the individuals who control or own 25% or more of a corporation entity. Beneficial owners are always people, and never organizations. Generally, you will need to submit between 1 and 5 beneficial owners for every corporation entity. You should update and archive beneficial owners for a corporation entity as their details change.

The Beneficial Owner object

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

Attributes

company_title

string

Nullable

This person’s role or title within the entity.

created_at

string

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

entity_id

string

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

More about Entities.

string

The identifier of this beneficial owner.

idempotency_key

string

Nullable

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.

individual

dictionary

Personal details for the beneficial owner.

prongs

array of strings

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

type

string

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

List Beneficial Owners

curl \
  --url "${INCREASE_URL}/entity_beneficial_owners?entity_id=entity_n8y8tnk2p9339ti393yi" \
  -H "Authorization: Bearer ${INCREASE_API_KEY}"

Returns a list response:

{
  "data": [
    { /* Beneficial Owner object */ },
    { /* Beneficial Owner object */ }
    / * ... */
  ],
  "next_cursor": "v57w5d",
}

Parameters

cursor

string

Return the page of entries after this one.

limit

integer

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

entity_id

string

Required

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

More about Entities.

idempotency_key

string

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.

Between 1 and 200 characters

Create a beneficial owner

curl -X "POST" \
  --url "${INCREASE_URL}/entity_beneficial_owners" \
  -H "Authorization: Bearer ${INCREASE_API_KEY}" \
  -H "Content-Type: application/json" \
  -d $'{
    "company_title": "CEO",
    "entity_id": "entity_n8y8tnk2p9339ti393yi",
    "individual": {
      "address": {
        "city": "New York",
        "country": "US",
        "line1": "33 Liberty Street",
        "state": "NY",
        "zip": "10045"
      },
      "date_of_birth": "1970-01-31",
      "identification": {
        "method": "social_security_number",
        "number": "078051120"
      },
      "name": "Ian Crease"
    },
    "prongs": [
      "control"
    ]
  }'

Parameters

company_title

string

This person’s role or title within the entity.

Between 1 and 200 characters

entity_id

string

Required

The identifier of the Entity to associate with the new Beneficial Owner.

More about Entities.

individual

dictionary

Required

Personal details for the beneficial owner.

prongs

array of strings

Required

Why this person is considered a beneficial owner of the entity. At least one option is required, if a person is both a control person and owner, submit an array containing both.

Retrieve a Beneficial Owner

curl \
  --url "${INCREASE_URL}/entity_beneficial_owners/entity_beneficial_owner_vozma8szzu1sxezp5zq6" \
  -H "Authorization: Bearer ${INCREASE_API_KEY}"

Parameters

entity_beneficial_owner_id

string

Required

The identifier of the Beneficial Owner to retrieve.

More about Beneficial Owners.

Update a Beneficial Owner

curl -X "PATCH" \
  --url "${INCREASE_URL}/entity_beneficial_owners/entity_beneficial_owner_vozma8szzu1sxezp5zq6" \
  -H "Authorization: Bearer ${INCREASE_API_KEY}" \
  -H "Content-Type: application/json" \
  -d $'{
    "address": {
      "city": "New York",
      "country": "US",
      "line1": "33 Liberty Street",
      "line2": "Unit 2",
      "state": "NY",
      "zip": "10045"
    }
  }'

Parameters

entity_beneficial_owner_id

string

Required

The identifier of the Beneficial Owner to update.

More about Beneficial Owners.

address

dictionary

The individual’s physical address. Mail receiving locations like PO Boxes and PMB’s are disallowed.

confirmed_no_us_tax_id

boolean

The identification method for an individual can only be a passport, driver’s license, or other document if you’ve confirmed the individual does not have a US tax id (either a Social Security Number or Individual Taxpayer Identification Number).

identification

dictionary

A means of verifying the person’s identity.

name

string

The individual’s legal name.

Between 1 and 200 characters

Archive a Beneficial Owner

curl -X "POST" \
  --url "${INCREASE_URL}/entity_beneficial_owners/entity_beneficial_owner_vozma8szzu1sxezp5zq6/archive" \
  -H "Authorization: Bearer ${INCREASE_API_KEY}"

Parameters

entity_beneficial_owner_id

string

Required

The identifier of the Beneficial Owner to archive.

More about Beneficial Owners.