RecognizeHousehold

请求参数

返回数据

示例

请求示例

http(s)://ocr-api.cn-hangzhou.aliyuncs.com/?Action=RecognizeHousehold
&Url=https://img.alicdn.com/tfs/TB11ZxTMxD1gK0jSZFsXXbldVXa-920-606.png
&IsResidentPage=false
&公共请求参数

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<RecognizeHouseholdResponse>
    <RequestId>43A29C77-405E-4CC0-BC55-EE694AD00655</RequestId>
    <Data>{"angle": 0, "data": {"sectionNo": "4401030023005", "householdType": "居民户口家庭户", "householderName": "张无忌", "householderCommunity": "", "householdNumber": "000028901", "address": "广东省广州市荔湾区芳村大道中350号", "Registrar": "罗敏", "issueDate": "2012年04月17日"}, "ftype": 0, "height": 606, "orgHeight": 606, "orgWidth": 920, "prism_keyValueInfo": [{"key": "sectionNo", "keyProb": 100, "value": "4401030023005", "valuePos": [{"x": 106, "y": 5}, {"x": 289, "y": 4}, {"x": 289, "y": 28}, {"x": 107, "y": 30}], "valueProb": 100}, {"key": "householdType", "keyProb": 100, "value": "居民户口家庭户", "valuePos": [{"x": 137, "y": 46}, {"x": 317, "y": 43}, {"x": 317, "y": 73}, {"x": 138, "y": 76}], "valueProb": 100}, {"key": "householderName", "keyProb": 100, "value": "张无忌", "valuePos": [{"x": 523, "y": 48}, {"x": 523, "y": 74}, {"x": 457, "y": 74}, {"x": 457, "y": 48}], "valueProb": 100}, {"key": "householderCommunity", "keyProb": 100, "value": "", "valueProb": 100}, {"key": "householdNumber", "keyProb": 100, "value": "000028901", "valuePos": [{"x": 225, "y": 108}, {"x": 225, "y": 126}, {"x": 145, "y": 126}, {"x": 145, "y": 108}], "valueProb": 100}, {"key": "address", "keyProb": 100, "value": "广东省广州市荔湾区芳村大道中350号", "valuePos": [{"x": 379, "y": 88}, {"x": 807, "y": 84}, {"x": 807, "y": 114}, {"x": 379, "y": 119}], "valueProb": 100}, {"key": "Registrar", "keyProb": 100, "value": "罗敏", "valuePos": [{"x": 332, "y": 499}, {"x": 332, "y": 529}, {"x": 279, "y": 529}, {"x": 279, "y": 499}], "valueProb": 100}, {"key": "issueDate", "keyProb": 100, "value": "2012年04月17日", "valuePos": [{"x": 738, "y": 497}, {"x": 738, "y": 538}, {"x": 462, "y": 538}, {"x": 462, "y": 497}], "valueProb": 100}], "sliceRect": {"x0": 1, "y0": 7, "x1": 918, "y1": 4, "x2": 920, "y2": 600, "x3": 5, "y3": 606}, "width": 920}</Data>
</RecognizeHouseholdResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "RequestId" : "43A29C77-405E-4CC0-BC55-EE694AD00655",
  "Data" : "{\"angle\": 0, \"data\": {\"sectionNo\": \"4401030023005\", \"householdType\": \"居民户口家庭户\", \"householderName\": \"张无忌\", \"householderCommunity\": \"\", \"householdNumber\": \"000028901\", \"address\": \"广东省广州市荔湾区芳村大道中350号\", \"Registrar\": \"罗敏\", \"issueDate\": \"2012年04月17日\"}, \"ftype\": 0, \"height\": 606, \"orgHeight\": 606, \"orgWidth\": 920, \"prism_keyValueInfo\": [{\"key\": \"sectionNo\", \"keyProb\": 100, \"value\": \"4401030023005\", \"valuePos\": [{\"x\": 106, \"y\": 5}, {\"x\": 289, \"y\": 4}, {\"x\": 289, \"y\": 28}, {\"x\": 107, \"y\": 30}], \"valueProb\": 100}, {\"key\": \"householdType\", \"keyProb\": 100, \"value\": \"居民户口家庭户\", \"valuePos\": [{\"x\": 137, \"y\": 46}, {\"x\": 317, \"y\": 43}, {\"x\": 317, \"y\": 73}, {\"x\": 138, \"y\": 76}], \"valueProb\": 100}, {\"key\": \"householderName\", \"keyProb\": 100, \"value\": \"张无忌\", \"valuePos\": [{\"x\": 523, \"y\": 48}, {\"x\": 523, \"y\": 74}, {\"x\": 457, \"y\": 74}, {\"x\": 457, \"y\": 48}], \"valueProb\": 100}, {\"key\": \"householderCommunity\", \"keyProb\": 100, \"value\": \"\", \"valueProb\": 100}, {\"key\": \"householdNumber\", \"keyProb\": 100, \"value\": \"000028901\", \"valuePos\": [{\"x\": 225, \"y\": 108}, {\"x\": 225, \"y\": 126}, {\"x\": 145, \"y\": 126}, {\"x\": 145, \"y\": 108}], \"valueProb\": 100}, {\"key\": \"address\", \"keyProb\": 100, \"value\": \"广东省广州市荔湾区芳村大道中350号\", \"valuePos\": [{\"x\": 379, \"y\": 88}, {\"x\": 807, \"y\": 84}, {\"x\": 807, \"y\": 114}, {\"x\": 379, \"y\": 119}], \"valueProb\": 100}, {\"key\": \"Registrar\", \"keyProb\": 100, \"value\": \"罗敏\", \"valuePos\": [{\"x\": 332, \"y\": 499}, {\"x\": 332, \"y\": 529}, {\"x\": 279, \"y\": 529}, {\"x\": 279, \"y\": 499}], \"valueProb\": 100}, {\"key\": \"issueDate\", \"keyProb\": 100, \"value\": \"2012年04月17日\", \"valuePos\": [{\"x\": 738, \"y\": 497}, {\"x\": 738, \"y\": 538}, {\"x\": 462, \"y\": 538}, {\"x\": 462, \"y\": 497}], \"valueProb\": 100}], \"sliceRect\": {\"x0\": 1, \"y0\": 7, \"x1\": 918, \"y1\": 4, \"x2\": 920, \"y2\": 600, \"x3\": 5, \"y3\": 606}, \"width\": 920}"
}

示例

请求示例

