接口请求域名： faceid.intl.tencentcloudapi.com 。
每次调用Web核验服务前，需要先调用本接口获取BizToken，并保存此BizToken用来发起核验流程，并且在核验完成后获取结果信息，BizToken在10分钟内有效。
默认接口请求频率限制：20次/秒。
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：ApplyWebVerificationBizTokenIntl。 |
| Version | 是 | String | 公共参数，本接口取值：2018-03-01。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表。 |
| RedirectURL | 是 | String | 核验结束后重定向的Web回跳地址，包含协议头，主机名和路径，如：https://www.tencentcloud.com/products/faceid。 核验流程完成后，回跳地址会拼接当次流程的BizToken，以https://www.tencentcloud.com/products/faceid?token={BizToken}的格式进行跳转。 |
| CompareImageBase64 | 否 | String | 比对照片的base64编码字符串，base64编码后的字符串需要从编码字符串中删除Data URI scheme头部，并且大小不超过8MB。 |
| Extra | 否 | String | 业务透传参数，最大长度为1000个字符，会在GetWebVerificationResultIntl接口中返回。 |
| RuleId | 否 | String | 控制台配置生成的Id |
| Config | 否 | WebVerificationConfigIntl | 自定义核验页面的相关配置。 |
| 参数名称 | 类型 | 描述 |
|---|---|---|
| BizToken | String | 标识一次Web核验流程的令牌，有效时间为10分钟。流程结束后可用该令牌获取核验结果信息。 |
| VerificationURL | String | 本次核验流程的地址，返回给浏览器前端后打开此地址开始核验流程。 |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
申请Web核验服务Token
POST / HTTP/1.1
Host: faceid.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: GetWebFaceIDToken
<公共请求参数>
{
"CompareImageBase64": "xhBQAAACBjSFJNAAB6****AAAASUVORK5CYII=",
"RedirectURL": "https://www.tencentcloud.com/products/faceid",
"Extra": "ExtraString"
}
{
"Response": {
"VerificationURL": "https://intl.faceid.qq.com/reflect/?token=81EEF678-28EE-4759-A82E-6CBBBE6BC442",
"BizToken": "81EEF678-28EE-4759-A82E-6CBBBE6BC442",
"RequestId": "b16194cd-8f52-4e66-882a-eb6bf15c016d"
}
}
云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| InternalError | 内部错误。 |
| InvalidParameter | 参数错误。 |
| InvalidParameterValue | 参数取值错误。 |
| UnauthorizedOperation.ActivateError | 服务开通异常。 |
| UnauthorizedOperation.Activating | 服务开通中。 |
| UnauthorizedOperation.Arrears | 账号已欠费。 |
| UnauthorizedOperation.Nonactivated | 未开通服务。 |
文档反馈