创建企业认证链接
1. 接口描述
接口请求域名: ess.tencentcloudapi.com 。
本接口(CreateOrganizationAuthUrl)用于生成创建企业认证链接。 用于业务方系统自己生成认证链接进行跳转.而不用电子签自带的生成链接
注: 此接口需要购买单独的实名套餐包方可调用,如有需求请联系对接人员评估
默认接口请求频率限制: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- 法人身份认证方式 |
OrganizationName | 否 | String | 企业名称 EndPointType=“H5”或者"SHORT_H5"时,该参数必填 |
UniformSocialCreditCode | 否 | String | 企业统一社会信用代码 |
LegalName | 否 | String | 法人姓名 |
AutoJumpUrl | 否 | String | 认证完成跳转链接 |
OrganizationAddress | 否 | String | 营业执照企业地址 示例:xx省xx市xx县/区xx街道 |
AdminName | 否 | String | 认证人姓名 |
AdminMobile | 否 | String | 认证人手机号 |
AdminIdCardNumber | 否 | String | 认证人身份证号 |
AdminIdCardType | 否 | String | 认证人证件类型 支持以下类型
|
UniformSocialCreditCodeSame | 否 | Boolean | 营业执照的社会信用代码保持一致 false 关闭-默认 true 开启 |
LegalNameSame | 否 | Boolean | 法人姓名保持一致 false 关闭-默认 true 开启 |
AdminNameSame | 否 | Boolean | 认证人姓名一致 false 关闭-默认 true 开启 注意: 开启后在认证过程前会校验拦截 |
AdminIdCardNumberSame | 否 | Boolean | 认证人居民身份证件号一致 false 关闭-默认 true 开启 注意: 开启后在认证过程前会校验拦截 |
AdminMobileSame | 否 | Boolean | 认证人手机号一致 false 关闭-默认 true 开启 注意: 开启后在认证过程前会校验拦截 |
OrganizationNameSame | 否 | Boolean | 企业名称保持一致 false 关闭-默认 true 开启 |
BusinessLicense | 否 | String | 营业执照正面照(PNG或JPG) base64格式, 大小不超过5M |
Endpoint | 否 | String | 跳转链接类型: "PC"-PC端认证链接 "APP"-全屏或半屏跳转小程序链接 “H5”-H5页面认证链接 "SHORT_H5"- H5认证短链 "SHORT_URL"- 跳转小程序短链 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
AuthUrl | String | “H5”-H5长连接 "SHORT_H5"- H5短链 "APP"-小程序 "PC"-PC浏览器 链接有效期统一30天 |
ExpiredTime | Integer | 链接过期时间戳 |
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": "PC",
"AuthorizationTypes": [
1,
2,
3
],
"LegalName": "11",
"UniformSocialCreditCode": "11",
"OrganizationName": "测试企业123123",
"AutoJumpUrl": "https://xxxx.com.cn/xxx"
}
输出示例
{
"Response": {
"AuthUrl": "https://test.qian.tencent.cn/console/register-callback?token=yDwFJUUckpsxxxxxWaLrSa3zzlXQh",
"ExpiredTime": 1668010213,
"RequestId": "s168499xxxxx2608083"
}
}
5. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
InternalError.System | 系统错误,请稍后重试。 |
InvalidParameter.AuthorizationType | 不合法的授权方式,请检查修改后重试。 |
InvalidParameter.EndPoint | 不合法的EndPoint,请检查修改后重试。 |
InvalidParameter.JumpUrl | 不合法的跳转链接,请联系电子签客服添加链接白名单。 |
MissingParameter.OrganizationId | 缺少机构ID参数。 |
OperationDenied.WhiteListForbid | 未开通功能白名单,请联系客服处理。 |