1. 接口描述
接口请求域名： ocr.tencentcloudapi.com 。
港澳台居住证OCR支持港澳台居住证正反面全字段内容检测识别功能，包括姓名、性别、出生日期、地址、身份证号、签发机关、有效期限、签发次数、通行证号码关键字段识别。可以应用于港澳台居住证信息识别场景，例如银行开户、用户注册等。
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：HmtResidentPermitOCR。 |
| Version | 是 | String | 公共参数，本接口取值：2018-11-19。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表，本接口仅支持其中的: ap-beijing, ap-guangzhou, ap-hongkong, ap-shanghai 。 |
| 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 |
| CardSide | 否 | String | FRONT：有照片的一面（人像面）， BACK：无照片的一面（国徽面）， 该参数如果不填或填错，将为您自动判断正反面。 示例值：FRONT |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| Name | String | 证件姓名 示例值：李优优 |
| Sex | String | 性别 示例值：女 |
| Birth | String | 出生日期 示例值：1997/6/2 |
| Address | String | 地址 示例值：上海市徐汇区古美路1528号A1栋腾讯优图1号 |
| IdCardNo | String | 身份证号 示例值：830000199706020042 |
| CardType | Integer | 0-正面 1-反面 示例值：0 |
| ValidDate | String | 证件有效期限 示例值：2018.09.06-2023.09.06 |
| Authority | String | 签发机关 示例值：合肥市公安局高新分局 |
| VisaNum | String | 签发次数 示例值：0 |
| PassNo | String | 通行证号码 |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 港澳台居住证识别示例代码1
港澳台居住证识别示例代码1
输入示例
POST / HTTP/1.1
Host: ocr.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: HmtResidentPermitOCR
<公共请求参数>
{
"ImageUrl": "https://xx/a.jpg",
"CardSide": "FRONT"
}输出示例
{
"Response": {
"Name": "李优优",
"Sex": "女",
"Birth": "1997/6/2",
"Address": "上海市徐汇区古美路1528号A1栋腾讯优图1号",
"IdCardNo": "830000199706020042",
"CardType": 0,
"ValidDate": "",
"Authority": "",
"VisaNum": "0",
"PassNo": "000",
"RequestId": "f72e7048-f1e0-42f3-b0bf-f8730d48bb5c"
}
}示例2 港澳台居住证识别示例代码2
港澳台居住证识别示例代码2
输入示例
POST / HTTP/1.1
Host: ocr.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: HmtResidentPermitOCR
<公共请求参数>
{
"ImageUrl": "https://xx/a.jpg"
}输出示例
{
"Response": {
"Name": "",
"Sex": "",
"Birth": "",
"Address": "",
"IdCardNo": "",
"CardType": 1,
"ValidDate": "2018.09.06-2023.09.06",
"Authority": "合肥市公安局高新分局",
"VisaNum": "0",
"PassNo": "000",
"RequestId": "182abb0c-b0bd-403a-ab11-3dba21ae89d0"
}
}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.EmptyImageError | 图片内容为空。 |
| FailedOperation.ImageDecodeFailed | 图片解码失败。 |
| FailedOperation.ImageNoText | 图片中未检测到文本。 |
| FailedOperation.OcrFailed | OCR识别失败。 |
| FailedOperation.UnKnowError | 未知错误。 |
| FailedOperation.UnOpenError | 服务未开通。 |
| InvalidParameterValue.InvalidParameterValueLimit | 参数值错误。 |
| LimitExceeded.TooLargeFileError | 文件内容太大。 |
| ResourceUnavailable.InArrears | 账号已欠费。 |
| ResourceUnavailable.ResourcePackageRunOut | 账号资源包耗尽。 |
| ResourcesSoldOut.ChargeStatusException | 计费状态异常。 |
