1. 接口描述
接口请求域名： ocr.tencentcloudapi.com 。
支持通用证照的有效性检测告警，包括卡证复印件告警、卡证翻拍告警等功能，支持通用证照的ps伪造检测，可以应用于各种证件信息有效性校验场景。
默认接口请求频率限制：5次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：RecognizeGeneralCardWarn。 |
| Version | 是 | String | 公共参数，本接口取值：2018-11-19。 |
| Region | 否 | String | 公共参数，此参数为可选参数。 |
| ImageUrl | 否 | String | 图片链接 示例值：https://ocr-demo-1254418846.cos.ap-guangzhou.myqcloud.com/card/IDCardOCR/IDCardOCR1.jpg |
| ImageBase64 | 否 | String | 图片base64 示例值：/9j/4AAQSkZJRg.....s97n//2Q== |
| CardType | 否 | String | 卡证类型参数，包含以下范围： General：通用卡证 IDCard：身份证 Passport：护照 BankCard：银行卡 VehicleLicense：行驶证 DriverLicense：驾驶证 BizLicense：营业执照 HmtResidentPermit：港澳台居住证 ForeignPermanentResident：外国人永居证 MainlandPermit：港澳台来往内地通行证 示例值：General |
| IsPdf | 否 | Boolean | 是否开启PDF识别，默认值为false，开启后可同时支持图片和PDF的识别。 示例值：false |
| PdfPageNumber | 否 | Integer | 需要识别的PDF页面的对应页码，仅支持PDF单页识别，当上传文件为PDF且IsPdf参数值为true时有效，默认值为1。 示例值：1 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| CardType | String | 卡证类型参数，包含以下范围： General：通用卡证 IDCard：身份证 Passport：护照 BankCard：银行卡 VehicleLicense：行驶证 DriverLicense：驾驶证 BizLicense：营业执照 HmtResidentPermit：港澳台居住证 ForeignPermanentResident：外国人永居证 MainlandPermit：港澳台来往内地通行证 |
| Blur | GeneralCardWarnInfo | 模糊信息 |
| BorderIncomplete | GeneralCardWarnInfo | 边框不完整信息 |
| Copy | GeneralCardWarnInfo | 复印件信息 |
| Ps | GeneralCardWarnInfo | ps篡改信息 |
| Reflection | GeneralCardWarnInfo | 反光信息 |
| Reprint | GeneralCardWarnInfo | 翻拍件信息 |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 通用卡证ps检测告警
身份证
输入示例
POST / HTTP/1.1
Host: ocr.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: RecognizeGeneralCardWarn
<公共请求参数>
{
"ImageUrl": "https://ocr-demo-1254418846.cos.ap-guangzhou.myqcloud.com/card/IDCardOCR/IDCardOCR1.jpg"
}输出示例
{
"Response": {
"Blur": {
"IsWarn": false,
"Polygon": [],
"RiskConfidence": 0.01
},
"BorderIncomplete": {
"IsWarn": false,
"Polygon": [],
"RiskConfidence": 0.01
},
"CardType": "IDCard",
"Copy": {
"IsWarn": false,
"Polygon": [],
"RiskConfidence": 0.01
},
"Ps": {
"IsWarn": true,
"Polygon": [
{
"LeftBottom": {
"X": 477,
"Y": 494
},
"LeftTop": {
"X": 477,
"Y": 257
},
"RightBottom": {
"X": 662,
"Y": 494
},
"RightTop": {
"X": 662,
"Y": 257
}
},
{
"LeftBottom": {
"X": 309,
"Y": 551
},
"LeftTop": {
"X": 309,
"Y": 527
},
"RightBottom": {
"X": 617,
"Y": 551
},
"RightTop": {
"X": 617,
"Y": 527
}
},
{
"LeftBottom": {
"X": 210,
"Y": 461
},
"LeftTop": {
"X": 210,
"Y": 403
},
"RightBottom": {
"X": 417,
"Y": 461
},
"RightTop": {
"X": 417,
"Y": 403
}
},
{
"LeftBottom": {
"X": 218,
"Y": 284
},
"LeftTop": {
"X": 218,
"Y": 256
},
"RightBottom": {
"X": 284,
"Y": 284
},
"RightTop": {
"X": 284,
"Y": 256
}
},
{
"LeftBottom": {
"X": 216,
"Y": 379
},
"LeftTop": {
"X": 216,
"Y": 358
},
"RightBottom": {
"X": 268,
"Y": 379
},
"RightTop": {
"X": 268,
"Y": 358
}
},
{
"LeftBottom": {
"X": 309,
"Y": 377
},
"LeftTop": {
"X": 309,
"Y": 356
},
"RightBottom": {
"X": 326,
"Y": 377
},
"RightTop": {
"X": 326,
"Y": 356
}
},
{
"LeftBottom": {
"X": 361,
"Y": 378
},
"LeftTop": {
"X": 361,
"Y": 356
},
"RightBottom": {
"X": 386,
"Y": 378
},
"RightTop": {
"X": 386,
"Y": 356
}
}
],
"RiskConfidence": 0.9318133
},
"Reflection": {
"IsWarn": false,
"Polygon": [],
"RiskConfidence": 0.01
},
"Reprint": {
"IsWarn": false,
"Polygon": [],
"RiskConfidence": 0.01
},
"RequestId": "b8b73be7-2d64-49c6-8cbc-3b1d2b5f3651"
}
}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 | 计费状态异常。 |
