1. 接口描述
接口请求域名: faceid.tencentcloudapi.com 。
完成验证后,用FaceIdToken调用本接口获取设备风险相关信息,FaceIdToken生成后三天内(3*24*3,600秒)可多次拉取。
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:GetFaceIdRiskInfo。 |
Version | 是 | String | 公共参数,本接口取值:2018-03-01。 |
Region | 否 | String | 公共参数,本接口不需要传递此参数。 |
FaceIdToken | 是 | String | SDK人脸核身流程的标识,调用GetFaceidRiskInfoToken接口时生成。 示例值:CE6621F1A-0F1E-45BD-BE13-34C025CEA7681 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
DeviceInfoTag | String | 描述当前请求所在设备的风险标签 - 详情如下: 01-设备疑似被Root/设备疑似越狱。 02-设备疑似被注入。 03-设备疑似为模拟器。 04-设备疑似存在风险操作。 05-摄像头疑似被劫持。 06-疑似黑产设备。 注意:此字段可能返回 null,表示取不到有效值。 示例值:01_03 |
DeviceInfoLevel | Integer | 描述当前请求所在设备的风险等级,共4级。 - 详情如下: 1 - 低风险。 2 - 中风险。 3 - 高风险。 4 - 攻击。 -1表示未获取到风险等级。 注意:此字段可能返回 null,表示取不到有效值。 示例值:1 |
OpenId | String | 设备id标识。 注意:此字段可能返回 null,表示取不到有效值。 示例值:DB1904203FA986234030BDFAB |
CameraInfoLevel | Integer | 描述当前请求所在设备的相机指纹风险等级,共4级。 - 详情如下: 1 - 低风险。 2 - 中风险。 3 - 高风险。 4 - 攻击。 -1表示未获取到风险等级。 注意:此字段可能返回 null,表示取不到有效值。 示例值:1 |
CameraInfoTag | String | 描述当前请求所在设备的相机指纹风险标签。 - 详情如下: 01-设备疑似被Root/设备疑似越狱。 02-设备疑似被注入。 03-设备疑似为模拟器。 04-设备疑似存在风险操作。 05-摄像头疑似被劫持。 06-疑似黑产设备。 空表示没有相机指纹风险。 注意:此字段可能返回 null,表示取不到有效值。 示例值:01_03 |
Extra | String | 获取token时透传的信息。 注意:此字段可能返回 null,表示取不到有效值。 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 获取结果成功
获取结果成功。
输入示例
POST / HTTP/1.1
Host: faceid.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: GetFaceIdRiskInfo
<公共请求参数>
{
"FaceIdToken": "CE661F1A-0F1E-45BD-BE13-34C05CEA761281"
}
输出示例
{
"Response": {
"CameraInfoLevel": null,
"CameraInfoTag": null,
"DeviceInfoLevel": 1,
"DeviceInfoTag": null,
"Extra": null,
"OpenId": "9B0104204DAB86054F6CV19E38",
"RequestId": "dbabb231-4adc-4e88-b763-b3dfd9476923"
}
}
5. 开发者资源
腾讯云 API 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。
API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。
SDK
云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python: GitHub Gitee
- Tencent Cloud SDK 3.0 for Java: GitHub Gitee
- Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
- Tencent Cloud SDK 3.0 for Go: GitHub Gitee
- Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
- Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
- Tencent Cloud SDK 3.0 for C++: GitHub Gitee
- Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
FailedOperation.UnKnown | 内部未知错误。 |
InvalidParameter | 参数错误。 |
InvalidParameterValue.BizTokenExpired | BizToken过期。 |
InvalidParameterValue.BizTokenIllegal | BizToken不合法。 |
UnauthorizedOperation.Arrears | 账号已欠费。 |
UnauthorizedOperation.Nonactivated | 未开通服务。 |