http(s)://ocr-api.cn-hangzhou.aliyuncs.com/?Action=RecognizeHousehold
&Url=https://img.alicdn.com/tfs/TB11ZxTMxD1gK0jSZFsXXbldVXa-920-606.png
&IsResidentPage=true
&公共请求参数

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<RecognizeHouseholdResponse>
    <RequestId>43A29C77-405E-4CC0-BC55-EE694AD00655</RequestId>
    <Data>{"angle": 0, "data": {"householdNumber": "", "name": "赵敏", "relation": "女", "formerName": "", "sex": "女性", "birthPlace": "广东省广州市", "ethnicity": "汉族", "nativePlace": "广东省佛山市三水区", "birthDate": "2007年7月14日", "otherResidence": "", "religious": "无宗教信仰", "idCardNumber": "440321200707143458", "stature": "", "bloodGroup": "B型", "educationalDegree": "", "maritalStatus": "", "militaryServiceStatus": "未服兵役", "employer": "", "occupation": "", "immigratedToCityInfo": "2008年10月07日广东省佛山市三水区西南街道沙头居委会广海大道东4号", "immigratedToResidenceInfo": "2010年08月27日广东省广州市黄埔区大沙北路", "registrar": "林雪芳", "registrationDate": "2010827"}, "ftype": 0, "height": 981, "orgHeight": 981, "orgWidth": 1276, "prism_keyValueInfo": [{"key": "householdNumber", "keyProb": 100, "value": "", "valueProb": 100}, {"key": "name", "keyProb": 100, "value": "赵敏", "valuePos": [{"x": 389, "y": 139}, {"x": 389, "y": 175}, {"x": 324, "y": 175}, {"x": 324, "y": 139}], "valueProb": 100}, {"key": "relation", "keyProb": 100, "value": "女", "valuePos": [{"x": 1022, "y": 157}, {"x": 1022, "y": 196}, {"x": 984, "y": 196}, {"x": 984, "y": 157}], "valueProb": 100}, {"key": "formerName", "keyProb": 100, "value": "", "valueProb": 100}, {"key": "sex", "keyProb": 100, "value": "女性", "valuePos": [{"x": 1057, "y": 237}, {"x": 1057, "y": 276}, {"x": 983, "y": 276}, {"x": 983, "y": 237}], "valueProb": 100}, {"key": "birthPlace", "keyProb": 100, "value": "广东省广州市", "valuePos": [{"x": 306, "y": 313}, {"x": 307, "y": 272}, {"x": 510, "y": 278}, {"x": 509, "y": 319}], "valueProb": 100}, {"key": "ethnicity", "keyProb": 100, "value": "汉族", "valuePos": [{"x": 977, "y": 343}, {"x": 978, "y": 305}, {"x": 1054, "y": 307}, {"x": 1053, "y": 345}], "valueProb": 100}, {"key": "nativePlace", "keyProb": 100, "value": "广东省佛山市三水区", "valuePos": [{"x": 303, "y": 378}, {"x": 305, "y": 340}, {"x": 607, "y": 348}, {"x": 606, "y": 387}], "valueProb": 100}, {"key": "birthDate", "keyProb": 100, "value": "2007年7月14日", "valuePos": [{"x": 973, "y": 408}, {"x": 975, "y": 372}, {"x": 1226, "y": 380}, {"x": 1225, "y": 416}], "valueProb": 100}, {"key": "otherResidence", "keyProb": 100, "value": "", "valueProb": 100}, {"key": "religious", "keyProb": 100, "value": "无宗教信仰", "valuePos": [{"x": 1039, "y": 476}, {"x": 1041, "y": 437}, {"x": 1219, "y": 442}, {"x": 1218, "y": 482}], "valueProb": 100}, {"key": "idCardNumber", "keyProb": 100, "value": "440321200707143458", "valuePos": [{"x": 563, "y": 506}, {"x": 563, "y": 535}, {"x": 304, "y": 537}, {"x": 303, "y": 509}], "valueProb": 100}, {"key": "stature", "keyProb": 100, "value": "", "valueProb": 100}, {"key": "bloodGroup", "keyProb": 100, "value": "B型", "valuePos": [{"x": 1206, "y": 536}, {"x": 1206, "y": 573}, {"x": 1144, "y": 573}, {"x": 1144, "y": 536}], "valueProb": 100}, {"key": "educationalDegree", "keyProb": 100, "value": "", "valueProb": 100}, {"key": "maritalStatus", "keyProb": 100, "value": "", "valueProb": 100}, {"key": "militaryServiceStatus", "keyProb": 97, "value": "未服兵役", "valuePos": [{"x": 1037, "y": 636}, {"x": 1039, "y": 595}, {"x": 1183, "y": 601}, {"x": 1181, "y": 642}], "valueProb": 97}, {"key": "employer", "keyProb": 100, "value": "", "valueProb": 100}, {"key": "occupation", "keyProb": 100, "value": "", "valueProb": 100}, {"key": "immigratedToCityInfo", "keyProb": 100, "value": "2008年10月07日广东省佛山市三水区西南街道沙头居委会广海大道东4号", "valuePos": [{"x": 373, "y": 758}, {"x": 376, "y": 687}, {"x": 1200, "y": 722}, {"x": 1197, "y": 793}], "valueProb": 100}, {"key": "immigratedToResidenceInfo", "keyProb": 100, "value": "2010年08月27日广东省广州市黄埔区大沙北路", "valuePos": [{"x": 365, "y": 820}, {"x": 366, "y": 786}, {"x": 920, "y": 814}, {"x": 918, "y": 847}], "valueProb": 100}, {"key": "registrar", "keyProb": 100, "value": "林雪芳", "valuePos": [{"x": 281, "y": 884}, {"x": 282, "y": 845}, {"x": 386, "y": 849}, {"x": 384, "y": 889}], "valueProb": 100}, {"key": "registrationDate", "keyProb": 100, "value": "2010827", "valuePos": [{"x": 937, "y": 913}, {"x": 939, "y": 883}, {"x": 1200, "y": 900}, {"x": 1198, "y": 930}], "valueProb": 100}], "sliceRect": {"x0": 0, "y0": 0, "x1": 1272, "y1": 22, "x2": 1270, "y2": 981, "x3": 0, "y3": 936}, "width": 1276}</Data>
</RecognizeHouseholdResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "RequestId" : "43A29C77-405E-4CC0-BC55-EE694AD00655",
  "Data" : "{\"angle\": 0, \"data\": {\"householdNumber\": \"\", \"name\": \"赵敏\", \"relation\": \"女\", \"formerName\": \"\", \"sex\": \"女性\", \"birthPlace\": \"广东省广州市\", \"ethnicity\": \"汉族\", \"nativePlace\": \"广东省佛山市三水区\", \"birthDate\": \"2007年7月14日\", \"otherResidence\": \"\", \"religious\": \"无宗教信仰\", \"idCardNumber\": \"440321200707143458\", \"stature\": \"\", \"bloodGroup\": \"B型\", \"educationalDegree\": \"\", \"maritalStatus\": \"\", \"militaryServiceStatus\": \"未服兵役\", \"employer\": \"\", \"occupation\": \"\", \"immigratedToCityInfo\": \"2008年10月07日广东省佛山市三水区西南街道沙头居委会广海大道东4号\", \"immigratedToResidenceInfo\": \"2010年08月27日广东省广州市黄埔区大沙北路\", \"registrar\": \"林雪芳\", \"registrationDate\": \"2010827\"}, \"ftype\": 0, \"height\": 981, \"orgHeight\": 981, \"orgWidth\": 1276, \"prism_keyValueInfo\": [{\"key\": \"householdNumber\", \"keyProb\": 100, \"value\": \"\", \"valueProb\": 100}, {\"key\": \"name\", \"keyProb\": 100, \"value\": \"赵敏\", \"valuePos\": [{\"x\": 389, \"y\": 139}, {\"x\": 389, \"y\": 175}, {\"x\": 324, \"y\": 175}, {\"x\": 324, \"y\": 139}], \"valueProb\": 100}, {\"key\": \"relation\", \"keyProb\": 100, \"value\": \"女\", \"valuePos\": [{\"x\": 1022, \"y\": 157}, {\"x\": 1022, \"y\": 196}, {\"x\": 984, \"y\": 196}, {\"x\": 984, \"y\": 157}], \"valueProb\": 100}, {\"key\": \"formerName\", \"keyProb\": 100, \"value\": \"\", \"valueProb\": 100}, {\"key\": \"sex\", \"keyProb\": 100, \"value\": \"女性\", \"valuePos\": [{\"x\": 1057, \"y\": 237}, {\"x\": 1057, \"y\": 276}, {\"x\": 983, \"y\": 276}, {\"x\": 983, \"y\": 237}], \"valueProb\": 100}, {\"key\": \"birthPlace\", \"keyProb\": 100, \"value\": \"广东省广州市\", \"valuePos\": [{\"x\": 306, \"y\": 313}, {\"x\": 307, \"y\": 272}, {\"x\": 510, \"y\": 278}, {\"x\": 509, \"y\": 319}], \"valueProb\": 100}, {\"key\": \"ethnicity\", \"keyProb\": 100, \"value\": \"汉族\", \"valuePos\": [{\"x\": 977, \"y\": 343}, {\"x\": 978, \"y\": 305}, {\"x\": 1054, \"y\": 307}, {\"x\": 1053, \"y\": 345}], \"valueProb\": 100}, {\"key\": \"nativePlace\", \"keyProb\": 100, \"value\": \"广东省佛山市三水区\", \"valuePos\": [{\"x\": 303, \"y\": 378}, {\"x\": 305, \"y\": 340}, {\"x\": 607, \"y\": 348}, {\"x\": 606, \"y\": 387}], \"valueProb\": 100}, {\"key\": \"birthDate\", \"keyProb\": 100, \"value\": \"2007年7月14日\", \"valuePos\": [{\"x\": 973, \"y\": 408}, {\"x\": 975, \"y\": 372}, {\"x\": 1226, \"y\": 380}, {\"x\": 1225, \"y\": 416}], \"valueProb\": 100}, {\"key\": \"otherResidence\", \"keyProb\": 100, \"value\": \"\", \"valueProb\": 100}, {\"key\": \"religious\", \"keyProb\": 100, \"value\": \"无宗教信仰\", \"valuePos\": [{\"x\": 1039, \"y\": 476}, {\"x\": 1041, \"y\": 437}, {\"x\": 1219, \"y\": 442}, {\"x\": 1218, \"y\": 482}], \"valueProb\": 100}, {\"key\": \"idCardNumber\", \"keyProb\": 100, \"value\": \"440321200707143458\", \"valuePos\": [{\"x\": 563, \"y\": 506}, {\"x\": 563, \"y\": 535}, {\"x\": 304, \"y\": 537}, {\"x\": 303, \"y\": 509}], \"valueProb\": 100}, {\"key\": \"stature\", \"keyProb\": 100, \"value\": \"\", \"valueProb\": 100}, {\"key\": \"bloodGroup\", \"keyProb\": 100, \"value\": \"B型\", \"valuePos\": [{\"x\": 1206, \"y\": 536}, {\"x\": 1206, \"y\": 573}, {\"x\": 1144, \"y\": 573}, {\"x\": 1144, \"y\": 536}], \"valueProb\": 100}, {\"key\": \"educationalDegree\", \"keyProb\": 100, \"value\": \"\", \"valueProb\": 100}, {\"key\": \"maritalStatus\", \"keyProb\": 100, \"value\": \"\", \"valueProb\": 100}, {\"key\": \"militaryServiceStatus\", \"keyProb\": 97, \"value\": \"未服兵役\", \"valuePos\": [{\"x\": 1037, \"y\": 636}, {\"x\": 1039, \"y\": 595}, {\"x\": 1183, \"y\": 601}, {\"x\": 1181, \"y\": 642}], \"valueProb\": 97}, {\"key\": \"employer\", \"keyProb\": 100, \"value\": \"\", \"valueProb\": 100}, {\"key\": \"occupation\", \"keyProb\": 100, \"value\": \"\", \"valueProb\": 100}, {\"key\": \"immigratedToCityInfo\", \"keyProb\": 100, \"value\": \"2008年10月07日广东省佛山市三水区西南街道沙头居委会广海大道东4号\", \"valuePos\": [{\"x\": 373, \"y\": 758}, {\"x\": 376, \"y\": 687}, {\"x\": 1200, \"y\": 722}, {\"x\": 1197, \"y\": 793}], \"valueProb\": 100}, {\"key\": \"immigratedToResidenceInfo\", \"keyProb\": 100, \"value\": \"2010年08月27日广东省广州市黄埔区大沙北路\", \"valuePos\": [{\"x\": 365, \"y\": 820}, {\"x\": 366, \"y\": 786}, {\"x\": 920, \"y\": 814}, {\"x\": 918, \"y\": 847}], \"valueProb\": 100}, {\"key\": \"registrar\", \"keyProb\": 100, \"value\": \"林雪芳\", \"valuePos\": [{\"x\": 281, \"y\": 884}, {\"x\": 282, \"y\": 845}, {\"x\": 386, \"y\": 849}, {\"x\": 384, \"y\": 889}], \"valueProb\": 100}, {\"key\": \"registrationDate\", \"keyProb\": 100, \"value\": \"2010827\", \"valuePos\": [{\"x\": 937, \"y\": 913}, {\"x\": 939, \"y\": 883}, {\"x\": 1200, \"y\": 900}, {\"x\": 1198, \"y\": 930}], \"valueProb\": 100}], \"sliceRect\": {\"x0\": 0, \"y0\": 0, \"x1\": 1272, \"y1\": 22, \"x2\": 1270, \"y2\": 981, \"x3\": 0, \"y3\": 936}, \"width\": 1276}"
}

