本文介绍凭证识别服务的API接口。传入凭证图片,通过AI提取关键信息,并支持凭证伪造检测。此接口为同步调用,调用结束后直接返回结果。
接口信息
接口名:CredentialRecognition
接口说明:传入凭证图片,通过AI提取关键信息,并支持凭证伪造检测。
请求方法:POST
传输协议:HTTPS
QPS限量:API独享QPS限量,详情请参见ID Verification服务端API QPS限量说明。
服务地址:
说明内网访问优势:内网指阿里云同一地域内各产品间的私有通信网络。若您的业务服务器部署于阿里云对应地域,请使用内网域名访问 ID Verification 服务,以获得更安全、稳定的通信质量。
海外访问优化建议:海外网络环境复杂,建议参考服务端网络耗时分析与优化,优化集成方案,降低网络延迟及请求失败概率。
新加坡
公网:
cloudauth-intl.ap-southeast-1.aliyuncs.com内网:
cloudauth-intl-vpc.ap-southeast-1.aliyuncs.com
凭证识别伪造检测功能属于AI预测类产品,内部测试集样本准确率是90%,实际准确率由于样本场景的差异可能有波动。
电子合成图片类图片PS检测难度较大,原生相机拍摄图片检测效果优于电子合成图片。
伪造检测不建议作为凭证真实性判断的唯一方法,可作为辅助审核依据,或作为人工审核提效工具。
伪造检测金融支付收单、电商商家入驻等电子资料审核场景已经得到广泛的运用,有效提升人审效率,如果您有更广泛场景需求,请联系您的商务经理。
在线调试和集成
在调试和集成前,请确保您已完整阅读使用OpenAPI调试和集成服务端API文档,充分了解API接口在OpenAPI平台的调用方式和SDK及其代码的获取方式。
您可以在OpenAPI Explorer中直接运行本接口进行调试,并生成本接口的SDK代码示例。
请求参数
参数CredentialOcrPictureBase64或CredentialOcrPictureUrl对应的图片必须符合以下规则:
图片格式:支持PNG、JPG、JPEG、BMP和WebP格式。
图片尺寸:图片长宽需要大于15像素,小于8192像素,且长宽比需要小于50。
说明为了确保较好的识别效果,建议图像的长宽均大于500像素。
图片大小:
CredentialOcrPictureUrl格式传入,不能超过10MB;CredentialOcrPictureBase64传入,不能超过3MB。说明图片过大会影响接口响应速度,建议使用小于 3MB图片。
名称 | 类型 | 是否必选 | 描述 | 示例值 |
ProductCode | string | 是 | 固定取值:CREDENTIAL_RECOGNITION。 | CREDENTIAL_RECOGNITION |
CredentialOcrPictureBase64 | string | 否 | 图片Base64编码。如果您选择此方式传入照片,请注意检查照片大小,不要传入过大的照片。 | - |
CredentialOcrPictureUrl | string | 否 | 图片地址,公网可访问的HTTP、HTTPS链接。 | https://*** |
DocType | string | 是 | 凭证类型:
| 01 |
OcrArea | string | 是 | 提取类型:
| 0101 |
FraudCheck | string | 是 | 是否开启篡改检测
| true |
响应参数
名称 | 类型 | 描述 | 示例值 | |
HTTP Status Code | Integer | HTTP状态码。 | 200 | |
HTTP Body | RequestId | String | 请求ID。 | 130A2C10-B9EE-4D84-88E3-5384FF039**** |
Result.TransactionId | String | 整个流程的唯一标识。 | hksb7ba1b28130d24e015d694361b**** | |
Code | String | 重要
| Success | |
Message | String | 返回信息的响应消息。 | success | |
Result.Success | String | 提取结果:
| S | |
Result.SubCode | String | 认证结果描述。更多信息,请参见ResultObject.SubCode错误码说明。 | 200 | |
Result.ExtIdInfo | String | 关于JSON格式,请参见右侧示例。更多信息,请参见Result.ExtIdInfo。 |
| |
返回Code
HTTP状态码 | Code | Message描述 |
200 | Success | 请求成功。 |
400 | MissingParameter | 参数不能为空。 |
400 | InvalidParameter | 非法参数。 |
403 | Forbidden.RAMUserAccessDenied | 需要给RAM用户授予AliyunAntCloudAuthFullAccess的操作权限。更多信息,请参见授权RAM用户访问服务。 |
403 | Forbidden.AccountAccessDenied | 账户存在欠费,请充值后再进行操作。 |
403 | Throttling.Api | API限流拦截。 |
500 | InternalError | 系统内部错误,请反馈工程师排查。 |
ResultObject.SubCode错误码说明
错误码 | 是否计费 | 描述和原因建议 |
200 | 是 | 提取成功。 |
213 | 是 | 未提取到文字。 |
Result.ExtIdInfo
名称 | 类型 | 描述 | 示例值 |
recInfo | String | 提取的关键信息。 说明 如果提取失败,则该字段值为空。 |
|
spoofInfo | String | 证件防伪检测结果,包括风险判定结果和风险类型:
| 开启篡改检测(请求参数 |