跳到主要内容

通过AuthCode查询用户是否实名

1. 接口描述​

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

通过AuthCode查询用户是否实名

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

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

2. 输入参数​

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

参数名称必选类型描述
Action是String公共参数，本接口取值：DescribeThirdPartyAuthCode。
Version是String公共参数，本接口取值：2020-11-11。
Region否String公共参数，本接口不需要传递此参数。
AuthCode是String电子签小程序跳转客户小程序时携带的授权查看码

3. 输出参数​

参数名称类型描述
VerifyStatusString用户是否实名，VERIFIED 为实名，UNVERIFIED 未实名
RequestIdString唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 示例​

示例1 通过AuthCode查询用户是否实名​

通过AuthCode查询用户是否实名，AuthCode 查询后作废，只能查询一次

输入示例​

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

{
    "AuthCode": "xxxxxx*****code"
}

输出示例​

{
    "Response": {
        "RequestId": "s1629444337855318929",
        "VerifyStatus": "VERIFIED"
    }
}

示例2 测试用例​

输入示例​

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

{
    "AuthCode": "yDxAxU*******E4JGgr8S5"
}

输出示例​

{
    "Response": {
        "RequestId": "80905521-1203-41b1-9203-1eb2973cc488",
        "VerifyStatus": "VERIFIED"
    }
}

5. 开发者资源​

腾讯云 API 平台​

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector​

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。

SDK​

云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。

命令行工具​

6. 错误码​

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

错误码描述
FailedOperation操作失败。
InternalError内部错误。
InternalError.Db数据库异常。
InternalError.System系统错误，请稍后重试。
InvalidParameter参数错误。
InvalidParameter.ParamError参数错误。
MissingParameter.AuthCode授权码为空，请检查后重试。
OperationDenied.AuthCodeInvalid授权码已失效，请检查是否传递正确，是否已经过期，并在修改后重试。
UnauthorizedOperation.NoPermissionFeature请升级到对应版本后即可使用该接口。