Link beneficiary to company (KYB 1.0)

Time	Status	User Agent
Retrieving recent requests…

Time

Status

User Agent

Retrieving recent requests…

Path Params

applicantId

string

required

Unique identifier of the company applicant to whose control and ownership structure you need to add a beneficiary applicant.

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.

If the applicantId is unknown to you, use the Get applicant data (externalUserId) method to fetch it.

Body Params

applicant

object

required

Includes the identifier (id) of the applicant that needs to be linked as a beneficiary to the company profile.

applicantId

string

required

Applicant identifier of the beneficiary to be linked to the company profile.

positions

array of strings

Positions in the company that the beneficiary is holding.

director — appointed to manage the company business and affairs.
shareholder — owns shares in the company stock.
other — specify a position that does not meet the two above.

Add one position per string.

positions

type

string

enum

required

Defaults to shareholder

Beneficiary single role in the company control and ownership structure.

Possible values:

ubo — ultimate beneficial owner of the company.
shareholder — owns shares in the company stock.
representative — authorized to act or speak for or in support of the company.
director — appointed to manage the company business and affairs.

Allowed: