1. 接口描述
接口请求域名： ocr.tencentcloudapi.com 。
获取ocr结果
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：GetOCRResult。 |
| Version | 是 | String | 公共参数，本接口取值：2018-11-19。 |
| Region | 否 | String | 公共参数，此参数为可选参数。 |
| OCRToken | 是 | String | token值 示例值：87756DB5-A1FB-468F-B5CC-81AEF51CAA2D |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| Type | String | ocr业务类型 示例值：IDCardOCR |
| OCRResult | OCRResult | ocr结果 |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 获取ocr结果
获取ocr结果
输入示例
POST / HTTP/1.1
Host: ocr.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: GetOCRResult
<公共请求参数>
{
"OCRToken": "754119FD-511F-4EF5-ADBC-F271AE62F908"
}输出示例
{
"Response": {
"OCRResult": {
"IDCardResult": {
"Back": {
"Authority": "上海市公安局静安分局",
"ErrorCode": "Success",
"ErrorMessage": "成功",
"RequestId": "51b411c9-7dd9-430f-8307-9435d28748b6",
"ValidDate": "2008.09.08-2028.09.08",
"WarnCodes": [
-9102,
-9101
]
},
"Front": {
"Address": "北京市海淀区知春路1号2栋3号",
"Birth": "1999/5/7",
"ErrorCode": "Success",
"ErrorMessage": "成功",
"IdNum": "110129199905070025",
"Name": "侯小珂",
"Nation": "汉",
"RequestId": "64248e56-e24b-424b-8c07-3672bd58d24b",
"Sex": "女",
"WarnCodes": [
-9102,
-9101,
-9106
]
}
}
},
"RequestId": "ff4412d0-abf0-4560-8f65-cc46b190c0eb",
"Type": "IDCardOCR"
}
}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. 错误码
该接口暂无业务逻辑相关的错误码，其他错误码详见 公共错误码。
