1. 接口描述
接口请求域名: ocr.tencentcloudapi.com 。
提供针对卡证(如身份证、营业执照等)图片的PS篡改、AIGC合成、图片质量检测能力,可应用于业务流程中对卡证图片真实性、有效性校验的场景。
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数,本接口取值:VerifyGeneralCardWarn。 |
| Version | 是 | String | 公共参数,本接口取值:2018-11-19。 |
| Region | 否 | String | 公共参数,此参数为可选参数。 |
| CardType | 是 | String | 卡证类型参数,仅支持传入下列指定值,请按实际情况选择对应卡证类型,目前支持以下类型: 示例值:0101 |
| ImageUrl | 否 | String | 图片的 Url 地址。要求图片经Base64编码后不超过 10M。 示例值:https://ocr-demo-1254418846.cos.ap-guangzhou.myqcloud.com/card/IDCardOCR/IDCardOCR1.jpg |
| ImageBase64 | 否 | String | 图片的 Base64 值。要求图片经Base64编码后不超过 10M。 示例值:data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAUkAAABICAYAAAB7oQe5AAAACXBIWXMAAAsTAAALEwEAmpwYAAAgAElEQVR4nKy9x7NlS3be93uz3fHX1C37vEN3P7SBI5oDiiIRoQHFgaCBQqGQMOJ |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| Tamper | GeneralCardWarnInfo | 区域篡改提示 |
| Synthesis | GeneralCardWarnInfo | AIGC合成提示 |
| Template | GeneralCardWarnInfo | 模板图片提示 |
| RemakeScreen | GeneralCardWarnInfo | 屏幕翻拍提示 |
| Screenshot | GeneralCardWarnInfo | 截图提示 |
| Blur | GeneralCardWarnInfo | 模糊提示 |
| BorderIncomplete | GeneralCardWarnInfo | 边框不完整提示 |
| Copy | GeneralCardWarnInfo | 复印件提示 |
| Reflection | GeneralCardWarnInfo | 反光提示 |
| Cover | GeneralCardWarnInfo | 遮挡提示 |
| Overlap | GeneralCardWarnInfo | 重叠提示 |
| Electron | GeneralCardWarnInfo | 电子证照提示(目前仅支持电子身份证、电子营业执照识别) |
| TextWatermark | GeneralCardWarnInfo | 文字水印提示 |
| WatermarkContent | String | 水印内容,当未检测到文字水印时不返回,返回多组水印时以 | 分隔。 示例值:仅用于办理商户注册,他用无效。 |
| RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 身份证检测告警
身份证检测
输入示例
POST / HTTP/1.1
Host: ocr.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: VerifyGeneralCardWarn
<公共请求参数>
{
"CardType": "0101",
"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
},
"Copy": {
"IsWarn": false,
"Polygon": [],
"RiskConfidence": 0.01
},
"Cover": {
"IsWarn": false,
"Polygon": [],
"RiskConfidence": 0.01
},
"Electron": {
"IsWarn": false,
"Polygon": [],
"RiskConfidence": 0
},
"Overlap": {
"IsWarn": false,
"Polygon": [],
"RiskConfidence": 0.01
},
"Reflection": {
"IsWarn": false,
"Polygon": [],
"RiskConfidence": 0.01
},
"RemakeScreen": {
"IsWarn": false,
"Polygon": [],
"RiskConfidence": 0.01
},
"Screenshot": {
"IsWarn": false,
"Polygon": [],
"RiskConfidence": 0.01
},
"Synthesis": {
"IsWarn": true,
"Polygon": [],
"RiskConfidence": 0.9999985
},
"Tamper": {
"IsWarn": false,
"Polygon": [],
"RiskConfidence": 0
},
"Template": {
"IsWarn": false,
"Polygon": [],
"RiskConfidence": 0
},
"TextWatermark": {
"IsWarn": false,
"Polygon": [],
"RiskConfidence": 0
},
"WatermarkContent": "",
"RequestId": "5d75b7af-e03b-45d0-ae0f-1cd00ea06035"
}
}
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: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Java: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for PHP: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Go: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Node.js: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for .NET: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for C++: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Ruby: CNB, GitHub, Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| FailedOperation.DownLoadError | 文件下载失败。 |
| FailedOperation.ImageDecodeFailed | 图片解码失败。 |
| FailedOperation.OcrFailed | OCR识别失败。 |
| FailedOperation.UnKnowError | 未知错误。 |
| FailedOperation.UnOpenError | 服务未开通。 |
| InvalidParameterValue.InvalidParameterValueLimit | 参数值错误。 |
| LimitExceeded.TooLargeFileError | 文件内容太大。 |
| ResourceUnavailable.InArrears | 账号已欠费。 |
| ResourceUnavailable.ResourcePackageRunOut | 账号资源包耗尽。 |
| ResourcesSoldOut.ChargeStatusException | 计费状态异常。 |