Submit known KYB entity data for a corporate
/corporates/{corporateId}/kyb/entity Use this when you already hold company and ownership information for a corporate and want its KYB pre-populated before the corporate starts verification. Every field is optional, so send what you have.
It records the company details and the ownership graph for the corporate identified by the corporateId
path parameter. The corporate's own name, registration number, and registration country come from the
corporate record and aren't accepted here.
Describing the ownership graph
Give every company in companies and every person in individuals a ref of your own choosing, then
join them up in relations. A relation points fromRef (the holder of the stake or role) at toRef;
leave toRef empty to point at the corporate itself. Every fromRef and toRef must match a ref in
this request or in an earlier call for the same corporate, otherwise the request fails with INVALID_REF.
Only the corporate's root user can be marked with isSignatory, otherwise the request fails with
SIGNATORY_MUST_BE_ROOT. The individual is matched to the root user by email, or by first and last name
if either email is missing, so include the root user's email to make the match unambiguous.
Calling it more than once
Each call is applied on top of what you sent before rather than replacing it. Entries are matched by
ref, so keep each ref stable for the same company or person across calls. Relations sent for a holder
replace that holder's earlier relations, so include all of them, not only the new ones. Data can't be
removed through this API; the root user corrects it in the KYB UI Component once KYB starts.
If a request fails with INVALID_REF, some companies or individuals in it may already have been stored.
Fix the relations and send the same request again; nothing is duplicated.
Timing
This only works before verification starts. Once the corporate has begun its KYB journey the submission
is rejected with KYB_ALREADY_STARTED, so submit what you hold before calling
Start KYB for a corporate. A MANAGED_ONBOARDING_PENDING
response from Start KYB doesn't close this window. The root user doesn't need to have verified their
email yet. NOT_SUPPORTED means the corporate's profile isn't configured to accept pre-populated KYB
data, or to accept company and ownership data.
Read Corporate due diligence and KYB for the full verification flow.
Request
Path parameters
Request body
*Company and ownership-graph information submitted to pre-populate a corporate's KYB. Every field is optional.
Responses
Details accepted