1. 接口描述
接口请求域名： faceid.tencentcloudapi.com 。
每次调用人脸核身SDK服务前，需先调用本接口获取SDKToken，用来串联核身流程，在验证完成后，用于获取验证结果信息，该token仅能核身一次。
默认接口请求频率限制：100次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：GetFaceIdToken。 |
| Version | 是 | String | 公共参数，本接口取值：2018-03-01。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表，本接口仅支持其中的: ap-beijing, ap-chengdu, ap-guangzhou, ap-shanghai 。 |
| CompareLib | 是 | String | 比对库。 - 取值范围： LOCAL：本地上传照片。 BUSINESS：商业库。 示例值：BUSINESS |
| IdCard | 否 | String | 身份证。 - CompareLib为商业库时必传。 示例值：11204416541220243X |
| Name | 否 | String | 姓名。 - CompareLib为商业库时必传。 示例值：韦小宝 |
| ImageBase64 | 否 | String | 图片的Base64。 - CompareLib为上传照片比对时必传。 - Base64后图片最大8MB。 - 请使用标准的Base64编码方式(带=补位)，编码规范参考RFC4648。 示例值：/9j/4AAQSkZJRg.....s97n//2Q== |
| Meta | 否 | String | SDK中生成的Meta字符串。 示例值："" |
| Extra | 否 | String | 透传参数。 - 1000长度字符串 示例值："" |
| UseCos | 否 | Boolean | 是否使用cos桶。 - 默认为false。 - 设置该参数为true后，核身过程中的视频图片将会存储在人脸核身控制台授权cos的bucket中，拉取结果时会返回对应资源完整cos地址。 - 开通地址见https://console.cloud.tencent.com/faceid/cos - 【注意】选择该参数为true后将不返回base64数据，请根据接入情况谨慎修改。 示例值：true |
| Encryption | 否 | Encryption | 敏感数据加密信息。对传入信息（姓名、身份证号）有加密需求的用户可使用此参数，详情请点击左侧链接。 |
| RuleId | 否 | String | 用于细分客户使用场景。 - 申请开通服务后，可以在腾讯云慧眼人脸核身控制台（https://console.cloud.tencent.com/faceid） 自助接入里面创建，审核通过后即可调用。 - 如有疑问，请添加腾讯云人脸核身小助手进行咨询。 示例值：12 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| FaceIdToken | String | token值。- 有效期 10分钟。- 只能完成1次核身。 示例值：42S4B131D-5974-4674-EABB-8FFF1EC99F189 |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 获取 SDK 核验 token成功
获取 SDK 核验 token。
输入示例
POST / HTTP/1.1
Host: faceid.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: GetFaceIdToken
<公共请求参数>
{
"CompareLib": "BUSINESS",
"IdCard": "11204416541220243X",
"Name": "韦小宝"
}输出示例
{
"Response": {
"FaceIdToken": "42S41B31D-5974-4674-EABB-8FFF1EC99F819",
"RequestId": "94b54cdf-d975-4718-b091-32f8d79d6397"
}
}示例2 获取 SDK 核验 token失败
获取 SDK 核验 token失败，传入图片尺寸过大。
输入示例
POST / HTTP/1.1
Host: faceid.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: GetFaceIdToken
<公共请求参数>
{
"CompareLib": "BUSINESS",
"IdCard": "440305199505132561",
"Name": "刘洋"
}输出示例
{
"Response": {
"Error": {
"Code": "FailedOperation.ImageSizeTooLarge",
"Message": "图片尺寸过大。"
},
"RequestId": "ae8fbee0-f20e-4651-896e-e21e80d3822a"
}
}5. 开发者资源
腾讯云 API 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。
API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。
SDK
云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python: GitHub Gitee
- Tencent Cloud SDK 3.0 for Java: GitHub Gitee
- Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
- Tencent Cloud SDK 3.0 for Go: GitHub Gitee
- Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
- Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
- Tencent Cloud SDK 3.0 for C++: GitHub Gitee
- Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| FailedOperation.DecryptSystemError | 解密失败。 |
| FailedOperation.ImageSizeTooLarge | 图片尺寸过大。 |
| FailedOperation.UnKnown | 内部未知错误。 |
| InvalidParameter | 参数错误。 |
| UnauthorizedOperation.Arrears | 账号已欠费。 |
| UnauthorizedOperation.Nonactivated | 未开通服务。 |
