创建企业认证链接

最近更新时间:2025-01-13 19:33:01

我的收藏

1. 接口描述

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

本接口(CreateOrganizationAuthUrl)的主要功能是生成合作企业的认证链接。

在生成链接的过程中,可以提供一部分已知信息,以便为对方进行认证流程提供便利。

image

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

:此接口需要 购买单独的实名套餐包方可调用,如有需求请联系对接人员评估

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:CreateOrganizationAuthUrl。
Version String 公共参数,本接口取值:2020-11-11。
Region String 公共参数,此参数为可选参数。
Operator UserInfo 操作人信息
AuthorizationTypes.N Array of Integer 指定授权方式 支持多选:


  • 1:上传授权书方式
  • 2: 法人授权方式
  • 3: 法人身份认证方式


示例值:[2,3]
OrganizationName String 认证企业名称,请确认该名称与企业营业执照中注册的名称一致。

注:

1. 如果名称中包含英文括号(),请使用中文括号()代替。

2. EndPointType=“H5”或者"SHORT_H5"时,该参数必填

示例值: 腾讯科技(深圳)有限公司
UniformSocialCreditCode String 企业统一社会信用代码
示例值:9144030071526726XG
LegalName String 企业法人的姓名
示例值:张三
AutoJumpUrl String 认证完成跳回的链接,最长500个字符
示例值:https://auth.qq.com/action-next?uid=12345
OrganizationAddress String 营业执照企业地址
示例值: 深圳市南山区高新区科技中一路腾讯大厦
AdminName String 认证人姓名
示例值:李四
AdminMobile String 认证人手机号
示例值:13200000000
AdminIdCardNumber String 认证人身份证号
示例值:620000198802020000
AdminIdCardType String 认证人证件类型, 支持以下类型
  • ID_CARD : 中国大陆居民身份证 (默认值)
  • HONGKONG_AND_MACAO : 中国港澳居民来往内地通行证
  • HONGKONG_MACAO_AND_TAIWAN : 中国港澳台居民居住证(格式同中国大陆居民身份证)


示例值:ID_CARD
UniformSocialCreditCodeSame Boolean 对方打开链接认证时,对方填写的营业执照的社会信用代码是否与接口上传上来的要保持一致。
  • false(默认值):关闭状态,实际认证时允许与接口传递的信息存在不一致。
  • true:启用状态,实际认证时必须与接口传递的信息完全相符。

示例值:false
LegalNameSame Boolean 对方打开链接认证时,法人姓名是否要与接口传递上来的保持一致。
  • false(默认值):关闭状态,实际认证时允许与接口传递的信息存在不一致。
  • true:启用状态,实际认证时必须与接口传递的信息完全相符。


p.s. 仅在法人姓名不为空时有效
示例值:false
AdminNameSame Boolean 对方打开链接认证时,认证人姓名是否要与接口传递上来的保持一致。
  • false(默认值):关闭状态,实际认证时允许与接口传递的信息存在不一致。
  • true:启用状态,实际认证时必须与接口传递的信息完全相符。


p.s. 仅在认证人姓名不为空时有效
示例值:false
AdminIdCardNumberSame Boolean 对方打开链接认证时,认证人居民身份证件号是否要与接口传递上来的保持一致。
  • false(默认值):关闭状态,实际认证时允许与接口传递的信息存在不一致。
  • true:启用状态,实际认证时必须与接口传递的信息完全相符。


p.s. 仅在认证人身份证号不为空时有效

示例值:false
AdminMobileSame Boolean 对方打开链接认证时,认证人手机号是否要与接口传递上来的保持一致。

  • false(默认值):关闭状态,实际认证时允许与接口传递的信息存在不一致。
  • true:启用状态,实际认证时必须与接口传递的信息完全相符。



p.s. 仅在认证人手机号不为空时有效
示例值:false
OrganizationNameSame Boolean 对方打开链接认证时,企业名称是否要与接口传递上来的保持一致。
  • false(默认值):关闭状态,实际认证时允许与接口传递的信息存在不一致。
  • true:启用状态,实际认证时必须与接口传递的信息完全相符。



