创建企业认证链接
1. 接口描述
接口请求域名: ess.tencentcloudapi.com 。
本接口(CreateOrganizationAuthUrl)的主要功能是生成合作企业的认证链接。
在生成链接的过程中,可以提供一部分已知信息,以便为对方进行认证流程提供便利。
- 企业统一社会信用代码: 对应上图中的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 | 指定授权方式 支持多选:
示例值:[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 |
UniformSocialCreditCodeSame | 否 | Boolean | 对方打开链接认证时,对方填写的营业执照的社会信用代码是否与接口上传上来的要保持一致。
|
LegalNameSame | 否 | Boolean | 对方打开链接认证时,法人姓名是否要与接口传递上来的保持一致。
|
AdminNameSame | 否 | Boolean | 对方打开链接认证时,认证人姓名是否要与接口传递上来的保持一致。
|
AdminIdCardNumberSame | 否 | Boolean | 对方打开链接认证时,认证人居民身份证件号是否要与接口传递上来的保持一致。
|
AdminMobileSame | 否 | Boolean | 对方打开链接认证时,认证人手机号是否要与接口传递上来的保持一致。
|
OrganizationNameSame | 否 | Boolean | 对方打开链接认证时,企业名称是否要与接口传递上来的保持一致。
|
BusinessLicense | 否 | String | 营业执照正面照(支持PNG或JPG格式)需以base64格式提供,且文件大小不得超过5MB。 |
Endpoint | 否 | String | 跳转链接类型:
|
Initialization.N | 否 | Array of Integer | 指定企业初始化引导,现在可以配置如下的选项: 1: 启用此选项后,在企业认证的最终步骤将添加创建印章的引导。如下图的位置 示例值:1 |
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"
}
}
5. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
InternalError.System | 系统错误,请稍后重试。 |
InvalidParameter.AuthorizationType | 不合法的授权方式,请检查修改后重试。 |
InvalidParameter.EndPoint | 不合法的EndPoint,请检查修改后重试。 |
InvalidParameter.JumpUrl | 不合法的跳转链接,请联系电子签客服添加链接白名单。 |
MissingParameter.OrganizationId | 缺少机构ID参数。 |
OperationDenied.WhiteListForbid | 未开通功能白名单,请联系客服处理。 |