increase-test
PATCH/entity_beneficial_owners/{entity_beneficial_owner_id}

Update a beneficial owner

Updates personal details and qualifying reasons for an existing beneficial owner. Supply only the fields to change; providing prongs replaces the beneficial owner's current qualifying reasons.

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

1 parameter · 6 body fields
entity_beneficial_owner_idstringrequired
The identifier of the beneficial owner to update.

Beneficial owner fields to update. Supply only the fields to change; providing prongs replaces the current qualifying reasons.

addressobjectoptional
The individual's physical address. Mail receiving locations like PO Boxes and PMB's are disallowed.
confirmed_no_us_tax_idbooleanoptional
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).
date_of_birthstringoptional
The person's date of birth in YYYY-MM-DD format.
identificationobjectoptional
A means of verifying the person's identity.
namestringoptional
The individual's legal name.
prongsarray<string>optional
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. Providing this replaces the beneficial owner's current prongs.

3 status codes
200Returns the updated beneficial owner, including its 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

The entity_beneficial_owner_id path parameter must identify an existing beneficial owner. If supplied, prongs must include ownership, control, or both; identification.method must be one of social_security_number, individual_taxpayer_identification_number, passport, drivers_license, or other. identification.number must contain at least 4 characters, and a country value defaults to US when omitted.