increase-test
POST/entity_beneficial_owners/{entity_beneficial_owner_id}/archive

Archive a beneficial owner

Archives a beneficial owner associated with an entity. Use entity_beneficial_owner_id to identify the beneficial owner to archive.

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

1 parameter
entity_beneficial_owner_idstringrequired
The identifier of the beneficial owner to archive.

3 status codes
200Returns the beneficial owner object, including its entity, individual details, ownership or control prongs, and creation time.
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 has a client-side error.
5XXReturned when the request encounters a server-side error.

Error handling

The entity_beneficial_owner_id path parameter must identify an existing beneficial owner.