接口请求域名: faceid.intl.tencentcloudapi.com 。
完成活体检测流程后,用核验令牌(SdkToken)调用本接口查询对应核验结果信息。Token申请后2小时内有效,可多次调用。
默认接口请求频率限制:20次/秒。
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数,本接口取值:GetLivenessResult。 |
| Version | 是 | String | 公共参数,本接口取值:2018-03-01。 |
| Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
| SdkToken | 是 | String | 标识一次Sdk核验流程的令牌。 |
| 参数名称 | 类型 | 描述 |
|---|---|---|
| Result | String | 流程的最终结果 |
| Description | String | 流程的最终结果描述 |
| BestFrame | FileInfo | 人像截图 |
| Video | FileInfo | 检测过程视频 |
| RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
POST / HTTP/1.1
Host: faceid.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: GetLivenessResult
<公共请求参数>
{
"SdkToken": "D2B55F0C-FB5D-4FB6-8765-3E931EBBFC79"
}
{
"Response": {
"Video": {
"Url": "https://intl-reflect-h5-1257237511.cos.ap-guangzhou.myqcloud.com",
"MD5": "682e24b207acf1825286c1fceef5631c",
"Size": 9430792
},
"BestFrame": {
"Url": "https://intl-reflect-h5-1257237511.cos.ap-guangzhou.myqcloud.com",
"MD5": "667c2448b10b09ee9ec14ab2b0d36608",
"Size": 232267
},
"Description": "Failed to call the liveness engine",
"RequestId": "b8cb2269-08b2-426c-8be8-c7142c7e64e4",
"Result": "1001"
}
}
云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| InternalError | 内部错误。 |
| InvalidParameter | 参数错误。 |
| InvalidParameterValue.BizTokenExpired | BizToken过期。 |
| InvalidParameterValue.BizTokenIllegal | BizToken不合法。 |
| OperationDenied | 操作被拒绝。 |
文档反馈