1. 接口描述
接口请求域名： ocr.tencentcloudapi.com 。
本接口支持中国大陆地区护照个人资料页多个字段的检测与识别。已支持字段包括英文姓名、中文姓名、国家码、护照号、出生地、出生日期、国籍英文、性别英文、有效期、签发地点英文、签发日期、持证人签名、护照机读码（MRZ码）等。
默认接口请求频率限制：10次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：PassportOCR。 |
| Version | 是 | String | 公共参数，本接口取值：2018-11-19。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表，本接口仅支持其中的: ap-beijing, ap-guangzhou, ap-hongkong, ap-shanghai, na-toronto 。 |
| ImageBase64 | 否 | String | 图片的 Base64 值。要求图片经Base64编码后不超过 7M，分辨率建议500*800以上，支持PNG、JPG、JPEG、BMP格式。建议卡片部分占据图片2/3以上。 图片的 ImageUrl、ImageBase64 必须提供一个，如果都提供，只使用 ImageUrl。 |
| ImageUrl | 否 | String | 图片的 Url 地址。要求图片经Base64编码后不超过 7M，分辨率建议500*800以上，支持PNG、JPG、JPEG、BMP格式。建议卡片部分占据图片2/3以上。 建议图片存储于腾讯云，可保障更高的下载速度和稳定性。 示例值：https://xx/a.jpg |
| Type | 否 | String | 默认填写CN 支持中国大陆地区护照。 示例值：CN |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| Country | String | 国家码 示例值：CHN |
| PassportNo | String | 护照号 示例值：G12345678 |
| Sex | String | 性别 示例值：M |
| Nationality | String | 国籍 示例值：CHN |
| BirthDate | String | 出生日期 示例值：19920922 |
| BirthPlace | String | 出生地点 示例值：SHANGHAI |
| IssueDate | String | 签发日期 示例值：20100820 |
| IssuePlace | String | 签发地点 示例值：SHANGHAI |
| ExpiryDate | String | 有效期 示例值：20200819 |
| Signature | String | 持证人签名 示例值：张三 |
| CodeSet | String | 最下方第一行 MRZ Code 序列 示例值： POCHNZHANG<<SAN<<<<<<<<<<<<<<<<<<<<<<<<<<<<< |
| CodeCrc | String | 最下方第二行 MRZ Code 序列 示例值： G123456785CHN9209220M200819219203100<<<<<<60 |
| Name | String | 姓名 示例值：张三 |
| FamilyName | String | 姓 示例值：ZHANG |
| FirstName | String | 名 示例值：SAN |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 护照识别示例代码 前往调试工具
以中国大陆地区护照为例
输入示例
POST / HTTP/1.1
Host: ocr.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: PassportOCR
<公共请求参数>
{
"ImageUrl": "https://xx/a.jpg",
"Type": "CN"
}输出示例
{
"Response": {
"Country": "CHN",
"PassportNo": "G12345678",
"Sex": "M",
"Nationality": "CHN",
"BirthDate": "19920922",
"BirthPlace": "SHANGHAI",
"IssueDate": "20100820",
"IssuePlace": "SHANGHAI",
"ExpiryDate": "20200819",
"Signature": "",
"CodeSet": "POCHNZHANG<<SAN<<<<<<<<<<<<<<<<<<<<<<<<<<<<<",
"CodeCrc": "G123456785CHN9209220M200819219203100<<<<<<60",
"Name": "张三",
"FamilyName": "ZHANG",
"FirstName": "SAN",
"RequestId": "39cce0fc-77b1-4271-82ae-9f0bf1036906"
}
}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 | 服务未开通。 |
| InvalidParameter.EngineImageDecodeFailed | 图片解码失败。 |
| InvalidParameterValue.InvalidParameterValueLimit | 参数值错误。 |
| LimitExceeded.TooLargeFileError | 文件内容太大。 |
| ResourceUnavailable.InArrears | 帐号已欠费。 |
| ResourceUnavailable.ResourcePackageRunOut | 账号资源包耗尽。 |
| ResourcesSoldOut.ChargeStatusException | 计费状态异常。 |