护照识别

版本 V1.0.0

1. 接口定义

1.1 接口

URL = http://ip:port/hex/ocrapi/passportocr

其中 ip 为部署机器的 ip 地址，port 为对应服务器的端口

1.2 描述

护照OCR基于业界领先的深度学习技术，支持国内国外护照多个内容检测识别功能，包括英文姓名、国籍、签发日期、性别等字段，可以应用于出入境审查、国外人员身份核验等各种需要提取护照信息的场景。

1.3 HTTP请求格式

1.3.1 请求参数

参数名称	是否必选	类型	可选值	默认值	描述
app_id	是	String	无	无	接入优图服务时生成的唯一id，用于唯一标识接入业务
image	和url二选一	String	无	无	图像base64编码后的字符串，图像需是JPG、PNG、BMP其中之一的格式
url	和image二选一	String	无	无	图片url地址，url与image两者填一个即可，同时赋值时，则以url指定的图像作为输入
session_id	否	String	无	无	用户自定义的唯一会话id
ocr_template	否	String	PassPort HK_PassPort\THAI_PassPort	PassPort	模板名称: PassPort：支持国内护照 HK_PassPort：支持香港护照 THAI_PassPort：支持泰国护照

1.3.2 请求示例

Request:
{
 "app_id": 填写对应的app_id,
 "image": 填写Base64编码后的图片数据,
 "session_id": 填写对应的session_id,
 "ocr_template": "PassPort"
}

1.3.3 返回参数

字段		是否必然返回	类型	说明
angle		是	Float	图片旋转角度（角度制），文本的水平方向为0°；顺时针为正，逆时针为负
errorcode		是	Int32	错误码
errormsg		是	String	错误码消息
session_id		否	String	相应请求的session标识符，可用于结果查询
items
	item	是	String	识别出的字段名称(关键字)，支持以下字段： Type：护照类型、Sex in English：性别(英文)、Country：签发国家、Passport No：护照编号、Date of birth：出生日期、Date of issue：发行日期、Date of expiry：到期日期、Place of issue in English：签发地点(英文)、Place of birth in English：出生地(英文)、Nationality in English：国籍(英文)、Code1：护照机读码1、Code2：护照机读码2、First Name in English：名(英文)、Family Name in English: 姓(英文)、Name:姓名
	itemstring	是	String	识别出的字段名称对应的值，也就是字段item对应的字符串结果
	itemconf	是	Float	置信度
	itemcoord	是	Object	文本行在旋转纠正之后的图像中的像素坐标，表示为（左上角x, 左上角y，宽width，高height）

1.3.4 返回示例

Response:
{
  "angle": 0,
  "errormsg": "OK",
  "errorcode": 0,
  "items": [
    {
      "itemstring": "CHN",
      "item": "Country",
      "itemconf": 0.9998999834060669,
      "itemcoord": {
        "y": 848,
        "x": 503,
        "height": 21,
        "width": 58
      }
    },
  ]
}

1.3.5 接口错误码说明

错误码	错误码消息	错误码说明
-5208	OCR_SERVER_INTERN_ERROR	服务器内部错误
-1102	SDK_IMAGE_DECODE_FAILED	图片解码失败
-1400	ERROR_OCR_TEMPLATE_NOT_MATCH	模板不匹配
-9003	GLOCR_RECOG_FAILED	OCR识别失败