card_quality
1.接口描述
此API用于评估卡证图像清晰度
图片要求
1. 格式为 JPG(JPEG),PNG
2. 宽和高大于 128px,小于等于6000px
3. 小于等于 5 MB
请求方式
POST
请求 URL
http://server_host/api/image/card_quality
2.请求参数
2.1 请求体
字段 | 类型 | 是否必需 | 描述 |
---|---|---|---|
image_file | file | 见下方注释 | 需上传的图片文件,上传本地图片进行检测时选取此参数 |
image_base64 | string | 见下方注释 | base64编码的图片内容 |
request_id | string | 否 | 一次请求的唯一标记,不指定服务端会自动生成 |
请求参数
image_file
,image_base64
二选一。
url 中若含有特殊字符,则需要对这些字符进行转义,所有中文和特殊字符必需以UTF-8编码转义。
参数image_file
需把图片文件以 multipart/form-data 的形式放到 POST 消息体中。
3.返回参数
字段 | 类型 | 说明 |
---|---|---|
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以上判定为完整,图片类型为银行卡/身份证时返回 |
输出样例
{
"is_clear": 0.99,
"is_integrity": 1,
"is_origin": 1,
"request_id": "93849174-7781-11ec-9f1d-0242ac110030",
"status": "OK"
}
4.错误码
状态码 | status 字段 |
说明 |
---|---|---|
400 |
INVALID_ARGUMENT | 请求参数错误 |
400 |
DETETION_FAILED | 图片检测失败 |
403 |
NO_PERMISSION | 无调用权限 |
403 |
OUT_OF_QUOTA | 调用次数超出限额 |
404 |
NOT_FOUND | 请求路径错误 |
500 |
INTERNAL_ERROR | 服务器内部错误 |
备注: 以上40X系列错误描述请参考error
字段
输出样例
{
"status": "PARAMETER_ERROR",
"error": "image_file、image_base64 or image_url required",
}