接口请求域名： faceid.intl.tencentcloudapi.com 。
身份验证流程结束后，使用SdkToken调用本接口可获取对应的认证结果信息，SdkToken生成后两小时内（2*3,600秒）可多次拉取。
默认接口请求频率限制：20次/秒。
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：GetFaceIdResultIntl。 |
| Version | 是 | String | 公共参数，本接口取值：2018-03-01。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表。 |
| SdkToken | 是 | String | 活体人脸比对SDK流程的标识，调用GetFaceIdTokenIntl接口时生成，支持查询3天内生成的SdkToken对应的核身结果。 |
| 参数名称 | 类型 | 描述 |
|---|---|---|
| Result | String | 业务核验结果的返回码: 0: 成功 1001: 系统错误 1004: 活体人脸检测失败 2004: 传入照片过大或过小 2012: 检测到多张人脸 2013: 未检测到人脸或人脸不完整 2014: 照片清晰度太低或质量不达标 2015: 人脸比对失败 2016: 比对相似度未达到标准通过阈值 -999: 核身流程未完成 |
| Description | String | 业务核验结果的描述 |
| BestFrame | String | 用户认证过程中截取的最佳帧图片，格式为base64。 |
| Video | String | 用户认证的视频文件，用于身份验证，包含特定颜色反射效果，格式为base64。 |
| ActionVideo | String | 记录用户执行的特定动作，用于AI人脸防护盾分析。 |
| Similarity | Float | 比对相似度，取值范围为0-100，数值越大表示相似度越高。该参数仅“活体比对模式”下返回。 注意：此字段可能返回 null，表示取不到有效值。 |
| Extra | String | 透传参数 注意：此字段可能返回 null，表示取不到有效值。 |
| DeviceInfoLevel | String | 描述当前请求所在设备的风险等级，共4级。 详情如下： 1 - 安全。 2 - 低风险。 3 - 中风险。 4 - 高危。 空 - 未获取到风险等级。 仅增强版返回，默认为空。 |
| LivenessInfoTag | Array of String | plus版：描述当前请求活体阶段被拒绝的详细原因。 详情如下： 01-用户全程闭眼。 02-用户未完成指定动作。 03-疑似翻拍攻击。 04-疑似合成图片。 05-疑似合成视频。 06-疑似合成动作。 07-疑似黑产模板。 08-疑似存在水印。 09-反光校验未通过。 10-最佳帧校验未通过。 11-人脸质量过差。 12-人脸距离不匹配。 13-疑似对抗样本攻击。 null-无。 增强版：此字段不生效，默认为null。 注意：此字段可能返回 null，表示取不到有效值。 |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
POST / HTTP/1.1
Host: faceid.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: GetFaceIdResultIntl
<公共请求参数>
{
"SdkToken": "FA05EE15-53114-0143A5-AFCA-24F0338535B2"
}
{
"Response": {
"ActionVideo": "/9j/4AAQSkZJRg.....s97n//2Q==",
"BestFrame": "/9j/4AAQSkZJRg.....s97n//2Q==",
"Description": "Success",
"DeviceInfoLevel": "",
"Extra": "",
"LivenessInfoTag": null,
"RequestId": "7680b762-d1d3-4dd3-90e8-5d1c0030116b",
"Result": "0",
"Similarity": 0,
"Video": "/9j/4AAQSkZJRg.....s97n//2Q=="
}
}
云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| InternalError | 内部错误。 |
| InvalidParameter | 参数错误。 |
| InvalidParameterValue.BizTokenExpired | BizToken过期。 |
| InvalidParameterValue.BizTokenIllegal | BizToken不合法。 |
| OperationDenied | 操作被拒绝。 |
文档反馈