1. 接口描述
接口请求域名： faceid.tencentcloudapi.com 。
完成验证后，用FaceIdToken调用本接口获取结果信息，FaceIdToken生成后三天内（3*24*3,600秒）可多次拉取。
默认接口请求频率限制：100次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：GetFaceIdResult。 |
| Version | 是 | String | 公共参数，本接口取值：2018-03-01。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表，本接口仅支持其中的: ap-beijing, ap-chengdu, ap-guangzhou, ap-shanghai 。 |
| FaceIdToken | 是 | String | SDK人脸核身流程的标识。 - 调用GetFaceIdToken接口时生成。 示例值：CE6613F1A-0F1E-45BD-BE13-34C05CEA76181 |
| IsNeedVideo | 否 | Boolean | 是否需要拉取视频。 - 默认false：不需要。 示例值：false |
| IsNeedBestFrame | 否 | Boolean | 是否需要拉取截帧。 - 默认false：不需要。 示例值：false |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| IdCard | String | 身份证。 示例值：11204416541220243X |
| Name | String | 姓名。 示例值：韦小宝 |
| Result | String | 业务核验结果。 - 参考：https://cloud.tencent.com/document/product/1007/47912。 示例值：0 |
| Description | String | 业务核验描述。 示例值：成功 |
| Similarity | Float | 相似度。 - 取值：0-100。 - 数值越大相似度越高。 示例值：97.7 |
| VideoBase64 | String | 用户核验的视频base64。 - 如果选择了使用cos，返回完整cos地址，如https://bucket.cos.ap-guangzhou.myqcloud.com/objectKey。 注意：此字段可能返回 null，表示取不到有效值。 示例值：AAAAGGZ0eX...5Zin4btI4A |
| BestFrameBase64 | String | 用户核验视频的截帧base64。 - 如果选择了使用cos，返回完整cos地址如https://bucket.cos.ap-guangzhou.myqcloud.com/objectKey。 注意：此字段可能返回 null，表示取不到有效值。 示例值：/9j/4AAQSk...TYkEBjj//Z |
| Extra | String | 获取token时透传的信息。 注意：此字段可能返回 null，表示取不到有效值。 示例值：202411011707591990200060000 |
| DeviceInfoTag | String | plus版：描述当前请求所在设备的风险标签。 - 详情如下： 01-设备疑似被Root/设备疑似越狱。 02-设备疑似被注入。 03-设备疑似为模拟器。 04-设备疑似存在风险操作。 05-摄像头疑似被劫持。 06-疑似黑产设备。 null-无设备风险。 - 增强版：此字段不生效，默认为null。 注意：此字段可能返回 null，表示取不到有效值。 示例值：01 |
| RiskInfoTag | String | 行为风险标签。 - 仅错误码返回1007（设备疑似被劫持）时返回风险标签。 - 标签说明： 02：攻击风险 注意：此字段可能返回 null，表示取不到有效值。 示例值：02 |
| LivenessInfoTag | String | plus版：描述当前请求活体阶段被拒绝的详细原因。 - 详情如下： 01-用户全程闭眼。 02-用户未完成指定动作。 03-疑似翻拍攻击。 04-疑似合成图片。 05-疑似合成视频。 06-疑似合成动作。 07-疑似黑产模板。 08-疑似存在水印。 09-反光校验未通过。 10-最佳帧校验未通过。 11-人脸质量过差。 12-人脸距离不匹配。 13-疑似对抗样本攻击。 null-无。 - 增强版：此字段不生效，默认为null。 注意：此字段可能返回 null，表示取不到有效值。 示例值：01 |
| DeviceInfoLevel | String | plus版：描述当前请求所在设备的风险等级，共4级。 - 详情如下： 1 - 安全。 2 - 低风险。 3 - 中风险。 4 - 高危。 null - 未获取到风险等级。 - 增强版：此字段不生效，默认为null。 注意：此字段可能返回 null，表示取不到有效值。 示例值：1 |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 获取SDK核验结果成功示例
获取SDK核验结果成功。
输入示例
https://faceid.tencentcloudapi.com/?Action=GetFaceIdResult
&FaceIdToken=CE661F1A-0F1E-45BD-BE113-34C05CEA76811
&<公共请求参数>输出示例
{
"Response": {
"BestFrameBase64": "/9j/4AAQSk...1Udr+R/9k=",
"Description": "成功",
"DeviceInfoLevel": null,
"DeviceInfoTag": null,
"Extra": "",
"IdCard": "",
"LivenessInfoTag": null,
"Name": "",
"RequestId": "13c51421-3b1d-4b40-8206-8dacedec2d32",
"Result": "0",
"RiskInfoTag": "",
"Similarity": 0,
"VideoBase64": ""
}
}示例2 获取SDK核验结果人脸检测失败示例
获取SDK核验结果人脸检测失败。
输入示例
https://faceid.tencentcloudapi.com/?Action=GetFaceIdResult
&FaceIdToken=CE661F1A-0F1E-45BD-BE113-34C05CEA76831
&<公共请求参数>输出示例
{
"Response": {
"BestFrameBase64": "/9j/4AAQSk...9Dl1t//9k=",
"Description": "人脸检测失败，无法提取比对照",
"DeviceInfoLevel": null,
"DeviceInfoTag": null,
"Extra": "",
"IdCard": "",
"LivenessInfoTag": null,
"Name": "",
"RequestId": "391e4084-43dd-4b03-b31c-c92a519d40bd",
"Result": "1004",
"RiskInfoTag": "",
"Similarity": 0,
"VideoBase64": "AAAAGGZ0eX...AAAAAAAAA="
}
}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 | 未开通服务。 |
