API 中心
有奖捉虫：办公协同&微信生态&物联网文档专题 HOT
文档中心 > API 中心 > 人脸核身 > 人脸核身SaaS服务相关接口 > 获取SDK核验结果

获取SDK核验结果

最近更新时间：2024-03-27 01:17:39

我的收藏

本页目录：

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接口时生成。
示例值：CE661F1A-0F1E-45BD-BE13-34C05CEA7681
IsNeedVideo 否 Boolean 是否需要拉取视频，默认false不需要
示例值：false
IsNeedBestFrame 否 Boolean 是否需要拉取截帧，默认false不需要
示例值：false

3. 输出参数

参数名称 类型 描述
IdCard String 身份证
示例值：23232323232
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，表示取不到有效值。
BestFrameBase64 String 用户核验视频的截帧base64，如果选择了使用cos，返回完整cos地址如https://bucket.cos.ap-guangzhou.myqcloud.com/objectKey
注意：此字段可能返回 null，表示取不到有效值。
Extra String 获取token时透传的信息
注意：此字段可能返回 null，表示取不到有效值。
DeviceInfoTag String 设备风险标签，仅错误码返回1007（设备疑似被劫持）时返回风险标签。标签说明：
202、5001：设备疑似被Root
203、5004：设备疑似被注入
205：设备疑似被Hook
206：设备疑似虚拟运行环境
5007、1005：设备疑似摄像头被劫持
8000：设备疑似存在异常篡改行为
注意：此字段可能返回 null，表示取不到有效值。
示例值：01
RiskInfoTag String 行为风险标签，仅错误码返回1007（设备疑似被劫持）时返回风险标签。标签说明：
02：攻击风险
注意：此字段可能返回 null，表示取不到有效值。
示例值：02
RequestId String 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 获取结果成功时

输入示例

https://faceid.tencentcloudapi.com/?Action=GetFaceIdResult
&FaceIdToken=CE661F1A-0F1E-45BD-BE13-34C05CEA7681
&<公共请求参数>

输出示例

{
    "Response": {
        "Result": "0",
        "Description": "成功",
        "IdCard": "23232323232",
        "Name": "王五",
        "Similarity": 97.7,
        "RequestId": "0f96cf39-a183-485c-ab29-8427ab81f9ae",
        "Extra": "",
        "VideoBase64": "",
        "BestFrameBase64": "",
        "DeviceInfoTag": "01",
        "RiskInfoTag": "02"
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。

SDK

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

命令行工具

6. 错误码

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

错误码 描述
FailedOperation.UnKnown 内部未知错误。
InvalidParameter 参数错误。
InvalidParameterValue.BizTokenExpired BizToken过期。
InvalidParameterValue.BizTokenIllegal BizToken不合法。
UnauthorizedOperation.Arrears 账号已欠费。
UnauthorizedOperation.Nonactivated 未开通服务。
中国站