Emirates ID OCR V2

Endpoint Overview

POST /api/v1/ocr/uae-emirates-v2

Description

The Emirates ID OCR V2 API extracts key information from UAE Emirates ID cards using advanced optical character recognition technology. This endpoint processes images or PDFs of UAE ID cards (front and back sides) and returns structured data including personal details, document dates, and demographic information with confidence scores for each extracted field.

Key Benefits

Automated extraction of Emirates ID data with high accuracy and confidence scores

Support for both image and PDF formats with single or dual-side processing

Comprehensive data extraction including personal details, dates, and employment information

Reduced manual data entry and improved customer onboarding efficiency

Use Cases

Financial Services

Government Services

Corporate Onboarding

KYC verification during customer onboarding for banks and financial institutions

Automated identity verification for loan or credit card applications

Streamlined account opening processes with reduced manual data entry

Technical Implementation

Authentication

All API requests require authentication using a JWT Bearer token. Authentication follows these steps:

Obtain API Credentials: Register with Surepass to receive your API key.

Generate JWT Token: Use your API key to generate a JWT token.

Include in Requests: Add the token to the Authorization header as Bearer TOKEN.

Different authentication tokens are used for sandbox and production environments:

Sandbox: https://sandbox.surepass.io

Production: https://kyc-api.surepass.io

Request Parameters

Request Headers

Header	Required	Description
Authorization	Yes	JWT Bearer token for authentication. Format: `Bearer YOUR_JWT_TOKEN`
Content-Type	Yes	Must be `multipart/form-data` for file uploads

Request Body

Parameter	Type	Required	Description
file	File (Image/PDF)	Conditional*	Complete UAE ID image or PDF containing both sides
front	File (Image/PDF)	Conditional*	Front side image or PDF of the UAE ID
back	File (Image/PDF)	Conditional*	Back side image or PDF of the UAE ID
use_pdf	Boolean	No	Set to `true` if the uploaded file is a PDF. Default is `false`
link	String	No	Url
front_link	String	Conditional*	Front side image url
back_link	String	Conditional*	Back side image url

*At least one of the parameters file, front, or back is required to process the request.

Example Request

Process Response

Response Parameters

Parameter	Type	Description
data	Object	Contains all the extracted information
data.client_id	String	Unique identifier for the OCR request
data.name	OCR Object	Extracted name from the Emirates ID
data.gender	OCR Object	Extracted gender (M/F)
data.dob	OCR Object	Extracted date of birth in YYYY-MM-DD format
data.nationality	OCR Object	Extracted nationality of the ID holder
data.issue_date	OCR Object	ID issue date in YYYY-MM-DD format
data.expiry_date	OCR Object	ID expiry date in YYYY-MM-DD format
data.occupation	OCR Object	Extracted occupation of the ID holder
data.employer	OCR Object	Extracted employer information
data.issuing_place	OCR Object	Location where the ID was issued
status_code	Integer	HTTP status code of the response
success	Boolean	Indicates if the request was successful
message	String	Human-readable status message
message_code	String	Machine-readable status code

OCR Object Structure

Each extracted field is returned as an OCR Object with the following structure:

Field	Type	Description
value	String	The extracted value of the field
confidence	Float	Confidence score between 0 and 1 indicating extraction accuracy

Example Successful Response

{
    "data": {
        "client_id": "ocr_uae_emirates_v2_vTPbNlWAsxbtCMqmgeaW",
        "name": {
            "value": "Muhammad",
            "confidence": 0.96
        },
        "gender": {
            "value": "M",
            "confidence": 0.98
        },
        "dob": {
            "value": "1800-01-04",
            "confidence": 0.99
        },
        "nationality": {
            "value": "Pakistan",
            "confidence": 0.98
        },
        "issue_date": {
            "value": "2022-01-21",
            "confidence": 0.99
        },
        "expiry_date": {
            "value": "2024-01-20",
            "confidence": 0.99
        },
        "occupation": {
            "value": "Light Vehicle Driver",
            "confidence": 0.95
        },
        "employer": {
            "value": "Engineering Techniques ServicesL",
            "confidence": 0.97
        },
        "issuing_place": {
            "value": "Fujairah",
            "confidence": 0.98
        }
    },
    "status_code": 200,
    "success": true,
    "message": "Success",
    "message_code": "success"
}

Possible Error Responses

Missing Required Parameters

Authentication Error

Invalid File Format

{
    "status_code": 400,
    "success": false,
    "message": "At least one of file, front, or back is required",
    "message_code": "missing_required_parameters"
}

This error occurs when none of the required parameters (file, front, or back) are provided in the request.

Integration Best Practices

Security Recommendations

Store JWT tokens securely and never expose them in client-side code

Implement proper error handling to manage failed OCR attempts gracefully

Use HTTPS for all API communications to ensure data security

Implement token refresh mechanisms to handle token expiration

User Experience Guidelines

Provide clear instructions to users about acceptable image quality for optimal OCR results

Implement a preview feature to help users capture clear images of their Emirates ID

Display a loading indicator during OCR processing to improve perceived performance

Implement field validation on extracted data to allow users to correct any OCR errors

Code Samples

cURL

Python

Node.js

Related APIs

Passport OCR API: Extract information from international passports

UAE Driving License OCR: Extract data from UAE driving licenses

Document Verification API: Verify the authenticity of extracted document data

Face Match API: Compare the face on the ID with a selfie for identity verification

Compliance and Legal Considerations

When implementing this API, ensure compliance with UAE data protection regulations and GDPR if processing data of EU residents. Store extracted personal data securely and only for the duration necessary for your service. Obtain appropriate user consent before processing ID documents, and implement proper data retention and deletion policies.

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

{ "data": { "client_id": "ocr_uae_emirates_v2_vTPbNlWAsxbtCMqmgeaW", "name": { "value": "Muhammad", "confidence": 0.96 }, "gender": { "value": "M", "confidence": 0.98 }, "dob": { "value": "1800-01-04", "confidence": 0.99 }, "nationality": { "value": "Pakistan", "confidence": 0.98 }, "issue_date": { "value": "2022-01-21", "confidence": 0.99 }, "expiry_date": { "value": "2024-01-20", "confidence": 0.99 }, "occupation": { "value": "Light Vehicle Driver", "confidence": 0.95 }, "employer": { "value": "Engineering Techniques ServicesL", "confidence": 0.97 }, "issuing_place": { "value": "Fujairah", "confidence": 0.98 } }, "status_code": 200, "success": true, "message": "Success", "message_code": "success" }

Emirates ID OCR V2

Emirates ID OCR V2#

Description#

Use Cases#

Technical Implementation#

Request Headers#

Request Body#

Example Request#

Response Parameters#

OCR Object Structure#

Example Successful Response#

Possible Error Responses#

Integration Best Practices#

Code Samples#

Request

Responses

Emirates ID OCR V2

Description

Use Cases

Technical Implementation

Request Headers

Request Body

Example Request

Response Parameters

OCR Object Structure

Example Successful Response

Possible Error Responses

Integration Best Practices

Code Samples