Skip to main content
Weavr API
Corporates

Upload a KYB supporting document for a corporate

POST/corporates/{corporateId}/kyb/documents

Use this when you already hold paperwork for a corporate (a registration certificate or a shareholder register, say) and want it attached to the corporate's KYB before verification starts.

It stores one document against the corporate identified by the corporateId path parameter and returns the reference it was stored under. Send one document per call, up to 10 MB, as multipart/form-data, in PDF, PNG, JPEG, WebP, or DOCX format. Set the file part's Content-Type to match the file; the file type is checked against it. Oversized files are rejected with DOCUMENT_TOO_LARGE and other formats with UNSUPPORTED_DOCUMENT_FORMAT.

Only the size and type are checked on upload. Weavr's compliance team reviews each document against Weavr's compliance policy and adds accepted ones to the corporate's KYB case; uploaded documents aren't shown to the root user in the KYB UI Component. If a document doesn't meet the policy, the root user is asked for a replacement during review.

Calling it more than once

Every call stores a new document with its own reference, alongside the earlier ones. Duplicates aren't detected, so uploading the same file again stores a second copy. Documents can't be replaced or withdrawn through this API; upload the correct document and Weavr reviews everything received.

Timing

This only works before verification starts. Once the corporate has begun its KYB journey the upload is rejected with KYB_ALREADY_STARTED, so upload 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.

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

Request

Available on
SandboxProduction

Path parameters

Request body

*
multipart/form-data

Multipart form carrying a single KYB supporting document, up to 10 MB.

{}
CorporateKybDocumentFormCorporateKybDocumentForm · object · 3 fields
Encoding
file content type: application/pdf, image/png, image/jpeg, image/webp, application/vnd.openxmlformats-officedocument.wordprocessingml.document

Responses

201Created

Document accepted

Headers
Body
application/json
{}
CorporateKybDocumentResponseCorporateKybDocumentResponse · object · 1 field
Response example
{  "reference": "doc-7f3e2b1a"}