Passport OCR

Function

Passport OCR recognizes the text on the first page of a passport and returns the structured information in JSON format.

In the current version, all fields of a Chinese passport can be recognized. For non-Chinese passports, two lines of internationally standardized machine-readable codes on the bottom of each passport can be recognized, and 6 to 7 key fields can be extracted from the codes.For details about the constraints on using this API, see Constraints. For details about how to use this API, see Introduction to OCR.

Figure 1 Passport OCR example

Prerequisites

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

Before using the service for the first time, you need to enable the service by clicking Subscribe. 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

Request Parameters

Response Parameters

Response parameters and status codes vary in different recognition results. They are described as below.

Status code: 200

Status code: 400

Request Example

• The endpoint is the request URL for calling an API. Endpoints vary depending on services and regions. For details, see Endpoints.

  For example, Passport OCR is deployed in the CN-Hong Kong region. The endpoint is ocr.ap-southeast-1.myhuaweicloud.com. The request URL is https://ocr.ap-southeast-1.myhuaweicloud.com/v2/{project_id}/ocr/passport. project_id is the project ID. For details about how to obtain the project ID, see Obtaining a Project ID.

• For details about how to obtain a token, see Making an API Request.

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

  POST https://{endpoint}/v2/{project_id}/ocr/passport
  Request Header:
  Content-Type: application/json
  X-Auth-Token: MIINRwYJKoZIhvcNAQcCoIINODCCDTQCAQExDTALBglghkgBZQMEAgEwgguVBgkqhkiG...
  Request Body:
  {
      "image":"/9j/4AAQSkZJRgABAgEASABIAAD/4RFZRXhpZgAATU0AKgAAAA...",
      "country_code": "GENERAL"
  }

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

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

• Sample code for a Python 3 request (For codes in other languages, refer to the following sample or use OCR SDK.)

  # encoding:utf-8
  
  import requests
  import base64
  
  url = "https://{endpoint}/v2/{project_id}/ocr/passport"
  token = "Actual token value obtained by the user"
  headers = {'Content-Type': 'application/json', 'X-Auth-Token': token}
  
  imagepath = r'./data/passport-demo.png'
  with open(imagepath, "rb") as bin_data:
      image_data = bin_data.read()
  image_base64 = base64.b64encode(image_data).decode("utf-8")  # Base64 encoding of images.
  payload = {"image": image_base64}  # url or image.
  response = requests.post(url, headers=headers, json=payload)
  print(response.text)

Example Response

Status code: 200

Chinese passport

{
    "result": {
        "passport_type": "P", 
        "country_code": "CHN", 
        "passport_number": "ED999XXXX", 
        "nationality": "CHINESE", 
        "surname": "ZHANG", 
        "given_name": "SAN", 
        "sex": "F", 
        "date_of_birth": "1990-12-12", 
        "date_of_expiry": "2020-07-08", 
        "date_of_issue": "2010-07-09", 
        "place_of_birth": "HUNAN", 
        "place_of_issue": "GUANGDONG", 
        "issuing_authority": "MPS Exit & Entry Administration", 
        "extra_info": {
            "local_language": {
                 "name": "Name recognized from the image",
                "sex": "Gender recognized from the image",
                "place_of_birth": "Place of birth recognized from the image",
                "place_of_issue": "Place of issue recognized from the image",
                "issuing_authority": "Issuing authority recognized from the image",
                "nationality": "Nationality recognized from the image",
            }
        }, 
        "confidence": {
            "passport_type": 1.0, 
            "country_code": 1.0, 
            "passport_number": 0.9997, 
            "nationality": 1.0, 
            "surname": 0.9729, 
            "given_name": 0.9729, 
            "sex": 1.0, 
            "date_of_birth": 0.9998, 
            "date_of_expiry": 0.9995, 
            "date_of_issue": 0.9969, 
            "place_of_birth": 1.0, 
            "place_of_issue": 1.0, 
            "issuing_authority": 0.9985
        }
    }
}

Non-chinese passport

{
    "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

For details about status codes, see Status Codes.

Error Codes

For details about error codes, see Error Codes.