Add Beneficial Owner

POST 
/api/partner/v1/onboarding/:ref/beneficiaries

Adds a beneficial owner (manual entry) to a multi-person company: identity, address, indication basis, identity document, the PEP declaration and the source-of-wealth declaration (both declared by the submitter on the beneficial owner's behalf). Applies to multi-person companies only (422 otherwise). The response includes a stable beneficiary_uuid used to remove the entry. Requires scope onboarding:write.

Request

Responses

200

Beneficial owner added. Returns the draft reference plus the new entry uuid.

401

Missing, invalid or revoked partner key.

403

Partner key lacks the onboarding:write scope.

404

Unknown ref within your channels.

409

Account already active - onboarding data is no longer editable.

422

Validation failed, or this segment does not apply to the entity type (sole trader / natural person).