increase-test
POST/entity_beneficial_owners

Create a beneficial owner

Creates a beneficial owner for a corporation entity. Supply the entity identifier, the individual's personal details, and at least one reason the person qualifies as a beneficial owner: ownership, control, or both.

  • IdempotentThe SDK sends Idempotency-Key, so a retried request is only applied once.

4 body fields

Beneficial owner details. entity_id, prongs, and individual are required.

company_titlestringoptional
This person's role or title within the entity.
entity_idstringrequired
The identifier of the Entity to associate with the new Beneficial Owner. Only `corporation` entities have beneficial owners.
individualobjectrequired
Personal details for the beneficial owner.
prongsarray<string>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.

3 status codes
200Returns the created beneficial owner, including its identifier, associated entity, personal details, and qualifying reasons.
company_titlestringrequired
This person's role or title within the entity.
created_atstringrequired
The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the Beneficial Owner was created.
entity_idstringrequired
The identifier of the Entity to which this beneficial owner belongs.
idstringrequired
The identifier of this beneficial owner.
idempotency_keystringrequired
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](https://increase.com/documentation/idempotency-keys).
individualobjectrequired
Personal details for the beneficial owner.
prongsarray<string>required
Why this person is considered a beneficial owner of the entity.
typestringrequired
A constant representing the object's type. For this resource it will always be `entity_beneficial_owner`.
Allowed:entity_beneficial_owner
4XXReturned when the request encounters a client-side error.
5XXReturned when the server encounters an error.

Error handling

entity_id, prongs, and individual are required. The entity must be a corporation, prongs must include ownership or control, and individual must include a name, date of birth, address, and identification with a method and number.