1. 接口描述
接口请求域名： ocr.tencentcloudapi.com 。
外国人永久居留身份证识别
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：RecognizeForeignPermanentResidentIdCard。 |
| Version | 是 | String | 公共参数，本接口取值：2018-11-19。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表，本接口仅支持其中的: ap-beijing, ap-guangzhou, ap-hongkong, ap-shanghai 。 |
| ImageUrl | 否 | String | 图片的 Url 地址。 支持的图片格式：PNG、JPG、JPEG，暂不支持 GIF 格式。 支持的图片大小：所下载图片经 Base64 编码后不超过 7M。图片下载时间不超过 3 秒。 支持的图片像素：需介于20-10000px之间。 图片存储于腾讯云的 Url 可保障更高的下载速度和稳定性，建议图片存储于腾讯云。 非腾讯云存储的 Url 速度和稳定性可能受一定影响。 示例值：https://ocr-demo-1254418846.cos.ap-guangzhou.myqcloud.com/docume 示例值：https://xx/a.jpg |
| ImageBase64 | 否 | String | 图片的 Base64 值。 支持的图片格式：PNG、JPG、JPEG，暂不支持 GIF 格式。 支持的图片大小：所下载图片经Base64编码后不超过 7M。图片下载时间不超过 3 秒。 支持的图片像素：需介于20-10000px之间。 图片的 ImageUrl、ImageBase64 必须提供一个，如果都提供，只使用 ImageUrl。 示例值：image |
| EnablePdf | 否 | Boolean | 是否开启PDF识别，默认值为false，开启后可同时支持图片和PDF的识别。 示例值：true |
| PdfPageNumber | 否 | Integer | 需要识别的PDF页面的对应页码，传入时仅支持PDF单页识别，当上传文件为PDF且EnablePdf参数值为true时有效，默认值为1。 示例值：1 示例值：1 |
| CropPortrait | 否 | Boolean | 是否返回头像和位置坐标 示例值：false |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| CnName | String | 中文姓名。 |
| EnName | String | 英文名。 |
| Sex | String | 性别。 示例值：男/M |
| DateOfBirth | String | 出生日期。规范格式为 XXXX年XX月XX日。 示例值：1981年08月03日 |
| Nationality | String | 国籍。 示例值：加拿大/CAN |
| PeriodOfValidity | String | 有效期限。 示例值：自2023年09月15日至2033年09月14日 |
| No | String | 证件号码。 示例值：911124198108030024 |
| PreviousNumber | String | 曾持证件号码。 示例值：PAK310080010103 |
| IssuedAuthority | String | 签发机关。 |
| PortraitImageInfo | PortraitImageInfo | 头像和坐标信息。 |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 外国人永久居留身份证识别
外国人永久居留身份证识别
输入示例
POST / HTTP/1.1
Host: ocr.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: RecognizeForeignPermanentResidentIdCard
<公共请求参数>
{
"ImageUrl": "abc",
"ImageBase64": "abc",
"EnablePdf": true,
"PdfPageNumber": 1
}输出示例
{
"Response": {
"CnName": "abc",
"EnName": "abc",
"Sex": "abc",
"DateOfBirth": "abc",
"Nationality": "abc",
"PeriodOfValidity": "abc",
"No": "abc",
"RequestId": "abc"
}
}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.OcrFailed | OCR识别失败。 |
| FailedOperation.UnKnowError | 未知错误。 |
| FailedOperation.UnOpenError | 服务未开通。 |
| InvalidParameterValue.InvalidParameterValueLimit | 参数值错误。 |
| LimitExceeded.TooLargeFileError | 文件内容太大。 |
| ResourceUnavailable.InArrears | 账号已欠费。 |
| ResourceUnavailable.ResourcePackageRunOut | 账号资源包耗尽。 |
| ResourcesSoldOut.ChargeStatusException | 计费状态异常。 |
