护照识别V2

---

接口描述

支持对中国大陆护照个人资料页所有15个字段进行结构化识别， 包括国家码、护照号、姓名、姓名拼音、性别、出生地点、出生日期、签发地点（不支持境外签发地）、签发日期、有效期、签发机关、护照类型、国籍。

进行接口调用前，需要获取必要的token信息，可查看登录鉴权。 该接口为加密接口，可查看签名与加密方式配置加密秘钥，并对接口内容进行加密。

请求说明

HTTP 方法:

POST

请求 URL V2(建议使用)：

/ai-cloud-face/ocr/v2/passport

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":"uRVJfd594lRwz7m3",
    "getDetail":"0",
    "getPosition":"0"
}

返回说明

返回参数：

返回值名称	数据类型	长度	描述
code	String	1-8	返回结果，00000000表示成功
message	String	1-255	返回码描述
data	Object	-	返回的数据
-flowId	String	1-64	交易流水ID（建议保存）
-busFlowId	String	1-64	传入的业务流水号
-type	String	1-32	护照类型
-countryCode	String	1-8	国家码
-dateOfBirth	String	1-16	出生日期
-placeOfBirth	String	1-128	出生地点
-dateOfExpiry	String	1-16	有效期至
-placeOfIssue	String	1-128	签发地点
-authority	String	1-64	签发机关
-sex	String	1-4	性别
-passportNo	String	1-32	护照号码
-name	String	1-64	姓名
-namePinYin	String	1-128	姓名拼音
-nationality	String	1-32	国籍
-idNumber	String	1-32	身份证号
-dateOfIssue	String	1-16	签发日期
-mrzCode1	String	1-128	MRZ代码1
-mrzCode2	String	1-128	MRZ代码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": "success",
    "success": true,
    "data": {
        "flowId": "1008375977018925056",
        "busFlowId": "uRVJfd594lRwz7m3",
        "type": "P",
        "countryCode": "CHN",
        "dateOfBirth": "1990年05月20日",
        "placeOfBirth": "北京市",
        "dateOfExpiry": "2025年05月19日",
        "placeOfIssue": "北京市",
        "authority": "公安部出入境管理局",
        "sex": "男",
        "passportNo": "E12345678",
        "name": "张三",
        "namePinYin": "ZHANG SAN",
        "nationality": "中国",
        "idNumber": "110101199005201234",
        "dateOfIssue": "2015年05月20日",
        "mrzCode1": "P<CHN张三<<ZHANG<SAN<<<<<<<<<<<<<<<<<<<<<<<",
        "mrzCode2": "E123456789CHN9005201M250519110101199005201234<<<<<<",
        "details": [
            {
                "key": "passportNo",
                "name": "护照号码",
                "value": "E12345678",
                "position": {
                    "left": 100,
                    "top": 50,
                    "width": 120,
                    "height": 20
                }
            }
        ]
    }
}

错误码

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

码值	是否成功	是否计费	描述
00000000	是	是	成功
50028100	否	否	图片不能为空
50028103	否	否	图片大小不能超过3M
50028280	否	否	护照识别异常
50028226	否	否	引擎检测异常
80003002	否	否	识别异常