有奖捉虫:办公协同&微信生态&物联网文档专题 HOT
文档中心 > 腾讯电子签 > API 文档 > 个人账号管理相关接口 > 通过AuthCode查询个人用户是否实名

1. 接口描述

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

通过AuthCode查询个人用户是否实名

注意:

  • 此接口为合作引流场景使用,使用有白名单限制,使用前请联系对接的客户经理沟通。
  • AuthCode 只能使用一次,查询一次再次查询会返回错误

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeThirdPartyAuthCode。
Version String 公共参数,本接口取值:2020-11-11。
Region String 公共参数,此参数为可选参数。
AuthCode String 腾讯电子签小程序跳转客户企业小程序时携带的授权查看码,AuthCode由腾讯电子签小程序生成。
示例值:yDxMhUyKQDMFdnUyxgEv8yhSdo0ZFs8I
Operator UserInfo 执行本接口操作的员工信息。
注: 在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。
Agent Agent 代理企业和员工的信息。
在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。

3. 输出参数

参数名称 类型 描述
VerifyStatus String AuthCode 中对应个人用户是否实名

  • VERIFIED : 此个人已实名
  • UNVERIFIED: 此个人未实名

示例值:VERIFIED
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

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

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

输入示例

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

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

输出示例

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

示例2 通过AuthCode查询用户是否实名(失效AuthCode)

AuthCode已经使用过一次, 再次查询返回错误OperationDenied.AuthCodeInvalid

输入示例

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

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

输出示例

{
    "Response": {
        "Error": {
            "Code": "OperationDenied.AuthCodeInvalid",
            "Message": "授权码已失效"
        },
        "RequestId": "c6a50bbc-fe84-4744-8c16-efe33f80d632"
    }
}

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 请升级到对应版本后即可使用该接口。