查询企业认证状态
1. 接口描述
接口请求域名: ess.tencentcloudapi.com 。
查询企业认证状态- 仅通过CreateOrganizationAuthUrl 和CreateBatchOrganizationRegistrationTasks这两个接口进行引导认证的企业,调用方企业可以依据这个接口,查询认证状态。
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:DescribeOrganizationAuthStatus。 |
Version | 是 | String | 公共参数,本接口取值:2020-11-11。 |
Region | 否 | String | 公共参数,此参数为可选参数。 |
Operator | 是 | UserInfo | 执行本接口操作的员工信息。使用此接口时,必须填写userId。 支持填入集团子公司经办人 userId 代发合同。 注: 在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。 |
OrganizationName | 否 | String | 组织机构名称。 请确认该名称与企业营业执照中注册的名称一致。 如果名称中包含英文括号(),请使用中文括号()代替。 |
UniformSocialCreditCode | 否 | String | 企业统一社会信用代码 注意:OrganizationName和UniformSocialCreditCode不能同时为空 |
LegalName | 否 | String | 法人姓名 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
IsVerified | Boolean | 企业是否已认证 |
AuthStatus | Integer | 企业认证状态 0-未认证 1-认证中 2-已认证 |
AuthRecords | Array of AuthRecord | 企业认证信息 |
OrganizationId | String | 企业在腾讯电子签平台的唯一身份标识,为32位字符串。 可登录腾讯电子签控制台,在 "更多"->"企业设置"->"企业中心"- 中查看企业电子签账号。 p.s. 只有当前企业认证成功的时候返回 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 查询企业认证状态
查询企业认证状态
输入示例
POST / HTTP/1.1
Host: ess.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeOrganizationAuthStatus
<公共请求参数>
{
"Operator": {
"UserId": "yDRCLUUgygq2xun5UuO4zjEwg0vjoimj"
},
"UniformSocialCreditCode": "",
"LegalName": "",
"OrganizationName": "测试企业"
}
输出示例
{
"Response": {
"AuthRecords": [
{
"AuditStatus": 0,
"AuthType": 3,
"OperatorMobile": "132****0000",
"OperatorName": "典*谦"
}
],
"AuthStatus": 2,
"IsVerified": true,
"RequestId": "s1687254031099376002"
}
}
5. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
InternalError.System | 系统错误,请稍后重试。 |
MissingParameter.OrgNameOrUniformSocialCreditCode | 参数缺失,企业名称和统一信用代码不能同时为空。 |
MissingParameter.OrganizationId | 缺少机构ID参数。 |
OperationDenied.WhiteListForbid | 未开通功能白名单,请联系客服处理。 |