Supported document types
| Document type | Description |
|---|---|
KybCertificateOfIncorporation | Certificate of incorporation, articles of association, or similar formation documents |
KybOwnershipDocument | Shareholder certificate, ownership registry extract, or similar documents listing beneficial owners |
Step 1: Create an applicant
Create an applicant to associate the verification with.- Curl
- Python
Step 2: Upload a document
Upload the corporate document using the file upload endpoint. Note the returneddocument_id — you will pass it to the verification request.
- Curl
- Python
Step 3: Submit verification request
Submit the document for KYB verification. Optionally provide shareholder data to validate against extracted information from the document.- Curl
- Python
Request body
| Field | Type | Required | Description |
|---|---|---|---|
documents | array | Yes | List of documents to verify |
documents[].doc_path | string | Yes | Document ID returned from the upload endpoint |
documents[].document_type | string | Yes | One of KybCertificateOfIncorporation, KybOwnershipDocument |
user_provided_data | object | No | Shareholder data to validate against the document |
user_provided_data.shareholders | array | No | List of shareholders to verify |
user_provided_data.shareholders[].name | string | No | Full name |
user_provided_data.shareholders[].first_name | string | No | First name |
user_provided_data.shareholders[].last_name | string | No | Last name |
user_provided_data.shareholders[].nationality | string | No | Country code (e.g. US) |
Step 4: Poll for the result
The verification takes approximately 15-30 seconds. Poll the result endpoint until the status changes frominitial.
- Curl
- Python
Verification errors
When a document verification returnsnot_verified, the response_data.result.document_results[].errors array contains one or more of the following error codes:
| Error code | Description |
|---|---|
SHAREHOLDER_NAME_NOT_FOUND | A provided shareholder name was not found in the document |
SHAREHOLDER_NAME_MISMATCH | A shareholder name was found but does not match the provided data |
SHAREHOLDER_NATIONALITY_MISMATCH | Shareholder nationality does not match |
DOCUMENT_UNREADABLE | The document could not be parsed or read |
DOCUMENT_TYPE_NOT_SUPPORTED | The document type is not supported |
DOCUMENTS_FROM_DIFFERENT_ENTITIES | Multiple documents appear to belong to different companies |
IRRELEVANT_DOCUMENT_PROVIDED | The provided document is not relevant for KYB verification |