Scan API
Last updated
Last updated
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.
POST <Api base url>/api/v1/scan
The <Api base url> is listed in the Customer Portal under Development > Credentials.
Name | Value | Required |
---|---|---|
Name | Value | Required |
---|---|---|
The payload contains the following parts:
The API returns a JSON object with the following structure:
Please note that “https://example.com” needs to be replaced with the api server base url.
#Sample Response Body
Below an example of UAE_ID scan process response body:
Name | Value | Required |
---|---|---|
Status code | Status Message | Description |
---|---|---|
Property | Values | Description |
---|---|---|
Content-Type
multipart/form-data
true
Authorization
Bearer <access token>
true
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
documentType