人脸检索接口
2024.11.20 10:20:47
识别上传人脸图片与人脸库中的图片的匹配程度,判断该人脸是否存在于人脸库中。
接口说明
鉴权说明
易盾信息认证服务使用签名方法对接口进行鉴权,所有接口每一次请求都需要包含签名信息(signature参数),以验证用户身份,防止信息被恶意篡改。目前支持MD5,SHA1,SHA256,SM3几种加密算法,详细信息,请参见接口鉴权
请求
请求地址
名称 | 值 |
---|---|
HTTP URL | https://verify.dun.163.com/v1/facerecognize/check |
HTTP Method | POST |
请求头
名称 | 类型 | 必填 | 描述 |
---|---|---|---|
Content-Type | String | 是 | 固定值:"application/x-www-form-urlencoded" |
请求参数
请求参数由请求公共参数和请求业务参数两部分组成,通用参数见请求通用字段
参数名称 | 类 型 | 是否必选 | 最大长度 | 描述 |
---|---|---|---|---|
picType | Number | 是 | 4 | 图片类型:1-URL,2-BASE64 |
avatar | String | 是 | 256或200K | 用于人脸比对的头像照,请上传无遮挡的清晰正面照,轮廓保持完整 |
请求体示例
picType=1&avatar=xxx&version=v1&businessId=xxx×tamp=1638180222235&nonce=xxx&secretId=xxx&signature=xxx
响应
响应结果
响应字段如下,响应通用字段已省略,详细见响应公共字段
参数名称 | 类 型 | 必须返回 | 描述 |
---|---|---|---|
status | Number | 是 | 检索结果,1-成功 2-图片下载失败 3-其他错误 5-上传图片质量过低,无法解析到完整的人脸 |
matched | Boolean | 是 | 匹配结果,true:匹配成功,false:匹配失败 |
requestId | String | 是 | 本次请求数据标识,强烈建议开发者保存该ID,便于后续排查问题 |
isPayed | Number | 是 | 本次请求是否收费标识,1代表收费,0代表不收费 |
matchedFaces | List | 否 | 匹配相似度最高的一张人脸数据,具体数据结构见下方。 |
∟ score | Double | 否 | 相似度得分,范围0-1,分数越高,相似度越高。 |
∟ name | String | 否 | 匹配到的人脸对应姓名 |
∟ faceId | String | 否 | 匹配到的人脸id |
∟ faceUrl | String | 否 | 匹配到的人脸url |
响应体示例
{
"requestId": "9f0bae14082a426689c87789eff6f75d",
"matchedFaces": [{
"score": 1.0,
"faceId": "H17766"
}],
"matched": true,
"isPayed": 1,
"status": 1
}
响应返回码
响应返回码见:响应返回码