户口本

版本 V1.0.0

1. 接口定义

1.1 接口

URL = http://ip:port/hex/ocrapi/residence_booklet_ocr

其中 ip 为部署机器的 ip 地址，port 为对应服务器的端口

1.2 描述

户口本OCR能够结构化输出居民户口本户主页及成员页，姓名、户别、地址、籍贯、身份证号码等关键字段。可以应用于各种证件信息有效性校验场景，例如银行开户、用户注册等场景。

1.3 HTTP请求格式

1.3.1 请求参数

属性	参数名称	必选	类型	参数描述
固 定 列	image	和url二选一	String	图像base64编码后的字符串，图像需是JPG、PNG、BMP其中之一的格式
	url	和image二选一	String	图片url地址，url与image两者填一个即可，同时赋值时，则以url指定的图像作为输入
	session_id	否	String	用户自定义的唯一会话id

1.3.2 请求示例

{
  "image": 填写Base64编码后的图片数据,
  "session_id": 填写对应的session_id
}

1.3.3 返回参数

属性	参数	是否必然返回	类型	参数说明
固 定 列	errorcode	是	Int32	错误码
	errormsg	是	string	错误码消息
	session_id	否	string	相应请求的session标识符，可用于结果查询
可    变	angle	是	Float	图片旋转角度（角度制），文本的水平方向为0°；顺时针为正，逆时针为负
	item	是	string	识别出的字段名称（关键字）
	itemstring	是	string	识别出的字段名称对应的值，也就是字段item对应的字符串结果
	itemconf	是	Float	置信度
	itemcoord	是	Object	文本行在旋转纠正之后的图像中的像素坐标，表示为（左上角x, 左上角y，宽width，高height）

1.3.4 返回示例

{
 "angle": 0,
 "errormsg": "OK",
 "session_id": "",
 "errorcode": 0,
 "items": [
   {
     "itemstring": "汉族",
     "item": "民族",
     "itemconf": 0.9997889995574951,
     "itemcoord": {
       "y": 72,
       "x": 476,
       "height": 28,
       "width": 55
     }
   }
 ]
}

1.3.5 接口错误码说明

错误码	错误码消息	错误码说明
-5208	OCR_SERVER_INTERN_ERROR	服务器内部错误
-1102	SDK_IMAGE_DECODE_FAILED	图片解码失败
-1400	ERROR_OCR_TEMPLATE_NOT_MATCH	模板不匹配
-9003	GLOCR_RECOG_FAILED	识别失败