Global Document Classifier API
Overview & Purpose
The Global KYB Document Classifier API is a synchronous service that classifies publicly accessible PDF documents into standardized KYB document types based on the provided country code.
It enables automated, country-aware document routing and validation across US and MENA KYB workflows.
API Details
Sample cURL for UAE
curl --location 'https://api.signzy.ae/api/v3/global/kyb-doc-classifier' \
--header 'Authorization:<Auth key>' \
--header 'Content-Type: application/json' \
--data '{
"fileLink": "<fileLink>",
"countryCode": "AE"
}'Sample cURL for US
curl --location 'https://api.signzy.us/api/v3/global/kyb-doc-classifier' \
--header 'Authorization:<Auth key>' \
--header 'Content-Type: application/json' \
--data '{
"fileLink": "<fileLink>",
"countryCode": "US"
}'Sample cURL for Global
curl --location 'https://api-preproduction.signzy.app/api/v3/global/kyb-doc-classifier' \
--header 'Authorization:<Auth key>' \
--header 'Content-Type: application/json' \
--data '{
"fileLink": "<fileLink>",
"countryCode": "<countryCode>"
}'API Input
The API expects the following input in the request payload:
Field | Type | Description |
|---|---|---|
fileLink | String | A publicly accessible or pre-signed URL pointing to the document file (e.g., PDF) that needs to be analyzed and classified by the API. |
countryCode | String | A two-letter ISO 3166-1 alpha-2 country code (e.g., "US") indicating the country context of the document. |
API Output
Success Response
{
"result": {
"documentType": "<documentType >",
"extractedCountryCode": "<extractedCountryCode>"
}
}Parameter | Description | Data Type |
|---|---|---|
result | Object containing the document classification result. | object |
result.documentType | The predicted or classified document type based on analysis of the provided file (e.g., AOA, MOA, BR, COI, etc.). | string |
result.extractedCountryCode | The country code detected or extracted from the document content in ISO 3166-1 alpha-2 format (e.g., US, IN, GB). | string |
United States (US)
The following document types are supported when countryCode = US:
Code | Description |
|---|---|
AOI | Articles of Incorporation / Organization |
COGS | Certificate of Good Standing / Status |
W9 | IRS Form W-9 |
UTILITY | Utility Bill |
OTHER | Unsupported / Unknown |
MENA Region
The following document types are supported for MENA countries (e.g., UAE, Saudi Arabia, etc.):
Code | Description |
|---|---|
TL | Trade / Commercial License |
MOA | Memorandum of Association |
AOA | Articles of Association |
POA | Power of Attorney |
COI | Certificate of Incumbency |
BR | Board Resolution |
OTHER | Unsupported / Unknown |
Error Codes
{
"error": {
"name": "error",
"message": "Failed to process PDF ",
"status": 409,
"reason": "UPLOAD_ERROR",
"type": "Conflict",
"statusCode": "409"
}
}Getting help
Please feel free to contact us if you have any questions, require clarification, or have ideas for how to make the documents or any of our services better.
You can reach out to us at [email protected]. We strive to provide prompt and reliable assistance, ensuring your queries are addressed effectively.
We value your feedback and are committed to making your experience smooth and enjoyable. Our team is dedicated to assisting you with any needs you may have. Thank you for choosing our services. We look forward to helping you!