接口请求域名: faceid.intl.tencentcloudapi.com 。
每次调用活体人脸比对SDK服务前,您需先调用本接口获取SDK的Token用来串联身份认证全流程,并在验证完成后使用对应的Token获取验证结果信息,一个Token仅能完成一次身份认证。
默认接口请求频率限制:20次/秒。
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数,本接口取值:GetFaceIdTokenIntl。 |
| Version | 是 | String | 公共参数,本接口取值:2018-03-01。 |
| Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
| CheckMode | 否 | String | 表示检测模式,参数取值如下: |
| SecureLevel | 否 | String | 表示认证的安全等级,安全等级分为: |
| Image | 否 | String | 比对照片的base64编码,用于“活体比对”模式。当参数CheckMode为“compare”时,本参数必传。 |
| Extra | 否 | String | 业务透传参数,如无特殊需求本参数可以不传。 |
| ActionList | 否 | String | 此接口用于控制动作序列,动作类型如下: |
| SdkVersion | 否 | String | PLUS:PLUS版,PRO:PRO版,ENHANCED:增强版,BASIC:基础版(默认) |
| RetryLimit | 否 | Integer | 活体重试次数 取值范围:[1, 5] 默认值:5 |
| EnableBotBgDetection | 否 | Boolean | 是否开启泰国银行专属的背景检测。 默认值:false |
| MetaData | 否 | String | 终端侧SDK生成的设备相关的加密信息 |
| 参数名称 | 类型 | 描述 |
|---|---|---|
| SdkToken | String | SdkToken,用来串联核身流程,通过该Token可以拉取核身结果,每个SdkToken的有效期为10分钟。 |
| ServerParamInfo | String | 服务端生成的本次核验的加密配置信息 |
| RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
指定活体重试次数,调用成功
POST / HTTP/1.1
Host: faceid.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: GetFaceIdTokenIntl
<公共请求参数>
{
"CheckMode": "liveness",
"RetryLimit": 1
}
{
"Response": {
"RequestId": "ace1147a-d761-49a2-a180-0c95263b50ff",
"SdkToken": "C8CFF283-539AF-014E77-A5CF-DD9CAD93EFE2"
}
}
云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| FailedOperation.ImageSizeTooLarge | 图片尺寸过大。 |
| InternalError | 内部错误。 |
| InvalidParameter | 参数错误。 |
文档反馈