DescribeFaceVerify-获取认证结果

本文介绍了如何通过DescribeFaceVerify接口查询活体人脸验证的结果。

查询认证结果

接口名:DescribeFaceVerify

全局接入地址:cloudauth.aliyuncs.com(IPv4)或cloudauth-dualstack.aliyuncs.com(IPv6)

请求方法:POSTGET

传输协议:HTTPS

接口说明:当您收到回调通知之后,可以在服务端通过该接口获取相应的认证状态和认证资料。

QPS限量:API独享QPS限量,详情请参见服务端接口QPS限量说明

请求参数

名称

类型

是否必选

描述

示例值

SceneId

Long

认证场景ID。该ID在控制台创建认证场景后自动生成。

100000****

CertifyId

String

实人认证唯一标识。

该值需要调用InitFaceVerify-发起认证请求获取。

91707dc296d469ad38e4c5efa6a0****

返回数据

名称

类型

描述

示例值

RequestId

String

请求ID。

130A2C10-B9EE-4D84-88E3-5384FF0****

Code

String

返回码,200 指接口响应成功。

您可以在Code中查看不同 Code 的详细描述。

200

Message

String

请求信息的响应消息,对 Code(返回码)的简短描述。

success

ResultObject

JSON

认证结果。该认证结果是一个JSON结构体,关于具体结构描述,请参见ResultObject

表 1. ResultObject

名称

类型

描述

示例值

Passed

String

认证结果,取值:

  • T:通过

  • F:不通过

T

SubCode

String

认证结果描述。

您可以在ResultObject.SubCode错误码说明中查看不同状态码的描述和处理建议。

说明

判断认证结果请以 ResultObject.Passed 字段为准。

200

IdentityInfo

String

认证的主体信息,一般的认证场景返回为空。

null

DeviceToken

String

设备Token。

McozS1ZWRcRZStlERcZZo_QOytx5jcgZoZJEoRLOABBF****

ResultObject.DeviceRisk

String

设备风险标签。

ROOT,VPN,HOOK

说明

多个设备风险标签以半角逗号(,)分隔。

您可以通过设备风险标签了解所有标签及其含义。

MaterialInfo

String

人脸认证主体附件信息

  • 人脸攻击检测结果及攻击分(faceAttack/faceAttackScore)

  • 人脸遮挡检测结果及质量分(faceOcclusion/qualityScore)以及质量相关详细字段

  • 人脸照片和留存照片比对分(verifyScore)

    说明

    verifyScore为活体人脸照片和传入人脸照片比对分。

  • 人脸照片OSS存储位置及链接(资料可选)

    人脸照片资料认证视频资料的字段返回依赖不同配置项,具体如下:

    • 人脸照片相关字段(ossBucketName、ossObjectName、pictureUrl)的返回仅依赖控制台认证场景中的配置:

      • 控制台认证场景中开启【是否留存认证资料】

      • 控制台已配置并启用OSS授权

    • 认证视频相关字段(verifyVideoUrl、ossVerifyVideoObjectName)的返回需同时满足以下条件:

      • 控制台认证场景中开启【是否留存认证资料】

      • 控制台已配置并启用OSS授权

      • 客户端在 extParams 参数中配置视频返回( WebSDK 需要在InitFaceVerify 中显式配置返回视频包含字段)

    说明

    默认输出最佳人脸照片1张,若需要返回多张照片,请参考添加认证场景进行配置。

{
  "faceAttack": "T",
  "faceOcclusion": "F",
  "facialPictureFront": {
    "faceAttackScore": 0.00008597839769208804,
    "qualityScore": 99.93476867675781,
    "qualityBackground": "0",
    "qualityBlur": "0",
    "qualityIllu": "0",
    "qualityOccu": "0",
    "qualityWearHat": "F",
    "verifyScore": 57.678396649466755,
    "ossBucketName": "cn-shanghai-aliyun-cloudauth-12600*********",
    "ossObjectName": "verify/1260051251634779/03a081bd96328aedf83f635f3********.jpeg",
    "pictureUrl": "http://cn-shanghai-aliyun-cloudauth-1260051251634779.oss-cn-shanghai.aliyuncs.com/verify/1260051251634779/03a081bd96328aedf83f635f********.jpeg?&security-token=CAISjgJ1q6Ft...",
    "ossVerifyVideoObjectName": "verify/1260051251634779/03a081bd96328aedf83f635****_verifyvideo_dcb7.mov",
    "verifyVideoUrl": "http://cn-shanghai-aliyun-cloudauth-1260051251634779.oss-cn-shanghai.aliyuncs.com/verify/1260051251634779/03a081bd96328aedf83f635f39a50c57__********.mov?security-token=CAISjgJ1q6Ft..."
  }
}

若配置了多照片返回,则还会返回如下内容:

"customFaceObjectNameUrls": [
  "https://cn-shanghai-aliyun-cloudauth-177***150.oss-cn-shanghai.aliyuncs.com/verify/177***150/sha58***Pic1.jpeg?Expires=17***9&OSSAccessKeyId=STS.NZtBj***SFWN&Signature=8%2***IKRZFdgsY%3D&security-token=CAIS2w***A%3D",
  "https://cn-shanghai-aliyun-cloudauth-177***150.oss-cn-shanghai.aliyuncs.com/verify/177***150/sha58***Pic2.jpeg?Expires=17***9&OSSAccessKeyId=STS.NZtBj***SFWN&Signature=8%2***IKRZFdgsY%3D&security-token=CAIS2w***A%3D"
],
"customFaceObjectNames": [
  "verify/177***150/sha589b06***Pic1.jpeg",
  "verify/177***150/sha589b06***Pic2.jpeg"
]