1. 接口描述
接口请求域名： ess.tencentcloudapi.com 。
用于客户企业在调用生成C端用户实名链接（CreateUserVerifyUrl）接口之前判断C端用户是否实名，如果已经实名，就不需要再次调用生成C端链接接口去实名
注意：此接口仅会返回当前员工是否通过C端用户实名链接（CreateUserVerifyUrl）所实名的员工是否实名，并不会返回个人用户自己在电子签进行实名的状况
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：DescribeUserVerifyStatus。 |
| Version | 是 | String | 公共参数，本接口取值：2020-11-11。 |
| Region | 否 | String | 公共参数，此参数为可选参数。 |
| Operator | 是 | UserInfo | 用户信息 |
| Name | 是 | String | 姓名 |
| IdCardNumber | 是 | String | 证件号码，应符合以下规则
|
| IdCardType | 是 | String | 证件类型，支持以下类型
|
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| VerifyStatus | Boolean | true:表示已实名 false：表示未实名 示例值：false |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 通过二要素查询用户是否实名
通过二要素查询用户是否实名
输入示例
POST / HTTP/1.1
Host: ess.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeUserVerifyStatus
<公共请求参数>
{
"Operator": {
"UserId": "abc"
},
"Name": "abc",
"IdCardNumber": "abc",
"IdCardType": "ID_CARD"
}输出示例
{
"Response": {
"VerifyStatus": true,
"RequestId": "abc"
}
}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. 错误码
该接口暂无业务逻辑相关的错误码，其他错误码详见 公共错误码。