服务端 API 文档

户口本识别

最近更新时间:2020-07-13 08:40:30

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编码后不超过 3M。图片下载时间不超过 3 秒。
图片的 ImageUrl、ImageBase64 必须提供一个,如果都提供,只使用 ImageUrl。
ImageUrl String 图片的 Url 地址。
支持的图片格式:PNG、JPG、JPEG,暂不支持 GIF 格式。
支持的图片大小:所下载图片经 Base64 编码后不超过 3M。图片下载时间不超过 3 秒。
图片存储于腾讯云的 Url 可保障更高的下载速度和稳定性,建议图片存储于腾讯云。
非腾讯云存储的 Url 速度和稳定性可能受一定影响。

3. 输出参数

参数名称 类型 描述
HouseholdNumber String 户号
Name String 姓名
Sex String 性别
BirthPlace String 出生地
Nation String 民族
NativePlace String 籍贯
BirthDate String 出生日期
IdCardNumber String 公民身份证件编号
EducationDegree String 文化程度
ServicePlace String 服务处所
Household String 户别
Address String 住址
RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 示例

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

输入示例

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

输出示例

{
  "Response": {
    "HouseholdNumber": "000006498",
    "Name": "喻玺",
    "Sex": "男",
    "BirthPlace": "四川省合江县",
    "Nation": "汉族",
    "NativePlace": "四川省合江县",
    "BirthDate": "1980年1月11日",
    "IdCardNumber": "510522198001110255",
    "EducationDegree": "高中毕业",
    "ServicePlace": "合江镇",
    "Household": "家庭户",
    "Address": "上海市徐汇区田林路397号腾云大厦",
    "RequestId": "973edeb4-d0a1-4e6c-aa9c-fdfc7b24b357"
  }
}

5. 开发者资源

API Explorer

该工具提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力,能显著降低使用云 API 的难度,推荐使用。

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 文件内容太大。
ResourcesSoldOut.ChargeStatusException 计费状态异常。
目录