/image/card_quality

1.接口描述
2.请求参数
3.返回参数
4.错误码
5.输入示例

1.接口描述

此API用于评估身份证和银行卡图像质量

图片要求

  1. 格式为 JPG(JPEG), PNG
  2. 宽和高大于 128px, 小于等于 6000px
  3. 小于等于 5 MB

请求方式

POST

请求 URL

https://cloudapi.deepfinch.com/image/card_quality

调试工具

Debugging Tool

2.请求参数

2.1 请求头域

Parameter Type Required Description
X-DF-API-ID string Yes API调用凭证信息，详细信息请参考 API 调用
X-DF-API-SECRET string Yes API调用凭证信息，详细信息请参考 API 调用

2.2 请求体

Fields Type Description
optional file file 需上传的图片文件
optional image_base64 string Base64格式图像数据

必须将参数 file 或 image_base64 作为请求参数提供。

参数 file 需把图片文件以 multipart/form-data 的形式放到 POST 消息体中。

3.返回参数

Fields Type Description
request_id string 本次请求的id
status string 状态，正常为 OK ，其他值表示失败，详见 错误码
is_clear float 图像清晰度评分[0.0-1.0]，推荐0.7以上为清晰
is_origin float 图像复印件评分[0.0-1.0]，推荐0.9以上判定为原件
is_integrity float 卡证完整读评分[0.0-1.0]，推荐0.7以上判定为完整
输出样例
{
  "request_id": "TID8bf47ab6eda64476973cc5f5b6ebf57e",
  "status": "OK",
  "is_clear":"0.79",
  "is_origin":"0.71",
  "is_integrity":"0.76",

}

4.错误码

常见错误码:

Http Status Code Status field Description
400 INVALID_ARGUMENT 请求参数错误
400 DETECTION_FAILED 图片检测失败
401 UNAUTHORIZED 未授权或授权失败
401 KEY_EXPIRED 账号过期
403 NO_PERMISSION 无调用权限
403 OUT_OF_QUOTA 调用次数超出限额
403 RATE_LIMIT_EXCEEDED 调用频率超出限额
404 NOT_FOUND 请求路径错误
500 INTERNAL_ERROR 服务器内部错误

备注: 备注: 以上40X系列错误描述请参考reason字段

输出样例
{
  "status": "INVALID_ARGUMENT",
  "reason": "must specify 'file' or 'image_base64' argument",
  "request_id": "TID8bf47ab6eda64476973cc5f5b6ebf57e"
}

5.输入示例

results matching ""

    No results matching ""