/face/v2/verify
1. API 说明
2. 请求参数
3. 返回参数
4. 错误码
5. 示例
1. API 说明
此API用于对比两张人脸图片,以验证它们是否属于同一人。
图片规格
1. 支持格式:JPG(JPEG), PNG
2. 图像尺寸范围:128*128 至 6000*6000
3. 文件大小:不超过5MB
请求方式
POST
请求地址
https://cloudapi.peru.accuauth.com/face/v2/verify
2. 请求参数
2.1 请求头
参数名称 | 类型 | 是否必填 | 描述 |
---|---|---|---|
X-DF-API-ID | string | 是 | API凭证,请参考API请求文档获取 |
X-DF-API-SECRET | string | 是 | API凭证,请参考API请求文档获取 |
2.2 请求体
字段名称 | 类型 | 是否必填 | 描述 |
---|---|---|---|
file_1 | file | 见备注 | 第一张图片文件,图片的二进制数据 |
image_base64_1 | string | 见备注 | 第一张图片的Base64编码 |
file_2 | file | 见备注 | 第二张图片文件,图片的二进制数据 |
image_base64_2 | string | 见备注 | 第二张图片的Base64编码 |
compare_mode | int | 可选 | 比对模式,0: 比对身份证照片,1: 比对两张生活照,2: 服务器端自动分类;默认值为0 |
备注:必须提供
file_1
或image_base64_1
中的一个作为请求参数;必须提供file_2
或image_base64_2
中的一个作为请求参数。当使用file_1
或file_2
参数时,需将图片流添加到POST消息的multipart/form-data部分。
3. 返回参数
正常响应(状态码200
)
字段名称 | 类型 | 描述 |
---|---|---|
request_id | string | 每个请求的唯一ID |
status | string | 响应状态。OK 表示请求成功,其他表示请求失败,具体参见错误代码 |
identical | bool | 人脸匹配结果,true表示相同,false表示不同 |
score | float | 两张人脸的相似度分数,0-1范围内。分数越高,表示越可能是同一人 |
备注:
- 若目标图片中包含多张人脸,系统将选择最大的一张进行匹配。
identical
字段表示在默认阈值0.8下的人脸比对结果。当分数高于0.8时,返回true。- 若使用自定义阈值,请将
score
字段与自定义阈值进行比较,以确定比对结果。
正常响应示例:
{
"request_id": "TID8bf47ab6eda64476973cc5f5b6ebf57e",
"status": "OK",
"identical": true,
"score": 0.928513,
}
4. 错误码
HTTP状态码 | status 字段 |
描述 |
---|---|---|
400 |
INVALID_ARGUMENT | 请求参数无效 |
400 |
DETECTION_FAILED | 图片检测失败 |
400 |
DOWNLOAD_ERROR | 图片下载失败 |
401 |
UNAUTHORIZED | 未授权或访问被拒绝 |
401 |
KEY_EXPIRED | API ID已过期 |
403 |
NO_PERMISSION | 无权限使用该接口 |
403 |
OUT_OF_QUOTA | 超出 API 调用配额 |
403 |
RATE_LIMIT_EXCEEDED | 调用频率超限 |
404 |
NOT_FOUND | 请求的API未找到 |
500 |
INTERNAL_ERROR | 服务器处理失败 |
错误响应示例:
{
"status": "DETECTION_FAILED",
"reason": "no face detected in first image",
"request_id": "TID8bf47ab6eda64476973cc5f5b6ebf57e"
}