On this page

Function
Prerequisites
URI
Request Parameters
Response Parameters
Request Example
Example Response
Status Codes
Error Codes

Show all

Help Center/ Optical Character Recognition/ API Reference (ME-Abu Dhabi Region)/ APIs/ Passport

Passport

Updated on 2022-10-29 GMT+08:00

View PDF

Function

This API identifies and extracts text from the first page of images of passports and converts the text into a structured JSON format.

Prerequisites

Before using this API, you need to apply for the service and complete authentication. For details, see Subscribing to an OCR Service and Authentication.

NOTE:

Before using the service for the first time, you need to enable the service by clicking . You only need to subscribe to the service once. If the service is not enabled, an error message with error code "ModelArts.4204" will be displayed when you call the service. Before calling the service, log in to the OCR console and enable the service. Ensure that the region where the service is enabled is the same as that where the service is called.

URI

POST https://{endpoint}/v2/{project_id}/ocr/passport

**Table 1** Path parameters
Parameter	Mandatory	Description
endpoint	Yes	Domain name or IP address of the server bearing the REST service endpoint. The endpoint varies depending on services in different regions. For more details, see Endpoints.
project_id	Yes	Project ID, which can be obtained from Obtaining an Account ID and Project ID.

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	User token Used to obtain the permission to operate APIs. The token is the value of X-Subject-Token in the response header in Authentication.
Content-Type	Yes	String	MIME type of the request body. The value is application/json.

**Table 3** Request body parameters
Parameter	Mandatory	Type	Description
image	No	String	Configure either this parameter or url. Base64-encoded image file. The image file has a size limit of 10 MB. No side of the image can be smaller than 15 or larger than 4,096 pixels. Only images in JPEG, JPG, PNG, BMP, or TIFF format can be recognized. An example is /9j/4AAQSkZJRgABAg.... If the image data contains an unnecessary prefix, the error "The image format is not supported" is reported.
url	No	String	Configure either this parameter or image. Image URL. Currently, the following URLs are supported: URL of an image. NOTE: The API response time depends on the image download time. If the image download takes a long time, the API call will fail. Ensure that the storage service where the images to be detected reside is stable and reliable. OBS is recommended for storing image data.

Response Parameters

NOTE:

The status code may vary depending on the recognition results. For example, 200 indicates that the API is successfully called, and 400 indicates that the API fails to be called. The following describes the status codes and corresponding response parameters.

Status code: 200

**Table 4** Response body parameter
Parameter	Type	Description
result	PassportResult object	Calling result This parameter is not returned when the API fails to be called. This parameter consists of the following three parts: 13 key fields, expressed in English; extra_info, expressed in local official language; and confidence of key fields. A higher confidence indicates a more accurate result.

**Table 5** PassportResult
Parameter	Type	Description
country_code	String	Country code
passport_number	String	Passport ID
surname	String	Last name
given_name	String	Given game
sex	String	Gender
date_of_birth	String	Date of birth, for example, 1990-12-12
date_of_expiry	String	Passport date of expiry, for example, 2020-07-08
confidence	Object	Confidence of a field. The value ranges from 0 to 1. A higher confidence indicates a higher accuracy of the field identified. The confidence is calculated using algorithms and is not equal to the accuracy.
extra_info	Object	By default, this parameter is left blank.

Status code: 400

**Table 6** Response body parameters
Parameter	Type	Description
error_code	String	Error code of a failed API call. For details, see Error Codes. This parameter is not returned when the API is successfully called.
error_msg	String	Error message when the API call fails This parameter is not returned when the API is successfully called.

Request Example

Request example (Method 1: Use the image Base64 string.)

POST https://ocr.ae-ad-1.g42cloud.com/v2/{project_id}/ocr/passport
Request Header:
Content-Type: application/json
X-Auth-Token: MIINRwYJKoZIhvcNAQcCoIINODCCDTQCAQExDTALBglghkgBZQMEAgEwgguVBgkqhkiG...
Request Body:
{
    "image":"/9j/4AAQSkZJRgABAgEASABIAAD/4RFZRXhpZgAATU0AKgAAAA...",
}

Request example (Method 2: Use the image URL.)

POST https://ocr.ae-ad-1.g42cloud.com/v2/{project_id}/ocr/passport
Request Header:
Content-Type: application/json
X-Auth-Token: MIINRwYJKoZIhvcNAQcCoIINODCCDTQCAQExDTALBglghkgBZQMEAgEwgguVBgkqhkiG...
Request Body:
{
    "url":"https://BucketName.obs.xxxx.com/ObjectName",
}

Example Response

Status code: 200

{
    "result": {
        "country_code": "ETF", 
        "surname": "HUZHAO", 
        "given_name": "ZHAOMIN DESALEGN ", 
        "passport_number": "EP435XXXX", 
        "date_of_birth": "1985-09-18", 
        "sex": "M", 
        "date_of_expiry": "2022-01-15", 
        "machine_code": "P<ETFHUZHAO<< ZHAOMIN <DESALEGN<<<<<<<<<<<<<<<", 
        "machine_code2": "EP435XXXX7ETF8509185M2201155<<<<<<<<<<<<<<08", 
        "extra_info": {},
        "confidence": {
            "country_code": 0.9727, 
            "surname": 0.9727, 
            "given_name": 0.9727, 
            "passport_number": 0.9558, 
            "date_of_birth": 0.9558, 
            "sex": 0.9558, 
            "date_of_expiry": 0.9558
        }
    }
}

Status code: 400

Failure response example

{
    "error_code": "AIS.0103", 
    "error_msg": "The image size does not meet the requirements." 
}

Status Codes

Status Code	Description
200	Success response
400	Failure response

For details about status codes, see Status Codes.

Error Codes

For details about error codes, see Error Codes.

Parent topic: APIs

Previous topic: APIs

Next topic: UAE ID Card OCR

Feedback

Was this page helpful?

Helpful Not helpful

Provide feedback

Thank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.

The system is busy. Please try again later.

Which of the following issues have you encountered?

Content is inconsistent with the product UI

Unclear descriptions

Lack of examples or code

Incorrect steps

Can't find what I need

Lack of best practices

Feedback (optional)

0/500

Select at least one type of issue, and enter your comments or suggestions.

Enter a maximum of 500 characters.

Submit Cancel

For any further questions, feel free to contact us through the chatbot.

Chatbot