返回示例补充说明

返回字段说明
angle    图片的角度，0表示正向，90表示图片朝右，180朝下，270朝左
ftype    是否是复印件(1:是，0:否)
--------------------------户口本首页 字段说明--------------------------
sectionNo    地段号
householdType    户别
householderName    户主姓名
householderCommunity    户主社区
householdNumber    户号
address    住址
Registrar    承办人签章
issueDate    签发日期
--------------------------户口本常住人口页 字段说明--------------------------
householdNumber    户号
name    姓名
relation    与户主关系
formerName    曾用名
sex    性别
birthPlace    出生地
ethnicity    民族
nativePlace    籍贯
birthDate    出生日期
otherResidence    本市其他住址
religious    宗教信仰
idCardNumber    身份证编号
stature    身高
bloodGroup    血型
educationalDegree    文化程度
maritalStatus    婚姻状况
militaryServiceStatus    兵役状况
employer    服务处所
occupation    职业
immigratedToCityInfo    何时何地迁来本市
immigratedToResidenceInfo    何时由何地迁来本址
registrar    承办人签章
registrationDate    登记日期
--------------------------prism_keyValueInfo数组内字段说明--------------------------
key    识别出的字段名称
keyProb    字段名称置信度
value    识别出的字段名称对应的值
valueProb    字段名称对应值的置信度
valuePos    字段在原图中的四个点坐标（左上、右上、右下、左下）

错误码

访问错误中心查看更多错误码。

SDK调用

通过SDK调用此接口的示例请参考开发者中心