港澳台通行证识别V2

---

接口描述

通过光学字符识别技术，对港澳台通行证图片进行识别.

请求说明

HTTP 方法:

POST

请求 URL：

/ai-cloud-face/ocr/v2/pass

Header如下：

参数名称	值
Content-Type	application/json;charset=UTF-8

Body中放置请求参数，参数详情如下：

请求参数：

参数名称	必填	数据类型	长度	参数描述
img	是	String	1-3000k	待处理图片(base64 编码)，原始图片大小需要小于 3M;
busFlowId	否	String	0-64	业务流水号，业务系统唯一序列号（对账用，建议传入）
type	是	String	0-64	证件类型 1-港澳通行证正面 2-港澳通行证反面 3-台湾通行证正面 4-台湾通行证反面 默认为 1
getDetail	否	String	0-64	是否返回key-value格式详情 0-是 1-否， 默认为1-否
getPosition	否	String	0-64	是否返回识别坐标信息 0-是 1-否 默认为1-否 getDetail为0-是时， 该配置才生效

请求示例：

{
    "img":"/9j/4AAQSkZJRgABAQAAAQABAAD/2wBDAAIBAQ......",
    "busFlowId":"xxxxxxxxxxxxxxxxx",
    "getDetail":"0",
    "getPosition":"0"
}

返回说明

返回参数：

返回值名称	数据类型	长度	描述
code	String	1-8	返回结果，00000000表示成功
message	String	1-255	返回码描述
data	Object	-	返回的数据
-busFlowId	String	1-64	业务流水号，业务系统唯一序列号
-flowId	String	1-64	交易流水ID（建议保存）
-birth	String	1-16	出生日期 yyyy.mm.dd
-idNumber	String	1-32	证件号码
-issuePlace	String	1-4	签发地点
-issueAuthority	String	1-32	签发机关
-nameSpelling	String	1-32	姓名拼音
-name	String	1-32	姓名
-gender	String	1-4	性别
-validdate	String	1-16	有效期
-idCode	String	1-128	证件编码
-hkCls	String	1-128	来往香港签注-种类
-hkValidDate	String	1-128	来往香港签注-有效期
-hkRemark	String	1-128	来往香港签注-备注
-macaoCls	String	1-128	来往澳门签注-种类
-macaoRemark	String	1-128	来往澳门签注-备注
-maocaoValidDate	String	1-128	来往澳门签注-有效期
-twCls	String	1-128	来往台湾签注-种类
-twRemark	String	1-128	来往台湾签注-备注
-details	Object[]	1-16	字段详情信息，getDetail为0时返回该字段
--key	String	1-16	字段信息名称
--name	String	1-16	字段信息中文名称
--value	String	1-16	字段识别结果
--position	OcrPos	1-16	字段识别坐标信息

OcrPos对象：

返回值名称	数据类型	长度	描述
left	int	1-4	表示定位位置的长方形左上顶点的水平坐标
top	int	1-4	表示定位位置的长方形左上顶点的垂直坐标
width	int	-	表示定位位置的长方形的宽度
height	int	-	表示定位位置的长方形的高度

返回示例：

{
    "message": "success",
    "code": "00000000",
    "success": true,
    "data": {
          "flowId":"xxxxxxxxx",
          "busFlowId":"xxxxxxxxxxxxxxxxx",
          "birth": "1981.08.03",
          "gender": "女",
          "idNumber": "CA3273201",
          "issueAuthority": "中华人民共和国出入境管理局",
          "name": "证件样本",
          "nameSpelling": "ZHENGJIAN,YANGBEN",
          "validdate": "2019.01.18-2029.01.17"
    }
}

错误码

以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共CODE码表

码值	是否成功	是否计费	描述
00000000	是	是	成功
50028100	否	否	图片不能为空
50028103	否	否	图片大小不能超过3M
50028284	否	否	港澳台通行证识别异常
50028238	否	否	引擎检测异常
50028239	否	否	引擎检测异常
50028240	否	否	引擎检测异常