港澳台居住证识别V2

---

接口描述

用于第三方系统上传港澳台居住证正面照片，平台对港澳台居住证进行识别，并返回港澳台居住证识别的相关信息.

请求说明

HTTP 方法:

POST

请求 URL：

/ai-cloud-face/ocr/v2/residentCard

Header如下：

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

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

请求参数：

参数名称	必填	数据类型	长度	参数描述
img	是	String	1-3000k	待处理图片(base64 编码)，原始图片大小需要小于 3M;
busFlowId	否	String	0-64	业务流水号，业务系统唯一序列号（对账用，建议传入）
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（建议保存）
-cardno	String	1-32	证件号码
-no	String	1-32	通行证号码
-name	String	1-32	姓名
-authority	String	1-32	签发机关
-birthday	String	1-16	出生日期
-sex	String	1-4	性别
-validdate1	String	1-16	有效期起始日期
-validdate2	String	1-16	有效期截止日期
-address	String	1-32	签发地点
-type	String	1-8	传入的身份证图片类型（1人像面、0通行证背面、2 两面均有）
-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	-	表示定位位置的长方形的高度

返回示例：

{
    "code": "00000000",
    "message": "请求成功",
    "data": {
        "flowId":"xxxxxxxxx",
        "busFlowId":"xxxxxxxxxxxxxxxxx",
        "cardno": "830000199201300022",
        "name": "xx",
        "birthday": "1992年01月30日",
        "sex": "女",
        "authority": "xxx",
        "validdate1": "20060525-20060525",
        "validdate2": "20060525",
        "address": "北京市西城区复兴门外大街999号院11号楼3单元502室",
        "no": "xxx",
        "type": "0",
        "flowId": 20230410115212
    }
}

错误码

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

码值	是否成功	是否计费	描述
00000000	是	是	成功
50028100	否	否	图片不能为空
50028103	否	否	图片大小不能超过3M
50028285	否	否	港澳台居住证识别异常
50028241	否	否	引擎检测异常
50028242	否	否	引擎检测异常
50028243	否	否	引擎检测异常