1. 接口描述
接口请求域名: ocr.tencentcloudapi.com 。
本接口支持中国香港身份证人像面中关键字段的识别,包括中文姓名、英文姓名、姓名电码、出生日期、性别、证件符号、首次签发日期、最近领用日期、身份证号、是否是永久性居民身份证;具备人像照片裁剪等扩展功能。
默认接口请求频率限制:5次/秒。
默认接口请求频率限制:5次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:HKIDCardOCR。 |
Version | 是 | String | 公共参数,本接口取值:2018-11-19。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表,本接口仅支持其中的: ap-beijing, ap-guangzhou, ap-hongkong, ap-seoul, ap-shanghai 。 |
ReturnHeadImage | 是 | Boolean | 是否返回人像照片。 示例值:false |
ImageBase64 | 否 | String | 图片的 Base64 值。 支持的图片格式:PNG、JPG、JPEG,暂不支持 GIF 格式。 支持的图片大小:所下载图片经Base64编码后不超过 7M。图片下载时间不超过 3 秒。 |
ImageUrl | 否 | String | 图片的 Url 地址。 支持的图片格式:PNG、JPG、JPEG,暂不支持 GIF 格式。 支持的图片大小:所下载图片经 Base64 编码后不超过 3M。图片下载时间不超过 3 秒。 图片存储于腾讯云的 Url 可保障更高的下载速度和稳定性,建议图片存储于腾讯云。 非腾讯云存储的 Url 速度和稳定性可能受一定影响。 示例值:https://xx/a.jpg |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
CnName | String | 中文姓名 示例值:申能 |
EnName | String | 英文姓名 示例值:SAN, Nan |
TelexCode | String | 中文姓名对应电码 示例值:300000000000 |
Sex | String | 性别 :“男M”或“女F” 示例值:女F |
Birthday | String | 出生日期 示例值:01-01-2001 |
Permanent | Integer | 永久性居民身份证。 0:非永久; 1:永久; -1:未知。 示例值:1 |
IdNum | String | 身份证号码 示例值:C000000(E) |
Symbol | String | 证件符号,出生日期下的符号,例如"AZ" 示例值:AZ |
FirstIssueDate | String | 首次签发日期 示例值:(09-99) |
CurrentIssueDate | String | 最近领用日期 示例值:23-09-10 |
HeadImage | String | 人像照片Base64后的结果 注意:此字段可能返回 null,表示取不到有效值。 |
WarnCardInfos | Array of Integer | 告警码 -9101 证件边框不完整告警 -9102 证件复印件告警 -9103 证件翻拍告警 -9104 证件PS告警 -9107 证件反光告警 -9108 证件模糊告警 -9109 告警能力未开通 示例值:[-9101] |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 中国香港身份证识别示例代码
输入示例
POST / HTTP/1.1
Host: ocr.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: HKIDCardOCR
<公共请求参数>
{
"ReturnHeadImage": "false",
"ImageUrl": "https://xx/a.jpg"
}
输出示例
{
"Response": {
"CnName": "申能",
"EnName": "SAN, Nan",
"TelexCode": "300000000000",
"Sex": "女F",
"Birthday": "01-01-2001",
"Permanent": 1,
"IdNum": "C000000(E)",
"Symbol": "***AZ",
"FirstIssueDate": "(09-99)",
"CurrentIssueDate": "23-09-10",
"HeadImage": "",
"WarnCardInfos": [
-9104
],
"RequestId": "fba1c9ad-aeb3-4418-9ecf-80ab1b5fc875"
}
}
5. 开发者资源
腾讯云 API 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。
API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。
SDK
云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python: GitHub Gitee
- Tencent Cloud SDK 3.0 for Java: GitHub Gitee
- Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
- Tencent Cloud SDK 3.0 for Go: GitHub Gitee
- Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
- Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
- Tencent Cloud SDK 3.0 for C++: GitHub Gitee
- Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
FailedOperation.DownLoadError | 文件下载失败。 |
FailedOperation.ImageDecodeFailed | 图片解码失败。 |
FailedOperation.NoHKIDCard | 非香港身份证。 |
FailedOperation.OcrFailed | OCR识别失败。 |
FailedOperation.UnKnowError | 未知错误。 |
FailedOperation.UnOpenError | 服务未开通。 |
FailedOperation.WarningServiceFailed | 通用告警服务异常 |
InvalidParameterValue.InvalidParameterValueLimit | 参数值错误。 |
LimitExceeded.TooLargeFileError | 文件内容太大。 |
ResourceUnavailable.InArrears | 帐号已欠费。 |
ResourcesSoldOut.ChargeStatusException | 计费状态异常。 |