Skip to main content
Weavr API
Corporates

Submit known KYB entity data for a corporate

POST/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 — 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. INVALID_REF means a relation names a ref that isn't in the submission.

Only the corporate's root user can be marked with isSignatory, otherwise the request fails with SIGNATORY_MUST_BE_ROOT.

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. NOT_SUPPORTED means the corporate's profile isn't configured to accept pre-populated KYB data.

Read Corporate due diligence and KYB for the full verification flow.

Request

Available on
SandboxProductionMock server

Path parameters

Request body

*
application/json

Company and ownership-graph information submitted to pre-populate a corporate's KYB. Every field is optional.

{}
CorporateKybEntitySubmissionCorporateKybEntitySubmission · object · 4 fields

Responses

201Created

Details accepted.