跳到主要内容

同步企业信息

1. 接口描述​

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

此接口（SyncProxyOrganization）用于同步第三方平台子客企业信息，包括企业名称、企业营业执照、企业统一社会信用代码和法人姓名等，便于子客企业在企业激活过程中无需手动上传营业执照或补充企业信息。

注意：

  • 需要在生成子客登录链接前同步的企业信息, 否则会出现信息同步没有用的情形
  • 企业信息需要和营业执照信息对应, 否则会出现激活过程验证不通过的问题

image

  • 企业统一社会信用代码: 对应上图中的1
  • 第三方平台子客企业名称: 对应上图中的2
  • 企业法定代表人的名字:对应上图中的3
  • 企业详细住所:对应上图中的4

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

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

2. 输入参数​

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

参数名称必选类型描述
Action是String公共参数，本接口取值：SyncProxyOrganization。
Version是String公共参数，本接口取值：2021-05-26。
Region否String公共参数，此参数为可选参数。
Agent是Agent关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。

此接口下面信息必填。

  • 渠道应用标识: Agent.AppId
  • 第三方平台子客企业标识: Agent.ProxyOrganizationOpenId


ProxyOrganizationName是String第三方平台子客企业名称，请确认该名称与企业营业执照中注册的名称一致。
注: 如果名称中包含英文括号()，请使用中文括号（）代替。
示例值：张三示例企业
BusinessLicense否String营业执照正面照(PNG或JPG) base64格式, 大小不超过5M
示例值：aHR0cHM6Ly9jYXBpLndvYS5jb20vhaWwlM0ZpZCUzRGVzc2Jhc2ljJTI2dGFiJTNEYXBp..图片base64省略
UniformSocialCreditCode否String第三方平台子客企业统一社会信用代码，最大长度200个字符
示例值：BOLIU101304662708A
ProxyLegalName否String第三方平台子客企业法定代表人的名字
示例值：张三
ProxyLegalIdCardType否String第三方平台子客企业法定代表人的证件类型，支持以下类型
  • ID_CARD : 中国大陆居民身份证 (默认值)

注: 现在仅支持ID_CARD中国大陆居民身份证类型
示例值：ID_CARD
ProxyLegalIdCardNumber否String第三方平台子客企业法定代表人的证件号码, 应符合以下规则
  • 中国大陆居民身份证号码应为18位字符串，由数字和大写字母X组成（如存在X，请大写）。

示例值：620000198802020000
ProxyAddress否String第三方平台子客企业详细住所，最大长度500个字符

注：需要符合省市区详情的格式例如： XX省XX市XX区街道具体地址
示例值：深圳市南山区高新区科技中一路腾讯大厦35层

3. 输出参数​

参数名称类型描述
RequestIdString唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例​

示例1 同步企业信息​

同步企业信息

输入示例​

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

{
    "ProxyOrganizationName": "典子谦示例企业",
    "UniformSocialCreditCode": "BOLIU101304662708A ",
    "BusinessLicense": "aHR0cHM6Ly9jYXBpLndvYS5jb20vhaWwlM0ZpZCUzRGVzc2Jhc2ljJTI2dGFiJTNEYXBp..图片base64省略",
    "ProxyLegalName": "典子谦",
    "ProxyLegalIdCardType": "ID_CARD",
    "ProxyLegalIdCardNumber": "620000198802020000",
    "Agent": {
        "ProxyOperator": {
            "OpenId": "n31517"
        },
        "ProxyOrganizationOpenId": "org_zhansan",
        "AppId": "yDwhxUUckp3gl8j5UuFX33LSNozpRsbi"
    }
}

输出示例​

{
    "Response": {
        "RequestId": "8fb09e62-9642-44c8-992b-ddd6e5086293"
    }
}

5. 错误码​

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

错误码描述
FailedOperation操作失败。
InternalError内部错误。
InternalError.System系统错误。
InvalidParameter参数错误。
InvalidParameter.BusinessLicense营业执照格式不合法。
InvalidParameter.CardNumber证件号码错误。
InvalidParameter.CardType证件类型错误。
InvalidParameter.FileType文件类型不合法。
InvalidParameter.Name姓名不符合要求。
InvalidParameter.OrganizationIdOrganizationId不合法。
InvalidParameter.OrganizationName企业名称不合法。
InvalidParameter.ParamError参数错误。
InvalidParameter.UniformSocialCreditCode统一社会信用代码不符合要求
LimitExceeded.FileSize文件大小限制。
MissingParameter缺少参数错误。
OperationDenied操作被拒绝。
OperationDenied.BannedApplication应用号已被禁止。
OperationDenied.UserNotInOrganization用户不归属于当前企业，无法操作，请检查后重试。
ResourceNotFound资源不存在。
ResourceNotFound.Application应用号不存在。
ResourceNotFound.ApplicationIdApplicationId不存在。
UnauthorizedOperation未授权操作。
UnauthorizedOperation.NoPermissionFeature请升级到对应版本后即可使用该接口。
UnknownParameter未知参数错误。
UnsupportedOperation操作不支持。
更多开发者交流反馈