人脸核身获取E证通Token-API 文档-文档中心-腾讯云

1. 接口描述

接口请求域名： faceid.tencentcloudapi.com 。

每次调用E证通服务前，需先调用本接口获取EidToken，用来串联E证通流程，在验证完成后，用于获取E证通结果信息。

默认接口请求频率限制：100次/秒。

推荐使用 API Explorer

点击调试

API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：GetEidToken。
Version	是	String	公共参数，本接口取值：2018-03-01。
Region	否	String	公共参数，本接口不需要传递此参数。
MerchantId	是	String	EID商户id，字段长度最长50位。示例值：3232
IdCard	否	String	身份标识（未使用OCR服务时，必须传入）。规则：a-z，A-Z，0-9组合。最长长度32位。
Name	否	String	姓名。（未使用OCR服务时，必须传入）最长长度32位。中文请使用UTF-8编码。
Extra	否	String	透传字段，在获取验证结果时返回。最长长度1024位。
Config	否	GetEidTokenConfig	小程序模式配置，包括如何传入姓名身份证的配置，以及是否使用意愿核身。
RedirectUrl	否	String	最长长度1024位。用户从Url中进入核身认证结束后重定向的回调链接地址。EidToken会在该链接的query参数中。
Encryption	否	Encryption	敏感数据加密信息。对传入信息（姓名、身份证号）有加密需求的用户可使用此参数，详情请点击左侧链接。

3. 输出参数

参数名称	类型	描述
EidToken	String	一次核身流程的标识，有效时间为600秒；完成核身后，可用该标识获取验证结果信息。示例值：CE661F1A-0F1E-45BD-BE13-34C05CEA7681
Url	String	发起核身流程的URL，用于H5场景核身。示例值：https://www.qq.com
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 鉴权操作

输入示例

POST / HTTP/1.1
Host: faceid.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: GetEidToken
<公共请求参数>

{
    "MerchantId": "3232"
}

输出示例

{
    "Response": {
        "EidToken": "CE661F1A-0F1E-45BD-BE13-34C05CEA7681",
        "RequestId": "f904f4cf-75db-4f8f-a5ec-dc4f942c7f7a",
        "Url": "https://open.weixin.qq.com/connect/oauth2/authorize?appid=wxa50a8ac379585f53&redirect_uri=https%3A%2F%2Feid.faceid.qq.com%2Fapi%2Fv1%2FGetOpenId%3Ftoken%3DCE661F1A-0F1E-45BD-BE13-34C05CEA7681&response_type=code&scope=snsapi_base&state=&component_appid=wx9802ee81e68d6dee#wechat_redirect"
    }
}

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

命令行工具

Tencent Cloud CLI 3.0

6. 错误码

以下仅列出了接口业务逻辑相关的错误码，其他错误码详见公共错误码。

错误码	描述
FailedOperation.DecryptSystemError	解密失败。
FailedOperation.StsUnAuthErrError	STS未授权。
FailedOperation.UnKnown	内部未知错误。
FailedOperation.UnregisteredEid	该用户未注册E证通，请先注册并跟权威库核验。
InvalidParameter	参数错误。
InvalidParameter.UnsupportEncryptField	存在不加密的字段，请参考文档修改。
InvalidParameterValue.RuleIdDisabled	该ruleid已被您停用，请确认后重试。
InvalidParameterValue.RuleIdNotExist	RuleId不存在，请到人脸核身控制台申请。
UnauthorizedOperation.Arrears	账号已欠费。
UnauthorizedOperation.NonAuthorize	账号未实名。
UnauthorizedOperation.Nonactivated	未开通服务。

获取E证通Token

本页目录：