Feel free to reach techsupport@surepass.io for any technical support or guidance.
Authorization
header as Bearer TOKEN
.https://sandbox.surepass.io
https://kyc-api.surepass.io
Header | Required | Description |
---|---|---|
Authorization | Yes | Bearer token for authentication (JWT format) |
Content-Type | Yes | Must be multipart/form-data |
Parameter | Type | Required | Description |
---|---|---|---|
file | File | Yes | Image or PDF file of the UAE commercial license. Supported formats include JPG, PNG, and PDF. |
use_pdf | Boolean | No | When file type is pdf |
Parameter | Type | Description |
---|---|---|
data | Object | Contains the extracted data and client identifier |
data.client_id | String | Unique identifier for the OCR request |
data.ocr_fields | Array | Array of objects containing the extracted OCR data |
data.ocr_fields[].document_type | String | Type of UAE commercial license detected (see enum values below) |
data.ocr_fields[].license_number | Object | Contains the extracted license number and confidence score |
data.ocr_fields[].license_number.value | String | The extracted license number |
data.ocr_fields[].license_number.confidence | Integer | Confidence score for the extracted license number (0-100) |
data.ocr_fields[].standard_document | Boolean | Indicates if the document follows standard format |
status_code | Integer | HTTP status code of the response |
message_code | String | Status message code |
message | String | Additional message information (null if successful) |
success | Boolean | Indicates if the API call was successful |
{
"data": {
"client_id": "uae_com_license_fzJseMkjrlnUlgvHczwG",
"ocr_fields": [
{
"document_type": "fujairah_professional_license",
"license_number": {
"value": "12734",
"confidence": 98
},
"standard_document": true
}
]
},
"status_code": 200,
"message_code": "success",
"message": null,
"success": true
}
{
"data": null,
"status_code": 401,
"message_code": "unauthorized",
"message": "Invalid or expired authentication token",
"success": false
}
Document Type Value | Description |
---|---|
dubai_com_license | Dubai Commercial License |
abu_dhabi_tourism_license | Abu Dhabi Tourism License |
sharjah_business_license | Sharjah Business License |
sharjah_trading_license | Sharjah Trading License |
fujairah_trade_license | Fujairah Trade License |
dubai_business_license | Dubai Business License |
fujairah_professional_license | Fujairah Professional License |
ras_al_khaimah_tourism_license | Ras Al Khaimah Tourism License |
ras_al_khaimah_services_license | Ras Al Khaimah Services License |
ras_al_khaimah_com_license | Ras Al Khaimah Commercial License |
ajman_trade_license | Ajman Trade License |
ajman_commercial_license | Ajman Commercial License |
ajman_com_license | Ajman Commercial License |
dubai_service_license | Dubai Service License |
sharjah_publishing_business_license | Sharjah Publishing Business License |
ajman_tourism_license | Ajman Tourism License |
sharjah_professional_license | Sharjah Professional License |
abu_dhabi_business_tourism_license | Abu Dhabi Business Tourism License |
abu_dhabi_com_license | Abu Dhabi Commercial License |
umm_ai_quwain_com_license | Umm Al Quwain Commercial License |
dubai_professional_license | Dubai Professional License |
ajman_professional_license | Ajman Professional License |
dubai_tourism_license | Dubai Tourism License |
sharjah_publishing_professional_license | Sharjah Publishing Professional License |
ajman_business_license | Ajman Business License |
united_arab_professional_license | United Arab Emirates Professional License |
ajman_service_license | Ajman Service License |
quwain_com_license | Quwain Commercial License |
dubai_renew_license | Dubai Renewal License |
sharjah_license | Sharjah License |
abu_dhabi_business_license | Abu Dhabi Business License |
dhabi_com_license_license | Abu Dhabi Commercial License |
fujairah_com_license | Fujairah Commercial License |
curl --location --request POST 'https://kyc-api.surepass.app/api/v1/ocr/uae-com-license' \
--form 'file=@""'
{
"data": {
"client_id": "uae_com_license_fzJseMkjrlnUlgvHczwG",
"ocr_fields": [
{
"document_type": "fujairah_professional_license",
"license_number": {
"value": "12734",
"confidence": 98
},
"standard_document": true
}
]
},
"status_code": 200,
"message_code": "success",
"message": null,
"success": true
}