> For the complete documentation index, see [llms.txt](https://docs.uqudo.com/docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.uqudo.com/docs/kyc/uqudo-api/scan.md). # Scan API The following API allows uploading the front and back image of the document using multipart form data. JPEG, PNG and PDF are supported. Max file size allowed is 5MB for each file. Although we recommend uploading smaller files to avoid affecting performances. A picture size of \~500KB with a resolution of 1080x1920 can work perfectly fine. High resolution pictures don’t improve the quality of the result and are not needed. If you need to accept a bigger file you need to decrease the size at your end before calling this API. **Note**: When a PDF file is used you have two choices for a two page document: you can send front and back in separate files or you can send a single PDF with both images. The system will assume that the first image is the front page of the document. **Note**: Utilize this API within your backend and do not make direct calls within your frontend application. ## Endpoint URL POST *\*/api/v1/scan The *\* is listed in the Customer Portal under Development > Credentials. ## Headers | Name | Value | Required | | ------------- | ---------------------- | -------- | | Content-Type | multipart/form-data | true | | Authorization | Bearer \ | true | ## Query Parameters | Name | Value | Required | | ----------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------- | | disableExpiryValidation |

(true or false)

Default value: false

If true disables document expiry validation

| false | | exportFaceImage |

(true or false)

Default value: true

Enable or disable face detection in the document. If not needed it should be disabled

| false | ## Payload (multipart/form-data) The payload contains the following parts: | Name | Value | Required | | ------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------- | | documentType |

UAE\_EVISA
UAE\_ID\_APPLICATION\_FORM

IRQ\_ID
TUN\_ID
SOM\_ID
BHR\_VL
JOR\_ID
JOR\_VL
SAU\_VL
MAR\_ID
IDN\_ID
SYR\_ID
YEM\_ID

| true | | frontImage | Binary image of the front page of the document | true | | backImage | Binary image of the back page of the document | False (required for a two side document) | ## Response Status | Status code | Status Message | Description | | ----------- | ---------------------- | ------------------------------------------------------------------------------------------------------- | | 200 | OK | Successful operation. See [2.7. Response Body for Status Code 200](broken://pages/7L0V6e1eCVuySN0LZos4) | | 400 | Bad Request | See [2.6. Response Body for Status Code 400](broken://pages/7L0V6e1eCVuySN0LZos4) | | 401 | Unauthorized | Access token missing, invalid or expired | | 403 | Forbidden | Access token not allowed to access a certain API or functionality | | 413 | Payload Too Large | | | 415 | Unsupported Media Type | | | 500 | Internal Server Error | Unexpected error | ## Response Body for Status Code 400 | Property | Values | Description | | -------- | ------------------------------------- | -------------------------------------------------------------------------------------------------- | | error | INVALID\_INPUT | Missing required input or invalid format | | | SCAN\_DOCUMENT\_NOT\_RECOGNIZED | Document type not recognized. Scanning failed or document type doesn’t match the provided document | | | SCAN\_DOCUMENT\_EXPIRED | Document is expired | | | SCAN\_DOCUMENT\_FRONT\_BACK\_MISMATCH | Front and back pages don't belong to the same document. Not supported for every document type | | message | Description of the error | | ## Response Body for Status Code 200 (application/json) The API returns a JSON object with the following structure: ``` { "front": {}, "back": {} } ``` ## Sample Request using curl ``` $ curl -v \ -H 'Authorization: Bearer token' \ https://example.com/api/v1/scan \ -F documentType=UAE_ID \ -F frontImage=@/front.jpg \ -F backImage=@/back.jpg ``` Please note that “ needs to be replaced with the api server base url. \#Sample Response Body Below an example of UAE\_ID scan process response body: ``` { "front": { "fullName": "Mario Casola", "identityNumber": "784-19XX-XXXXXXX-9", "nationality": "Italy", "faceImage": "" }, "back": { "secondaryId": "MARIO", "primaryId": "CASOLA", "dateOfBirth": "800825", "dateOfExpiry": "200306", "documentNumber": "0880XXX20", "serialNumber": "0B800029B46XXXXX", "nationality": "ITA", "issuer": "ARE", "sex": "M", "documentCode": "IL", "mrzText": "ILARE0880XXX20378419XXXXXXXXX9\n8008253M2003061ITA<<<<<<<<<<<9\nCASOLA<