功能介绍

识别护照首页图片中的文字信息，并以json格式返回识别的结构化结果。

当前版本支持中国护照的全字段识别。外国护照支持护照下方两行国际标准化的机读码识别，并可从中提取6-7个关键字段信息。该接口的使用限制请参见约束与限制，详细使用指导请参见OCR服务使用简介章节。

图1 护照识别示例图

如果图片中包含多张卡证票据，请调用智能分类识别服务。

调试

您可以在API Explorer中调试该接口。

前提条件

在使用护照识别之前，需要您完成服务申请和认证鉴权，具体操作流程请参见申请服务和认证鉴权章节。

URI

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

请求参数

响应参数

根据识别的结果，可能有不同的HTTP响应状态码（status code），状态码和响应参数说明如下。

状态码： 200

状态码： 400

请求示例

• “endpoint”即调用API的请求地址，不同服务不同区域的“endpoint”不同，具体请参见终端节点。

  例如，护照识别服务部署在“华北-北京四”区域的“endpoint”为“ocr.cn-north-4.myhuaweicloud.com”，请求URL为“https://ocr.cn-north-4.myhuaweicloud.com/v2/{project_id}/ocr/passport”，“project_id”为项目ID，获取方法请参见获取项目ID

• 如何获取Token具体操作请参见构造请求。

• 请求样例（方式一：使用图片的base64编码）

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

• 请求样例（方式二：使用图片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"
  }

• Python3语言请求代码示例（其他语言参照下列示例编写或使用OCR SDK）

  # encoding:utf-8
  
  import requests
  import base64
  
  url = "https://{endpoint}/v2/{project_id}/ocr/passport"
  token = "用户获取得到的实际token值"
  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编码
  payload = {"image": image_base64}  # url与image参数二选一
  response = requests.post(url, headers=headers, json=payload)
  print(response.text)

响应示例

状态码：200

中国护照

{
    "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": "张三", 
                "sex": "女", 
                "place_of_birth": "湖南", 
                "place_of_issue": "广东", 
                "issuing_authority": "xxx出入境管理局", 
                "nationality": "中国"
            }
        }, 
        "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
        }
    }
}

外国护照

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

状态码：400

失败响应示例

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

状态码

状态码请参见状态码。

错误码

错误码请参见错误码。