| Document Type | Endpoint | Description |
|---|---|---|
| ID Document | POST /kyc/documents/id | Extract data from ID documents |
| Proof of Address | POST /kyc/documents/proof-of-address | Extract data from address proof documents |
| Company Charter | POST /kyc/documents/company-charter | Extract data from company charter documents |
| Bank Ownership | POST /kyc/documents/bank-ownership | Extract data from bank ownership documents |
kyc:create permission. Include your Bearer token in the Authorization header.
image/jpeg)image/png)application/pdf)| Field | Type | Description |
|---|---|---|
status | string | Always "success" when extraction completes |
verification_id | string | Unique identifier for this verification |
document_type | string | Type of document processed |
extracted_data | object | Extracted structured data (varies by document type) |
confidence_scores | object | Confidence scores for extracted fields |
processing_time_ms | integer | Total processing time in milliseconds |
timestamp | string | ISO 8601 timestamp of the extraction |
| Field | Type | Description |
|---|---|---|
full_name | string | Full name from document |
document_number | string | Document ID number |
document_type | string | Type of ID (Passport, Driver’s License, etc.) |
nationality | string | Nationality/country code |
date_of_birth | string | Date of birth (YYYY-MM-DD) |
expiry_date | string | Expiry date (YYYY-MM-DD) |
issue_date | string | Issue date (YYYY-MM-DD) |
issuing_authority | string | Authority that issued the document |
| Field | Type | Description |
|---|---|---|
address | string | Full address |
city | string | City name |
state | string | State/province |
postal_code | string | Postal/ZIP code |
country | string | Country code |
document_date | string | Date on document (YYYY-MM-DD) |
utility_type | string | Type of utility (if applicable) |
account_holder_name | string | Name on the account |
| Field | Type | Description |
|---|---|---|
company_name | string | Registered company name |
registration_number | string | Company registration number |
incorporation_date | string | Date of incorporation (YYYY-MM-DD) |
registered_address | string | Registered business address |
city | string | City |
state | string | State/province |
country | string | Country code |
legal_form | string | Legal form (Corporation, LLC, etc.) |
authorized_capital | string | Authorized capital amount |
directors | array | Array of director objects |
| Field | Type | Description |
|---|---|---|
account_holder_name | string | Name on the account |
account_number | string | Account number (may be masked) |
bank_name | string | Bank name |
account_type | string | Type of account (Checking, Savings, etc.) |
routing_number | string | Bank routing number |
statement_date | string | Statement date (YYYY-MM-DD) |
address | string | Address associated with account |
| Code | Description |
|---|---|
| 200 | Success - Document processed and data extracted |
| 400 | Bad Request - Invalid parameters or image format |
| 401 | Unauthorized - Missing or invalid token |
| 403 | Forbidden - Insufficient permissions |
| 500 | Internal Server Error |
"bedrock" (default)"openai""gpt-4o")