1.报文协议

HTTP(S) + JSON

2.接口地址

测试环境：https://test-api-open.chinaums.com/v1/brain/ocr/household-register

生产环境：https://api-lob.open.chinaums.com/v1/brain/ocr/household-register

参数名称	参数说明	参数类型	是否必须	备注
Authorization	认证内容	字符串	是	请见认证流程章节

URL参数：无

POST参数：

格式：JSON

参数名称	参数说明	参数类型	长度	是否必须	备注
picBase64	文本	字符串		是	图片文件的BASE64编码

格式：JSON

参数名称	参数说明	参数类型	长度	是否必须	备注
data	结果	字符串
-->PageInfo	识别返回的页面信息	数组
-->PageIndex	页数信息	数字型			第一页为1，第二页为2，以此类推
-->ErrorCode	返回值	数字型			0成功，其他值失败
-->Time	识别时间	字符串
-->ResultList	返回结果数组	数组
-->pid	证件对应类型pid	数字型
-->type	证件类型	字符串
-->ocr_error_code	识别响应状态码	数字型			0代表识别成功
-->FieldList	识别返回的数据结果集	数组
-->direct	图片方向	数字型
-->angle	图片角度	数字型
-->key	英文字段名称	字符串
-->chn_key	中文字段名称	字符串
-->value	对应字段识别结果	字符串
-->score	置信度	数字型			(0-100)
-->color	color	数字型			0:未检测到1: black 2: red 3:blue
-->shape	shape	数字型			0:未检测到1:circle 2:ellipse 3:rect 4: other
-->is_image	是否为图片base64	数字型			1：是 0：不是
-->position		数组
-->left	左	数字型			位置信息
-->top	上	数字型			位置信息
-->width	宽	数字型			位置信息
-->height	高	数字型			位置信息
-->quad	四点坐标	数组			区域四个点（左上、右上、左下、右下）的坐标
errCode	返回码	字符串	20	是
errInfo	返回码说明	字符串	256	否

户口本特有字段

格式：JSON

< 上一篇：港澳台居民来往大陆通行证识别

下一篇: 结婚证识别 >