同步企业信息
1. 接口描述
接口请求域名: essbasic.tencentcloudapi.com 。
此接口(SyncProxyOrganization)用于同步第三方平台子客企业信息,包括企业名称,企业营业执照,企业统一社会信用代码和法人姓名等,便于子客企业在企业激活过程中无需手动上传营业执照或补充企业信息。注意:
- 需要在子客企业激活前调用该接口,如果您的企业已经提交企业信息或者企业已经激活,同步的企业信息将不会生效。
- 如果您同时传递了营业执照信息和企业名称等信息,在认证过程中将以营业执照中的企业信息为准,请注意企业信息需要和营业执照信息对应。
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:SyncProxyOrganization。 |
Version | 是 | String | 公共参数,本接口取值:2021-05-26。 |
Region | 否 | String | 公共参数,此参数为可选参数。 |
Agent | 是 | Agent | 应用信息 此接口Agent.AppId、Agent.ProxyOrganizationOpenId必填 |
ProxyOrganizationName | 是 | String | 第三方平台子客企业名称,最大长度64个字符 |
BusinessLicense | 否 | String | 营业执照正面照(PNG或JPG) base64格式, 大小不超过5M |
UniformSocialCreditCode | 否 | String | 第三方平台子客企业统一社会信用代码,最大长度200个字符 |
ProxyLegalName | 否 | String | 第三方平台子客企业法人/负责人姓名 |
ProxyLegalIdCardType | 否 | String | 第三方平台子客企业法人/负责人证件类型,默认居民身份证(ID_CARD)类型,暂不支持其他类型 |
ProxyLegalIdCardNumber | 否 | String | 第三方平台子客企业法人/负责人证件号 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
RequestId | String | 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 同步企业信息
同步企业信息
输入示例
POST / HTTP/1.1
Host: essbasic.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: SyncProxyOrganization
<公共请求参数>
{
"ProxyOrganizationName": "子客企业名称",
"UniformSocialCreditCode": "code",
"BusinessLicense": "l",
"ProxyLegalName": "name",
"ProxyLegalIdCardType": "ID_CARD",
"ProxyLegalIdCardNumber": "666666200001011066",
"Agent": {
"ProxyOperator": {
"OpenId": "proxy-operator-openid"
},
"ProxyOrganizationOpenId": "proxy-organization-openid",
"AppId": "test-appid"
}
}
输出示例
{
"Response": {
"RequestId": "s16221***14775648"
}
}
5. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
FailedOperation | 操作失败。 |
InternalError | 内部错误。 |
InternalError.System | 系统错误。 |
InvalidParameter | 参数错误。 |
InvalidParameter.BusinessLicense | 营业执照格式不合法。 |
InvalidParameter.CardNumber | 证件号码错误。 |
InvalidParameter.CardType | 证件类型错误。 |
InvalidParameter.FileType | 文件类型不合法。 |
InvalidParameter.Name | 姓名不符合要求。 |
InvalidParameter.OrganizationId | OrganizationId不合法。 |
InvalidParameter.OrganizationName | 企业名称不合法。 |
InvalidParameter.ParamError | 参数错误。 |
InvalidParameter.UniformSocialCreditCode | 统一社会信用代码不符合要求 |
LimitExceeded.FileSize | 文件大小限制。 |
MissingParameter | 缺少参数错误。 |
OperationDenied | 操作被拒绝。 |
OperationDenied.BannedApplication | 应用号已被禁止。 |
OperationDenied.UserNotInOrganization | 用户不归属于当前企业,无法操作,请检查后重试。 |
ResourceNotFound | 资源不存在。 |
ResourceNotFound.Application | 应用号不存在。 |
ResourceNotFound.ApplicationId | ApplicationId不存在。 |
UnauthorizedOperation | 未授权操作。 |
UnauthorizedOperation.NoPermissionFeature | 请升级到对应版本后即可使用该接口。 |
UnknownParameter | 未知参数错误。 |
UnsupportedOperation | 操作不支持。 |