有奖捉虫:办公协同&微信生态&物联网文档专题 HOT

1. 接口描述

接口请求域名: ocr.tencentcloudapi.com 。

本接口支持居民户口簿户主页及成员页关键字段的识别,包括姓名、户别、地址、籍贯、身份证号码等。

默认接口请求频率限制:5次/秒。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:ResidenceBookletOCR。
Version String 公共参数,本接口取值:2018-11-19。
Region String 公共参数,详见产品支持的 地域列表,本接口仅支持其中的: ap-beijing, ap-guangzhou, ap-hongkong, ap-shanghai, na-toronto 。
ImageBase64 String 图片的 Base64 值。
支持的图片格式:PNG、JPG、JPEG,暂不支持 GIF 格式。
支持的图片大小:所下载图片经Base64编码后不超过 7M。图片下载时间不超过 3 秒。
图片的 ImageUrl、ImageBase64 必须提供一个,如果都提供,只使用 ImageUrl。
ImageUrl String 图片的 Url 地址。
支持的图片格式:PNG、JPG、JPEG,暂不支持 GIF 格式。
支持的图片大小:所下载图片经 Base64 编码后不超过 7M。图片下载时间不超过 3 秒。
图片存储于腾讯云的 Url 可保障更高的下载速度和稳定性,建议图片存储于腾讯云。
非腾讯云存储的 Url 速度和稳定性可能受一定影响。
示例值:https://xx/a.jpg

3. 输出参数

参数名称 类型 描述
HouseholdNumber String 户号
示例值:000006498
Name String 姓名
示例值:喻玺
Sex String 性别
示例值:男
BirthPlace String 出生地
示例值:四川省合江县
Nation String 民族
示例值:汉族
NativePlace String 籍贯
示例值:四川省合江县
BirthDate String 出生日期
示例值:1980年1月11日
IdCardNumber String 公民身份证件编号
示例值:510522198001110255
EducationDegree String 文化程度
示例值:高中毕业
ServicePlace String 服务处所
示例值:合江镇
Household String 户别
示例值:家庭户
Address String 住址
示例值:上海市徐汇区田林路397号腾云大厦
Signature String 承办人签章文字
IssueDate String 签发日期
HomePageNumber String 户主页编号
HouseholderName String 户主姓名
Relationship String 户主或与户主关系
OtherAddresses String 本市(县)其他住址
ReligiousBelief String 宗教信仰
Height String 身高
BloodType String 血型
MaritalStatus String 婚姻状况
VeteranStatus String 兵役状况
Profession String 职业
MoveToCityInformation String 何时由何地迁来本市(县)
MoveToSiteInformation String 何时由何地迁来本址
RegistrationDate String 登记日期
FormerName String 曾用名
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 户口本识别示例代码

居民户口簿户主页及成员页关键字段的识别,包括姓名、户别、地址、籍贯、身份证号码等

输入示例

https://ocr.tencentcloudapi.com/?Action=ResidenceBookletOCR &ImageUrl=https://xx/a.jpg &<公共请求参数>

输出示例

{
    "Response": {
        "Address": "",
        "BirthDate": "1999年09月19日",
        "BirthPlace": "上海市",
        "BloodType": "",
        "EducationDegree": "小学",
        "FormerName": "李新星",
        "Height": "",
        "HomePageNumber": "",
        "Household": "",
        "HouseholdNumber": "",
        "HouseholderName": "",
        "IdCardNumber": "310110199909192329",
        "IssueDate": "",
        "MaritalStatus": "未婚",
        "MoveToCityInformation": "",
        "MoveToSiteInformation": "",
        "Name": "李晨曦",
        "Nation": "汉",
        "NativePlace": "江苏省江阴市",
        "OtherAddresses": "",
        "Profession": "",
        "RegistrationDate": "2010年07月13日",
        "Relationship": "子",
        "ReligiousBelief": "",
        "RequestId": "037d6b99-6ca4-401a-a537-fe5e16f1d777",
        "ServicePlace": "丰镇小学",
        "Sex": "男",
        "Signature": "",
        "VeteranStatus": ""
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码

错误码 描述
FailedOperation.DownLoadError 文件下载失败。
FailedOperation.EmptyImageError 图片内容为空。
FailedOperation.ImageDecodeFailed 图片解码失败。
FailedOperation.ImageNoText 图片中未检测到文本。
FailedOperation.LanguageNotSupport 输入的Language不支持。
FailedOperation.OcrFailed OCR识别失败。
FailedOperation.UnKnowError 未知错误。
FailedOperation.UnOpenError 服务未开通。
InvalidParameterValue.InvalidParameterValueLimit 参数值错误。
LimitExceeded.TooLargeFileError 文件内容太大。
ResourceUnavailable.InArrears 帐号已欠费。
ResourceUnavailable.ResourcePackageRunOut 账号资源包耗尽。
ResourcesSoldOut.ChargeStatusException 计费状态异常。