户口簿OCR

---

接口描述

通过光学字符识别技术，对传入的户口本图片进行识别.

请求说明

HTTP 方法:

POST

请求 URL：

/ai-cloud-face/api/ocr/householdRegister

Header如下：

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

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

请求参数：

参数名称	必填	数据类型	长度	参数描述
img	是	String	1-3000k	待处理图片(base64 编码)，原始图片大小需要小于 3M;
busFlowId	否	String	0-64	业务流水号，业务系统唯一序列号（对账用，建议传入）

请求示例：

{
    "img":"/9j/4AAQSkZJRgABAQAAAQABAAD/2wBDAAIBAQ......"
}

返回说明

返回参数：

返回值名称	数据类型	长度	描述
code	int	1-8	返回结果，0表示成功
message	String	1-255	返回码描述
data	Object	-	返回的数据
-busFlowId	String	1-64	业务流水号，业务系统唯一序列号
-flowId	String	1-64	交易流水ID（建议保存）
-householdRegisterOcrRet	Object	-	户口本OCR识别结果
--relationship	OcrRet	-	户主或与户主关系
--name	OcrRet	-	姓名
--gender	OcrRet	-	性别
--nation	OcrRet	-	民族
--birthplace	OcrRet	-	出生地
--nativeplace	OcrRet	-	籍贯
--birthday	OcrRet	-	出生日期
--localhome	OcrRet	-	本县(市)其他住址
--IDnumber	OcrRet	-	身份证号
--degree	OcrRet	-	文化程度
--marriage	OcrRet	-	婚姻状况
--bloodtype	OcrRet	-	血型
--military	OcrRet	-	兵役情况
--job	OcrRet	-	职业
--stature	OcrRet	-	身高
--religion	OcrRet	-	宗教信仰
--registerday	OcrRet	-	登记日期
--usedname	OcrRet	-	曾用名
--familytype	OcrRet	-	户别
--mastername	OcrRet	-	户主姓名
--familynumber	OcrRet	-	户号
--familyloca	OcrRet	-	住址
--checktime	OcrRet	-	签发日期
--serviceplace	OcrRet	-	服务处所
--whenimmigrateaddress	OcrRet	-	何时由何地迁来本址

OcrRet对象：

返回值名称	数据类型	长度	描述
key	String	1-64	属性key
data	String	1-511	属性值
pos	OcrPos	-	识别坐标

OcrPos对象：

返回值名称	数据类型	长度	描述
p1	Point	-	坐标1
p2	Point	-	坐标2
p3	Point	-	坐标3
p4	Point	-	坐标4

Point对象：

返回值名称	数据类型	长度	描述
x	int	1-4	x坐标
y	int	1-4	y坐标

返回示例：

{
    "code": 0,
    "data": {
        "householdRegisterOcrRet": {
            "checktime": {
                "data": "2019年08月02日",
                "pos": {
                    "p1": {
                        "x": 2235,
                        "y": 2520
                    },
                    "p2": {
                        "x": 3128,
                        "y": 2520
                    },
                    "p3": {
                        "x": 3128,
                        "y": 2630
                    },
                    "p4": {
                        "x": 2235,
                        "y": 2630
                    }
                }
            },
            ......
            "mastername": {
                "data": "小红",
                "pos": {
                    "p1": {
                        "x": 2195,
                        "y": 731
                    },
                    "p2": {
                        "x": 2520,
                        "y": 731
                    },
                    "p3": {
                        "x": 2520,
                        "y": 842
                    },
                    "p4": {
                        "x": 2195,
                        "y": 842
                    }
                }
            }
        }
    },
    "success": true,
    "message": "success"
}

错误码

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

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