文档首页 > > API参考> API> 护照识别

护照识别

分享
更新时间: 2019/10/30 GMT+08:00

功能介绍

识别用户上传的护照首页图片中的文字信息,并返回识别的结构化结果。

当前版本支持中国护照的全字段识别。外国护照支持护照下方两行国际标准化的机读码识别,并可从中提取6-7个关键字段信息。

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

URI

URI格式:

POST /v1.0/ocr/passport

请求消息

护照识别请求参数说明请参见 表1
表1 请求参数

参数

是否必选

参数类型

说明

image

与url二选一

String

图像数据,base64编码,要求base64编码后大小不超过10M。

图片最小边不小于15像素,最长边不超过4096像素,支持JPEG/JPG/PNG/BMP/TIFF格式。

url

与image二选一

String

图片的URL路径,目前仅支持华为云上OBS提供的匿名公开授权访问的URL以及公网URL。

country_code

String

输入值为护照颁发国的国家码,根据国家码选择对应的护照识别服务。

  • 若输入中未选此字段,服务会根据自己识别判断的护照类型匹配相应的护照识别服务。
  • 若选择值为GENERAL,则选择护照机器码识别。
  • 若选择值为CHN,则选择中国护照全字段识别。

响应消息

护照识别响应参数说明请参见 表2
表2 响应参数

参数

参数类型

说明

error_code

String

调用失败时的错误码,具体请参见错误码

调用成功时无此字段。

error_msg

String

调用失败时的错误信息。

调用成功时无此字段。

result

Object

调用成功时返回的调用结果。

Result中包含:13个主要字段,由英文表达;extra_info,由本地官方语言表达;以及主要字段的置信度信息,置信度越大,对应的字段的值越准确。

调用失败时无此字段。

passport_type

String

护照类型(P:普通因私护照、W:外交护照、G:公务护照)(英文)。

country_code

String

护照签发国的国家码(英文)。

passport_number

String

护照号码(英文)。

nationality

String

护照持有人国籍(英文)。

surname

String

姓(英文)。

given_name

String

名字(英文)。

sex

String

性别(英文)。

date_of_birth

String

出生日期(英文)。

date_of_expiry

String

护照有效期(英文)。

date_of_issue

String

护照签发日期(英文)。

place_of_birth

String

出生地(英文)。

place_of_issue

String

签发地(英文)。

issuing_authority

String

签发机构(英文),其中对中国的英文简写统一输出为P.R.China。

confidence

Object

相关字段的置信度信息,置信度越大,表示本次识别的对应字段的可靠性越高,在统计意义上,置信度越大,准确率越高。

置信度由算法给出,不直接等价于对应字段的准确率。

extra_info

Object

默认为空。对于部分常见国家的护照OCR服务,extra_info内会包含护照上由本地官方语言描述的字段信息及其他信息。

如中国护照,里面会包含汉字表达的姓名、出生地等信息。

示例

  • 请求样例(使用图片的BASE64编码)
    POST https://{endpoint}/v1.0/ocr/passport
     
    Request Header:
    Content-Type: application/json
    X-Auth-Token: MIINRwYJKoZIhvcNAQcCoIINODCCDTQCAQExDTALBglghkgBZQMEAgEwgguVBgkqhkiG...
    Request Body:
    {
        "image":"/9j/4AAQSkZJRgABAgEASABIAAD/4RFZRXhpZgAATU0AKgAAAA...",
        "country_code": "GENERAL"
    }

    Endpoint即调用API的请求地址,不同服务不同区域的Endpoint不同,具体请参见终端节点

    例如护照识别服务部署在“华北-北京四”区域的Endpoint为“ocr.cn-north-4.myhuaweicloud.com”,请求URL为“https://ocr.cn-north-4.myhuaweicloud.com/v1.0/ocr/passport”。

  • 响应样例
    • 例1:中国护照
      {
          "result": {
              "passport_type": "P", 
              "country_code": "CHN", 
              "passport_number": "ED9996060", 
              "nationality": "CHINESE", 
              "surname": "HU", 
              "given_name": "ZHAO", 
              "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": "公安部出入境管理局", 
                      "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
              }
          }
      }
    • 例2:外国护照
      {
          "result": {
              "country_code": "ETF", 
              "surname": "HUZHAO", 
              "given_name": "ZHAOMIN DESALEGN ", 
              "passport_number": "EP4350000", 
              "date_of_birth": "1985-09-18", 
              "sex": "M", 
              "date_of_expiry": "2022-01-15", 
              "machine_code": "P<ETFHUZHAO<< ZHAOMIN <DESALEGN<<<<<<<<<<<<<<<", 
              "machine_code2": "EP43500007ETF8509185M2201155<<<<<<<<<<<<<<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
              }
          }
      }
  • 失败响应样例
    {
        "error_code": "AIS.0103", 
        "error_msg": "The image size does not meet the requirements." 
    }

状态码

状态码请参见状态码

分享:

    相关文档

    相关产品

文档是否有解决您的问题?

提交成功!

非常感谢您的反馈,我们会继续努力做到更好!

反馈提交失败,请稍后再试!

*必选

请至少选择或填写一项反馈信息

字符长度不能超过200

提交反馈 取消

如您有其它疑问,您也可以通过华为云社区问答频道来与我们联系探讨

跳转到云社区