跳到主要内容

批量清除未认证的企业认证流

1. 接口描述

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

批量清理未认证的企业认证流程。

此接口用来清除企业方认证信息填写错误,批量清理认证中的认证流信息。 为接口创建企业批量认证链接查询企业批量认证链接 接口的扩展接口。即在批量认证过程中,当发起认证企业发现超管信息错误的时候,可以将当前超管下的所有认证流企业清除。

注意: 这个接口的操作人必须跟生成批量认证链接接口的操作人一致,才可以调用,否则会返回当前操作人没有认证中的企业认证流

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

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

2. 输入参数

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

参数名称必选类型描述
ActionString公共参数,本接口取值:DeleteOrganizationAuthorizations。
VersionString公共参数,本接口取值:2020-11-11。
RegionString公共参数,此参数为可选参数。
OperatorUserInfo执行本接口操作的员工信息, userId 必填。
注: 在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。
AuthorizationIds.NArray of String认证流Ids数组
认证流 Id 是指在企业认证过程中,当前操作人的认证流程的唯一标识。每个企业在认证过程中只能有一条认证流认证成功。这意味着在同一认证过程内,一个企业只能有一个认证流程处于成功状态,以确保认证的唯一性和有效性。


认证流 Id可以通过回调 授权书认证审核结果回调 获取

注意:
如果传递了认证流Id,则下面的参数 超管二要素不会生效
示例值:yDCHHUUckpbdaiqbUxJVsHWy99WG6kTY
AdminNameString认证人姓名,组织机构超管姓名。
在注册流程中,必须是超管本人进行操作。
示例值:张三
AdminMobileString认证人手机号,组织机构超管手机号。 在注册流程中,必须是超管本人进行操作。
示例值:18888888888
AgentAgent代理企业和员工的信息。在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。

3. 输出参数

参数名称类型描述
DeleteOrganizationAuthorizationInfosArray of DeleteOrganizationAuthorizationInfo清理的认证流的详细信息,其中包括企业名称,认证流唯一 Id 以及清理过程中产生的错误信息
StatusInteger批量清理认证流返回的状态值
其中包括
- 1 全部成功
- 2 部分成功
- 3 全部失败
示例值:1
RequestIdString唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 批量清理张三的所有认证中的认证流

  1. 企业典子谦示例企业 通过生成批量认证接口生成了 两个认证企业 (张三示例企业一, 张三示例企业二)
  2. 此时操作人典子谦示例企业 的业务员典子谦 发现超管应该是李四,信息填写错误,希望批量清除之前写错的信息,进行重新认证。
  3. 此时传递超管的姓名和手机号, 来进行清理。
  4. 全部清理成功,status 返回为 1

输入示例

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

{
"Operator": {
"UserId": "yDRCLUUgygq2xun5UuO4zjEwg0vjoimj",
"ClientIp": "8.8.8.8"
},
"AdminName": "张三",
"AdminMobile": "18888888888"
}

输出示例

{
"Response": {
"DeleteOrganizationAuthorizationInfos": [
{
"AuthorizationId": "yDCkRUUckp4mrr1mUuZT4VduiD2OfBVC",
"Errormessage": "",
"OrganizationName": "张三示例企业一"
},
{
"AuthorizationId": "yDCkRUUckp4mrro0UuZT4VdvxIeRvyX0",
"Errormessage": "",
"OrganizationName": "张三示例企业一"
}
],
"RequestId": "s1729853630232230428",
"Status": 1
}
}

5. 错误码

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

错误码描述
FailedOperation操作失败。
InternalError内部错误。
InternalError.Db数据库异常。
InternalError.System系统错误,请稍后重试。
InvalidParameter.DataNotFound数据不存在。
InvalidParameter.Mobile不合法的手机号,请检查后重试。
InvalidParameter.ParamError参数错误。
InvalidParameterValue参数取值错误。
MissingParameter缺少参数错误。
OperationDenied操作被拒绝。
OperationDenied.NoLogin用户未登录,请先登录后再操作。
ResourceUnavailable资源不可用。
更多开发者交流反馈
购买咨询
微信客服
4006-808-062
4006-808-062