p.s. 仅在企业名称不为空时有效
示例值:false
BusinessLicense String 营业执照正面照(支持PNG或JPG格式)需以base64格式提供,且文件大小不得超过5MB。
示例值:UEsDBBQACAAIAAAAAAAAAAAAAAAAAAAAAAANAAAAeGwvc3R5bGVzLnhtbKyYXW==
Endpoint String 跳转链接类型:


  • PC:适用于PC端的认证链接
  • APP:用于全屏或半屏跳转的小程序链接
  • SHORT_URL:跳转小程序的链接的短链形式
  • H5:适用于H5页面的认证链接
  • SHORT_H5:H5认证链接的短链形式



示例值:PC
Initialization.N Array of Integer 指定企业初始化引导,现在可以配置如下的选项:

1: 启用此选项后,在企业认证的最终步骤将添加创建印章的引导。如下图的位置
image
示例值:1
PowerOfAttorneys.N Array of String 授权书(PNG或JPG或PDF) base64格式, 大小不超过8M 。
授权书可以通过接口生成企业授权书 来获得。
p.s. 如果上传授权书 ,需遵循以下条件
1. 超管的信息(超管姓名,超管手机号)必须为必填参数。
2. 认证方式AuthorizationTypes必须只能是上传授权书方式
示例值:UEsDBBQACAAIAAAAAAAAAAAAAAAAAAAAAAANAAAAeGwvc3R5bGVzLnhtbKyYXW

3. 输出参数

参数名称 类型 描述
AuthUrl String 生成的认证链接。

注: 链接有效期统一30天
示例值:https://essurl.cn/24VopUGBZyF
ExpiredTime Integer 链接过期时间,格式为Unix标准时间戳(秒)
示例值:1733388643
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 创建企业认证链接

我们传递企业名称和企业的统一信用代码。同时,为了确保信息的准确性和合规性,我们要求在进行企业认证时,企业名称和统一信用代码必须与我们传递的信息完全一致。

输入示例

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

{
    "Operator": {
        "UserId": "yDwfsUUckpsqt647UE6uSrk1ZWhYH56z"
    },
    "Endpoint": "SHORT_URL",
    "AuthorizationTypes": [
        1,
        2,
        3
    ],
    "UniformSocialCreditCode": "9144030071526726XG",
    "OrganizationName": "典子谦示例企业",
    "UniformSocialCreditCodeSame": true,
    "OrganizationNameSame": true,
    "Initialization": [
        1
    ]
}

输出示例

{
    "Response": {
        "AuthUrl": "https://essurl.cn/24VopUGBZyF",
        "ExpiredTime": 1733388643,
        "RequestId": "a34b6e8e-4a3e-444d-8853-b34f90096254"
    }
}

示例2 创建企业认证链接-通过授权书上传

场景:创建企业认证链接, 通过超管授权书上传, 这个场景一般是法人不方便操作的时候使用
授权书的文件生成 可以通过接口生成企业授权书 然后转成 base64 格式。
但是必须得保证超管和创建企业认证是同一个人。

  1. AuthorizationTypes 必须且只能传递 1- 授权书认证。
  2. PowerOfAttorneys base64 格式的文件流 数组。 单个大小不能超过 8M。

输入示例

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

{
    "Operator": {
        "UserId": "yDwfsUUckpsqt647UE6uSrk1ZWhYH56z",
        "ClientIp": "8.8.8.8"
    },
    "Endpoint": "PC",
    "AuthorizationTypes": [
        1
    ],
    "AdminName": "典子谦",
    "AdminMobile": "13200000000",
    "BusinessLicense": "base64格式的营业执照文件流",
    "PowerOfAttorneys": [
        "base64格式的授权书文件流"
    ]
}

输出示例

{
    "Response": {
        "AuthUrl": "https://test.qian.tencent.cn/console/register-callback?token=yDCYOUUckp7aat8yUxJf7vsvwREPT0Th",
        "ExpiredTime": 1743070967,
        "RequestId": "s1735294966632123121"
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

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

错误码 描述
InternalError.System 系统错误,请稍后重试。
InvalidParameter.AuthorizationType 不合法的授权方式,请检查修改后重试。
InvalidParameter.EndPoint 不合法的EndPoint,请检查修改后重试。
InvalidParameter.JumpUrl 不合法的跳转链接,请联系电子签客服添加链接白名单。
MissingParameter.OrganizationId 缺少机构ID参数。
OperationDenied.WhiteListForbid 未开通功能白名单,请联系客服处理。