Edit type, name, description, or replace the underlying file by supplying a new file_id from a fresh presigned URL call. Send only the fields you want to change.
Not allowed when the document is locked for review (status APPROVED or PROCESSING) — these return 400. PENDING and REJECTED documents are editable. Required scope: customer:write.
Authorization
oauth2ClientCredentials customer:writeUse your OAuth client credentials to obtain a short-lived Bearer token from POST /oauth/token.
In: header
Scope: customer:write
Path Parameters
uuiduuidRequest Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
curl --request PUT \ --url 'https://example.com/api/external/customer/497f6eca-6276-4993-bfeb-53cbbbba6f08/document/497f6eca-6276-4993-bfeb-53cbbbba6f08' \ --header 'Content-Type: application/json' \ --data '{}'POSTRegister a KYB document
Use after PUTting a file to the presigned URL. The server verifies that the upload exists, checks size and MIME, and stores the document with status `PENDING`. Max file size 25 MB. Allowed MIME: `application/pdf`, `image/jpeg`, `image/png`. Files that fail these checks return 422. **Formation documents are required for verification.** When you call `POST /api/external/customer/{customer}/submit`, at least one document of a formation type must be present. Formation types are: `CERTIFICATE_OF_INCORPORATION`, `ARTICLES_OF_INCORPORATION`, `BENEFICIAL_OWNERSHIP_CERTIFICATE`, `INCORPORATION_DOCUMENTS`, `CAC_STATUS_REPORT`. Other types may be required by your compliance reviewer depending on the business profile. All uploaded documents must be **clear, legible, and authentic**. Blurry, cropped, obscured, or otherwise unclear images will be rejected. Fraudulent or falsified documents will not be tolerated — repeated attempts to submit false or invalid documents will result in the customer being **permanently blacklisted** from the platform. There are no exceptions or compromises. The customer must be of type `business`. Required scope: `customer:write`.
DELETEDelete a KYB document
Removes a KYB document from the customer's collection. Returns 400 if the document is locked (status APPROVED or PROCESSING). Required scope: `customer:write`.