SUsumsub

Link beneficiary to company

Changed on
post/resources/applicants/{applicantId}/fixedInfo/companyInfo/beneficiaries

Request

Path parameters

applicantIdstring required

Unique identifier of the company applicant in the Sumsub system to which the nested applicant should be linked. <br><br>This identifier is a random combination of 24 digits and lowercase Latin characters. It is automatically generated when the applicant profile is created on the Sumsub side, and can be found in the Dashboard. <br><br>If the applicantId is unknown to you, use the Get applicant data (externalUserId) method to fetch it.

Request body

applicantIdstring

Applicant identifier of the beneficiary in the Sumsub system. <br><br>⚠️ Required when linking an existing applicant to the company. Leave empty when adding a new beneficiary with no profile in the Sumsub system yet.

typesstring[] required

Each string represents a beneficiary role for the new data structure, when one entity may have multiple roles.

Possible values: shareholder, ubo, representative, director, companyOfficer, investor, secretary, founder, legalAdvisor, authorizedSignatory, trustee, trustBeneficiary, trustSettlor, trustProtector, managingPartner, equityPartner, fundInvestor, fundManager, investmentManager, investmentAdviser, fundAdministrator, depositary, custodian, primeBroker, accountUser.

See Available values for types array.

subtypesstring[]

Each string further qualifies the basis on which the beneficiary is a UBO. Only applicable when types includes ubo. Possible values: ownershipUbo, controlUbo, substituteUbo. <br><br>See Available values for subtypes array.

natureOfControlstring

Free-text description of how the beneficiary exercises control over the company. Maximum 255 characters.<br><br>⚠️ Required when subtypes includes controlUbo.

shareSizenumber double

Percentage of ownership if the beneficiary is a shareholder of the company. Also used to report the ownership percentage when subtypes includes ownershipUbo.

Changes

  • fcc702e558a2Revision changes
    • info

      added the new optional request property /

    • info

      added the new optional request property

    • info

      added the new optional request property