一、接口名称

户口本OCR识别接口

二、接口介绍

户口本OCR识别，精准识别户口本上的相关户籍证明信息，可自动区分户主页和常住人口登记页。

三、API接口文档

1. 请求地址 url：https://api.shumaidata.com/v4/recognize_household/ocr

请求方式 method：post

参数：

2. 签名算法说明

服务商分配的appid、当前时间毫秒数timestamp、商户分配的app_security、 三者通过&符号拼接成字符串进行md5加密得到。

 如：appid=xyzxyzxyz，timestamp=1555378976238，app_security=efcefcefcefcefc ;

 拼接后的字符串：str=xyzxyzxyz&1555378976238&efcefcefcefcefc ;

 加密后得到sign = md5(str) = 4e7e1974b79f3656aeaf03f1158f5d5d ;

3. 正确返回示例

{

    "msg": "成功",

    "success": true,

    "code": 200,

    "data": {

        "order_no": "blpwgxxgwwyc345oa2",

        "religious": "",

        "immigratedToCityInfo": "文居",

        "occupation": "000",

        "ethnicity": "汉",

        "registrar": "",

        "educationalDegree": "*学",

        "sex": "女性",

        "militaryServiceStatus": "",

        "householdNumber": "558113**",

        "birthDate": "****年9月16日",

        "relation": "户主",

        "birthPlace": "原庆市**县",

        "bloodGroup": "",

        "immigratedToResidenceInfo": "****年7月23日由重庆市云***",

        "name": "付*",

        "idCardNumber": "500235****09166943",

        "stature": "",

        "registrationDate": "",

        "nativePlace": "重庆市**县",

        "otherResidence": "",

        "employer": "集体经济组织",

        "formerName": "",

        "maritalStatus": ""

    }

}

4. 错误返回示例

{

    "msg": "入参错误",

    "success": false,

    "code": 400,

    "data": { }

}

5. 返回字段说明

结构化信息（户主页_data_字段，当 IsResidentPage 不传或传 false。）

结构化信息（常住人口页_data_字段，当IsResidentPage=true。）

更多字段说明参考户口本OCR识别产品页详情

6. Code错误码说明

四、相关接口推荐

身份证OCR识别

社保卡OCR识别

出生证明OCR识别

更多API接口调用：https://www.shumaiapi.com/product