API 文档

人员验证

最近更新时间:2020-08-10 08:12:26

1. 接口描述

接口请求域名: iai.tencentcloudapi.com 。

给定一张人脸图片和一个 PersonId,判断图片中的人和 PersonId 对应的人是否为同一人。PersonId 请参考人员库管理相关接口。 本接口会将该人员(Person)下的所有人脸(Face)进行融合特征处理,即若某个Person下有4张 Face,本接口会将4张 Face 的特征进行融合处理,生成对应这个 Person 的特征,使人员验证(确定待识别的人脸图片是某人员)更加准确。

和人脸比对相关接口不同的是,人脸验证相关接口用于判断 “此人是否是此人”,“此人”的信息已存于人员库中,“此人”可能存在多张人脸图片;而人脸比对相关接口用于判断两张人脸的相似度。

  • 公共参数中的签名方式请使用V3版本,即配置SignatureMethod参数为TC3-HMAC-SHA256。
  • 仅支持算法模型版本(FaceModelVersion)为3.0的人员库。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:VerifyPerson。
Version String 公共参数,本接口取值:2020-03-03。
Region String 公共参数,详见产品支持的 地域列表
Image String 图片 base64 数据。
jpg格式长边像素不可超过4000,其他格式图片长边像素不可超2000。
若图片中包含多张人脸,只选取其中人脸面积最大的人脸。
支持PNG、JPG、JPEG、BMP,不支持 GIF 图片。
Url String 图片的 Url
jpg格式长边像素不可超过4000,其他格式图片长边像素不可超2000。。
图片的 Url、Image必须提供一个,如果都提供,只使用 Url。
图片存储于腾讯云的Url可保障更高下载速度和稳定性,建议图片存储于腾讯云。
非腾讯云存储的Url速度和稳定性可能受一定影响。
若图片中包含多张人脸,只选取其中人脸面积最大的人脸。
支持PNG、JPG、JPEG、BMP,不支持 GIF 图片。
PersonId String 待验证的人员ID。人员ID具体信息请参考人员库管理相关接口。
QualityControl Integer 图片质量控制。
0: 不进行控制;
1:较低的质量要求,图像存在非常模糊,眼睛鼻子嘴巴遮挡至少其中一种或多种的情况;
2: 一般的质量要求,图像存在偏亮,偏暗,模糊或一般模糊,眉毛遮挡,脸颊遮挡,下巴遮挡,至少其中三种的情况;
3: 较高的质量要求,图像存在偏亮,偏暗,一般模糊,眉毛遮挡,脸颊遮挡,下巴遮挡,其中一到两种的情况;
4: 很高的质量要求,各个维度均为最好或最多在某一维度上存在轻微问题;
默认 0。
若图片质量不满足要求,则返回结果中会提示图片质量检测不符要求。
NeedRotateDetection Integer 是否开启图片旋转识别支持。0为不开启,1为开启。默认为0。本参数的作用为,当图片中的人脸被旋转且图片没有exif信息时,如果不开启图片旋转识别支持则无法正确检测、识别图片中的人脸。若您确认图片包含exif信息或者您确认输入图中人脸不会出现被旋转情况,请不要开启本参数。开启后,整体耗时将可能增加数百毫秒。

3. 输出参数

参数名称 类型 描述
Score Float 给定的人脸照片与 PersonId 对应的相似度。若 PersonId 下有多张人脸(Face),会融合多张人脸信息进行验证。
IsMatch Boolean 是否为同一人的判断。
FaceModelVersion String 人脸识别所用的算法模型版本,是该 Person 所在的人员库的算法模型版本。在创建人员库时设置,详情可参考算法模型版本
RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 人脸验证接口

输入示例

https://iai.tencentcloudapi.com/?Action=VerifyPerson
&Url=http://test.image.myqcloud.com/testA.jpg
&PersonId=11111111
&<公共请求参数>

输出示例

{
  "Response": {
    "Score": 100,
    "IsMatch": true,
    "FaceModelVersion": "3.0",
    "RequestId": "a8eb4545-a154-4f86-9510-57a8be9cae0c"
  }
}

5. 开发者资源

API Explorer

该工具提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力,能显著降低使用云 API 的难度,推荐使用。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码

错误码 描述
FailedOperation.FaceQualityNotQualified 人脸图片质量不符要求。
FailedOperation.FaceSizeTooSmall 人脸框大小小于MinFaceSize设置,人脸被过滤。
FailedOperation.ImageDecodeFailed 图片解码失败。
FailedOperation.ImageDownloadError 图片下载错误。
FailedOperation.ImageFacedetectFailed 人脸检测失败。
FailedOperation.ImageResolutionExceed 图片分辨率过大。
FailedOperation.ImageResolutionTooSmall 图片短边分辨率小于64。
FailedOperation.ImageSizeExceed base64编码后的图片数据大小不超过5M。
FailedOperation.RequestLimitExceeded 请求频率超过限制。
FailedOperation.RequestTimeout 后端服务超时。
FailedOperation.ServerError 算法服务异常,请重试。
InternalError 内部错误。
InvalidParameter.InvalidParameter 参数不合法。
InvalidParameterValue.ImageEmpty 图片为空。
InvalidParameterValue.NoFaceInGroups 指定分组中没有人脸。
InvalidParameterValue.NoFaceInPhoto 图片中没有人脸。
InvalidParameterValue.PersonIdIllegal 人员ID包含非法字符。人员ID只支持英文、数字、-%@#&_。
InvalidParameterValue.PersonIdNotExist 人员ID不存在。
InvalidParameterValue.QualityControlIllegal QualityControl参数不合法。
InvalidParameterValue.UnsupportedGroupFaceModelVersion 该操作不支持算法模型版本2.0及以下版本。
InvalidParameterValue.UrlIllegal URL格式不合法。
ResourceUnavailable.ChargeStatusException 帐号已欠费。
ResourceUnavailable.Freeze 帐号已被冻结。
ResourceUnavailable.GetAuthInfoError 获取认证信息失败。
ResourceUnavailable.InArrears 帐号已欠费。
ResourceUnavailable.LowBalance 余额不足。
ResourceUnavailable.NotExist 计费状态未知,请确认是否已在控制台开通服务。
ResourceUnavailable.NotReady 服务未开通。
ResourceUnavailable.UnknownStatus 计费状态未知。
ResourcesSoldOut.ChargeStatusException 计费状态异常。
UnsupportedOperation.UnknowMethod 未知方法名。
目录