本文档介绍户口页识别RecognizeAccountPage的语法及示例。

功能描述

RecognizeAccountPage可以对户口本常住人口登记卡进行结构化识别,输出姓名、籍贯、民族、性别、身份证号、出生地、出生日期、户主或户主关系、承办人签章、注册章位置、其他印章位置,共11个关键字段信息。

前提条件

请确保您已开通文字识别服务,详情请参见服务开通

输入限制

  • 图片格式:JPEG、JPG、PNG、BMP、GIF。
  • 图像大小:图像大小不超过3M。
  • 图像分辨率:不限制图片分辨率,但图片分辨率太高可能会导致API识别超时,超时时间为5秒。
  • URL地址中不能包含中文字符。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称 类型 是否必选 示例值 描述
Action String RecognizeAccountPage

要执行的操作。取值:RecognizeAccountPage。

ImageURL String https://viapi-demo.oss-cn-shanghai.aliyuncs.com/viapi-demo/images/DetectImageElements/xxx.png

图片URL地址。当前仅支持上海地域的OSS链接,如何生成URL请参见生成URL

返回数据

名称 类型 示例值 描述
Data Struct

返回的结果数据内容。

Angle Float 0

图片顺时针旋转角度,枚举类型:0度、90度、180度、270度。

BirthDate String 2002年12月27日

出生日期,格式:xxxx年x月x日。识别失败时返回FailInRecognition

BirthPlace String 四川省雷波县

出生地,识别失败时返回FailInRecognition

Gender String "Gender": "女",

性别,识别失败时返回FailInRecognition

IDNumber String 513437200212271325

公民身份证件编号,识别失败时返回FailInRecognition

InvalidStampAreas Array

注销或作废印章位置列表(识别失败时,则不显示该字段)。

Height Integer 10

注销或作废印章高度。

Left Integer 10

注销或作废印章左上角x坐标。

Top Integer 10

注销或作废印章左上角y坐标。

Width Integer 10

注销或作废印章宽度。

Name String 杨冬

姓名,识别失败时返回FailInRecognition

Nationality String 彝族

民族,识别失败时返回FailInRecognition

NativePlace String 四川省雷波县

籍贯,识别失败时返回FailInRecognition

OtherStampAreas Array

其他印章位置列表(识别失败时,则不显示该字段)。

Height Integer 10

其他印章高度。

Left Integer 10

其他印章左上角x坐标。

Top Integer 10

其他印章左上角y坐标。

Width Integer 10

其他印章宽度。

RegisterStampAreas Array

大圆形登记注册章位置列表(识别失败时, 则不显示该字段)。

Height Integer 138

登记注册章高度。

Left Integer 330

登记注册章左上角x坐标。

Top Integer 2215

登记注册章左上角y坐标。

Width Integer 152

登记注册章宽度。

Relation String 孙女

户主或与户主关系,识别失败时返回FailInRecognition

TitleArea Struct

标题区域位置,识别失败时返回FailInDetection

Height Integer 30

标题区域高度。

Left Integer 205

标题区域左上角x坐标。

Top Integer 17

标题区域左上角y坐标。

Width Integer 30

标题区域宽度。

UndertakeStampAreas Array

承办人签章位置列表(识别失败时,则不显示该字段)。

Height Integer 10

承办人签章高度。

Left Integer 10

承办人签章左上角x坐标。

Top Integer 10

承办人签章左上角y坐标。

Width Integer 10

承办人签章宽度。

RequestId String 8D588F22-3E14-4674-9EAE-49AE1BA10EA2

请求ID。

示例

请求示例

http(s)://ocr.cn-shanghai.aliyuncs.com/?Action=RecognizeAccountPage
&ImageURL=https://viapi-demo.oss-cn-shanghai.aliyuncs.com/viapi-demo/images/DetectImageElements/xxx.png
&<公共请求参数>

正常返回示例

XML 格式

<RequestId>8D588F22-3E14-4674-9EAE-49AE1BA10EA2</RequestId>
<Data>
    <NativePlace>四川省雷波县</NativePlace>
    <BirthPlace>四川省雷波县</BirthPlace>
    <RegisterStampAreas>
        <Left>330</Left>
        <Top>215</Top>
        <Height>138</Height>
        <Width>152</Width>
    </RegisterStampAreas>
    <Gender>女</Gender>
    <Nationality>彝族</Nationality>
    <Name>杨冬</Name>
    <Relation>孙女</Relation>
    <Angle>0</Angle>
    <TitleArea>
        <Left>205</Left>
        <Top>17</Top>
        <Height>30</Height>
        <Width>200</Width>
    </TitleArea>
    <BirthDate>2002年12月27日</BirthDate>
    <IDNumber>513437200212271325</IDNumber>
</Data>

JSON 格式

{
	"RequestId": "8D588F22-3E14-4674-9EAE-49AE1BA10EA2",
	"Data": {
		"NativePlace": "四川省雷波县",
		"BirthPlace": "四川省雷波县",
		"RegisterStampAreas": [
			{
				"Left": 330,
				"Top": 215,
				"Height": 138,
				"Width": 152
			}
		],
		"Gender": "女",
		"Nationality": "彝族",
		"Name": "杨冬",
		"Relation": "孙女",
		"Angle": 0,
		"TitleArea": {
			"Left": 205,
			"Top": 17,
			"Height": 30,
			"Width": 200
		},
		"BirthDate": "2002年12月27日",
		"IDNumber": "513437200212271325"
	}
}

错误码

关于户口页识别的错误码,详情请参见常见错误码

SDK参考

单击SDK简介查看SDK信息。