文档简介:
接口描述
支持对户口本内常住人口登记卡的全部 22 个字段,包括户号、姓名、与户主关系、性别、出生地、民族、出生日期、身份证号、本市县其他住址、曾用名、籍贯、宗教信仰、身高、血型、文化程度、婚姻状况、兵役状况、服务处所、职业、何时由何地迁往本市、何时由何地迁往本址、登记日期。
支持对户口本内户主页的5个字段进行结构化识别,包括户别、户主姓名、户号、住址、户主页时间。
在线调试
您可以在 示例代码中心 中调试该接口,可进行签名验证、查看在线调用的请求内容和返回结果、示例代码的自动生成。
请求说明
请求示例
HTTP 方法:POST
请求URL: https://aip.baidubce.com/rest/2.0/ocr/v1/household_register
URL参数:
参数 | 值 |
---|---|
access_token | 通过API Key和Secret Key获取的access_token,参考“Access Token获取” |
Header如下:
参数 | 值 |
---|---|
Content-Type | application/x-www-form-urlencoded |
Body中放置请求参数,参数详情如下:
请求参数
参数 | 是否必选 | 类型 | 可选值范围 | 说明 |
---|---|---|---|---|
image | 和image二选一 | string | - | 图像数据,base64编码后进行urlencode,要求base64编码和urlencode后大小不超过4M,最短边至少15px,最长边最大4096px,支持jpg/jpeg/png/bmp格式 |
url | 和image二选一 | string | - |
图片完整URL,URL长度不超过1024字节,URL对应的图片base64编码后大小不超过4M,最短边至少15px,最长边最大4096px,支持jpg/jpeg/png/bmp格式,当image字段存在时url字段失效 请注意关闭URL防盗链 |
household_register_side | 否 | string | subpage/homepage |
-subpage:默认值,常住人口登记卡(成员页) -homepage:户主页 |
请求代码示例
提示一:使用示例代码前,请记得替换其中的示例Token、图片地址或Base64信息。
提示二:部分语言依赖的类或库,请在代码注释中查看下载地址。
curl -i -k 'https://aip.baidubce.com/rest/2.0/ocr/v1/household_register?access_token=
【调用鉴权接口获取的token】' --data 'image=【图片Base64编码,需UrlEncode】
' -H 'Content-Type:application/x-www-form-urlencoded'
返回说明
返回参数
常住人口登记卡(成员页)
字段 | 是否必选 | 类型 | 说明 |
---|---|---|---|
log_id | 是 | uint64 | 唯一的log id,用于问题定位 |
words_result_num | 是 | int | 识别结果数,表示words_result的元素个数 |
words_result | 是 | object{} | 识别结果 |
+ Name | 是 | object{} | 姓名 |
++ words | 是 | string | 所属字段的具体内容,以下各字段均含有此元素 |
+ Relationship | 是 | object{} | 户主或与户主关系 |
+ Sex | 是 | object{} | 性别 |
+ BirthAddress | 是 | object{} | 出生地 |
+ Nation | 是 | object{} | 民族 |
+ Birthday | 是 | object{} | 生日 |
+ CardNo | 是 | object{} | 身份证号 |
+ HouseholdNum | 是 | object{} | 户号 |
+ FormerName | 是 | object{} | 曾用名 |
+ Hometown | 是 | object{} | 籍贯 |
+ OtherAddress | 是 | object{} | 本市(县)其他住址 |
+ Belief | 是 | object{} | 宗教信仰 |
+ Height | 是 | object{} | 身高 |
+ BloodType | 是 | object{} | 血型 |
+ Education | 是 | object{} | 文化程度 |
+ MaritalStatus | 是 | object{} | 婚姻状况 |
+ VeteranStatus | 是 | object{} | 兵役状况 |
+ WorkAddress | 是 | object{} | 服务处所 |
+ Career | 是 | object{} | 职业 |
+ WWToCity | 是 | object{} | 何时由何地迁来本市(县) |
+ WWHere | 是 | object{} | 何时由何地迁往本址 |
+ Date | 是 | object{} | 登记日期 |
户主页
字段 | 是否必选 | 类型 | 说明 |
---|---|---|---|
log_id | 是 | uint64 | 唯一的log id,用于问题定位 |
words_result_num | 是 | int | 识别结果数,表示words_result的元素个数 |
direction | 是 | int32 |
图像方向,当图像旋转时,返回该参数。 - - 1:未定义, - 0:正向, - 1:逆时针90度, - 2:逆时针180度, - 3:逆时针270度 |
words_result | 是 | object{} | 识别结果 |
+ HouseholdType | 是 | object{} | 户别 |
++ words | 是 | string | 所属字段的具体内容,以下各字段均含有此元素 |
+ HouseholderName | 是 | object{} | 户主姓名 |
+ HouseholdNum | 是 | object{} | 户号 |
+ Address | 是 | object{} | 住址 |
+ IssueDate | 是 | object{} | 签发日期 |
返回示例
{ "words_result": { "Nation": { "words": "汉族" }, "Sex": { "words": "女" }, "Birthday":
{ "words": "1994年7月27日" }, "Date": { "words": "2017年7月27日" }, "BirthAddress":
{ "words": "四川省" }, "Name": { "words": "王燕" }, "FormerName ": { "words": "王佳" },
"HouseholdNum": { "words": "000007670" }, "WWToCity": { "words": "由久居" }, "WWHere":
{ "words": "1994年07月27日因出生迁来" }, "CardNo": { "words": "112102199407273123" },
"Education": { "words": "初中毕业" }, "Relationship": { "words": "独生女" }, "Height":
{ "words": "170厘米" }, "Career": { "words": "无" }, "WorkAddress": { "words": "无" },
"Hometown": { "words": "四川省" } "OtherAddress": { "words": "四川省乐山市" } "Belief":
{ "words": "佛教" } "BloodType": { "words": "A型" } "MaritalStatus": { "words": "未婚" }
"VeteranStatus": { "words": "无" } }, "log_id": "1407164137607266304", "words_result_num": 22 }