户口本识别V2

---

接口描述

支持对户口本内常住人口登记卡的全部 22 个字段，包括户号、姓名、与户主关系、性别、出生地、民族、出生日期、身份证号、本市县其他住址、曾用名、籍贯、宗教信仰、身高、血型、文化程度、婚姻状况、兵役状况、服务处所、职业、何时由何地迁往本市、何时由何地迁往本址、登记日期。

支持对户口本内户主页的5个字段进行结构化识别，包括户别、户主姓名、户号、住址、户主页时间。

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

请求说明

HTTP 方法:

POST

请求 URL V2(建议使用)：

/ai-cloud-face/ocr/v2/householdRegister

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-否
pageType	否	String	0-64	页面类型，0:户主页/首页（识别户主页时必传），1：成员页，默认为成员页

请求示例：

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

返回说明

返回参数：

返回值名称	数据类型	长度	描述
code	String	1-8	返回结果，00000000表示成功
message	String	1-255	返回码描述
data	Object	-	返回的数据
-flowId	String	1-64	交易流水ID（建议保存）
-busFlowId	String	1-64	传入的业务流水号
-name	String	1-32	姓名
-relationship	String	1-255	户主或与户主关系
-sex	String	1-4	性别
-birthAddress	String	1-128	出生地
-nation	String	1-32	民族
-birthday	String	1-16	生日
-cardNo	String	1-32	身份证号
-householdNum	String	1-64	户号
-householdType	String	1-32	户别（户主页才有）
-householderName	String	1-32	户主姓名（户主页才有）
-address	String	1-255	住址（户主页才有）
-issueDate	String	1-16	签发日期（户主页才有）
-formerName	String	1-32	曾用名
-hometown	String	1-128	籍贯
-otherAddress	String	1-255	本市（县）其他住址
-belief	String	1-32	宗教信仰
-height	String	1-16	身高
-bloodType	String	1-8	血型
-education	String	1-32	文化程度
-maritalStatus	String	1-16	婚姻状况
-veteranStatus	String	1-32	兵役状况
-workAddress	String	1-255	服务处所
-career	String	1-64	职业
-wwToCity	String	1-255	何时由何地迁来本市(县)
-wwHere	String	1-255	何时由何地迁往本址
-date	String	1-16	登记日期
-details	Object[]	1-16	字段详情信息，getDetail为0时返回该字段
--key	String	1-16	字段信息名称
--name	String	1-16	字段信息中文名称
--value	String	1-16	字段识别结果

返回示例：

{
    "code": "00000000",
    "message": "success",
    "success": true,
    "data": {
        "flowId": "1008375977018925056",
        "busFlowId": "uRVJfd594lRwz7m3",
        "name": "张三",
        "relationship": "户主",
        "sex": "男",
        "birthAddress": "xx省xx市xx县",
        "nation": "汉",
        "birthday": "1990年05月20日",
        "cardNo": "110101199005201234",
        "householdNum": "1234567890",
        "householdType": "农业家庭户",
        "householderName": "张三",
        "address": "xx省xx市xx区xx街道xx号",
        "issueDate": "2020年01月01日",
        "formerName": "",
        "hometown": "xx省xx市",
        "otherAddress": "",
        "belief": "",
        "height": "175",
        "bloodType": "A",
        "education": "大学本科",
        "maritalStatus": "已婚",
        "veteranStatus": "未服兵役",
        "workAddress": "xx公司",
        "career": "工程师",
        "wwToCity": "",
        "wwHere": "1990年05月20日由xx省xx市迁入",
        "date": "1990年05月20日",
        "details": [
            {
                "key": "name",
                "name": "姓名",
                "value": "张三"
            }
        ]
    }
}

错误码

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

码值	是否成功	是否计费	描述
00000000	是	是	成功
50028100	否	否	图片不能为空
50028103	否	否	图片大小不能超过3M
50028281	否	否	户口本识别异常
50028229	否	否	引擎检测异常
80003002	否	否	识别异常