跳到主要内容

创建企业电子印章

1. 接口描述

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

本接口(CreateSeal)用于创建企业电子印章,支持创建企业公章,合同章,财务专用章和人事专用章创建。

  1. 可以通过图片创建印章,图片最大5MB
  2. 可以系统创建创建印章, 系统创建的印章样子下图(样式可以调整)

image

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

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

2. 输入参数

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

参数名称必选类型描述
ActionString公共参数,本接口取值:CreateSeal。
VersionString公共参数,本接口取值:2020-11-11。
RegionString公共参数,此参数为可选参数。
OperatorUserInfo

执行本接口操作的员工信息。
注: 在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。

SealNameString

电子印章名字,1-50个中文字符
注:同一企业下电子印章名字不能相同


示例值:公司印章
AgentAgent

代理企业和员工的信息。
在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。

GenerateSourceString

电子印章生成方式

  • 空值:(默认)使用上传的图片生成印章, 此时需要上传SealImage图片
  • SealGenerateSourceSystem: 系统生成印章, 无需上传SealImage图片

示例值:SealGenerateSourceSystem
SealTypeString

电子印章类型 , 可选类型如下:

  • OFFICIAL: (默认)公章
  • CONTRACT: 合同专用章;
  • FINANCE: 财务专用章;
  • PERSONNEL: 人事专用章
  • INVOICE: 发票专用章
  • OTHER: 其他
注: 同企业下只能有一个公章, 重复创建会报错


示例值:OFFICIAL
FileNameString

电子印章图片文件名称,1-50个中文字符。


示例值:印章图片.png
ImageString

电子印章图片base64编码,大小不超过10M(原始图片不超过5M),只支持PNG或JPG图片格式

注: 通过图片创建的电子印章,需电子签平台人工审核


示例值:imagecontentbase64
WidthInteger

电子印章宽度,单位px
参数不再启用,系统会设置印章大小为标准尺寸。


示例值:10
HeightInteger

电子印章高度,单位px
参数不再启用,系统会设置印章大小为标准尺寸。


示例值:20
ColorString

电子印章印章颜色(默认红色RED),RED-红色

系统目前只支持红色印章创建。


示例值:Red
SealHorizontalTextString

企业印章横向文字,最多可填15个汉字 (若超过印章最大宽度,优先压缩字间距,其次缩小字号)
横向文字的位置如下图中的"印章横向文字在这里"

image


示例值:横向文字
SealChordTextString

暂时不支持下弦文字设置


示例值:下弦文字
SealCentralTypeString

系统生成的印章只支持:STAR


示例值:Star
FileTokenString

通过文件上传时,服务端生成的电子印章上传图片的token


示例值:4GQptRKfMnJqX8
SealStyleString

印章样式, 可以选择的样式如下:

  • circle:(默认)圆形印章
  • ellipse:椭圆印章

示例值:circle
SealSizeString

印章尺寸,格式为 宽_高(单位:mm,整数),用于签署时按物理尺寸将印章加盖到PDF。
取值范围:
• 图片上传印章(Image 或 FileToken 非空时生效):支持自定义尺寸,宽、高均为 10-100 的整数(即 1cm-10cm),宽高比(宽/高)需在 0.1-10 之间。
• 系统生成印章(未传 Image 与 FileToken):仅支持与SealStyle 匹配的固定枚举值:
  - 圆形印章(SealStyle=cycle):38_38 / 40_40 / 42_42 / 45_45 / 50_50 / 58_58
  - 椭圆印章(SealStyle=ellipse):40_30 / 45_30
字段依赖关系:
• 与 SealStyle关联:仅系统生成印章场景下 SealStyle 生效,此时 SealSize 需与 SealStyle对应的枚举匹配;图片上传印章场景 SealStyle 会被忽略,SealSize支持自定义。
• 与 SealType 关联:公章/合同章仅支持圆形枚举,财务/人事/其它章支持圆形或椭圆枚举。
• 与 Image / FileToken 关联:SealSize 是加盖到 PDF的物理尺寸,与上传图片的像素分辨率无绑定,图片会按 SealSize 缩放渲染;建议上传图片的宽高比与 SealSize 保持一致,避免拉伸形变。


示例值:42_42
TaxIdentifyCodeString

企业税号
注:

  • 1.印章类型SealType是INVOICE类型时,此参数才会生效
  • 2.印章类型SealType是INVOICE类型,且该字段没有传入值或传入空时,会取该企业对应的统一社会信用代码作为默认的企业税号(如果是通过授权书授权方式认证的企业,此参数必传不能为空

示例值:lvCCkIZsXxFY
SealDescriptionString

印章描述内容


示例值:印章描述说明
Options.NArray of Option

个性化配置字段,默认不传。

3. 输出参数

参数名称类型描述
SealIdString

电子印章ID,为32位字符串。
建议开发者保留此印章ID,后续指定签署区印章或者操作印章需此印章ID。
可登录腾讯电子签控制台,在 "印章"->"印章中心"选择查看的印章,在"印章详情" 中查看某个印章的SealId(在页面中展示为印章ID)。


示例值:429b82b40900a9f870a90d45c715bad7
ImageUrlString

电子印章预览链接地址,地址默认失效时间为24小时。


示例值:https://file.test.ess.tencent.cn/bresource/resource/resource/0/0.JPG?hkey=xxxxxxxxxxxxxxxxxxxxxxxxxxx
SealOperatorVerifyPathString

人脸验证操作人链接,用法可以参考"跳转电子签小程序配置",默认为空。


示例值:/pages/guide/index?to=FACE_IDENTIFY&request_token=yDXXXXXXXXXXXXXX&expired_time=1758888888
SealOperatorVerifyQrcodeUrlString

人脸验证操作人二维码链接,扫码后会跳转到腾讯电子签小程序进行人脸验证,默认为空。


示例值:https://file.test.ess.tencent.cn/bresource/resource/resource/0/0.JPG?hkey=xxxxxxxxxxxxxxxxxxxxxxxxxxx
PreviewFileUrlString

创建印章预览逻辑,返回的是印章加盖在示例文件上的效果图片链接。链接有效期为90天。


示例值:https://file.test.ess.tencent.cn/bresource/resource/resource/0/0.JPG?hkey=xxxxxxxxxx
PreviewPdfUrlString

创建印章预览逻辑,返回的是印章加盖在示例文件上的效果PDF文件链接。链接有效期为90天。


示例值:https://file.test.ess.tencent.cn/bresource/resource/resource/0/0.PDF?hkey=xxxxxxxxxx
RequestIdString唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 创建企业电子印章

输入示例

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

{
"Operator": {
"UserId": "yDt2RUUckpfnij59UEF24JRO0rtOBcfq"
},
"SealName": "ceshi",
"SealSize": "42_42",
"SealType": "OTHER"
}

输出示例

{
"Response": {
"ImageUrl": "https://file.ess.tencent.cn/bresource/resource/resource/0/0.PNG?hkey=fa8b8ce5d7dcf25fc59ffb546fd5cbaf7ed002d7828ebfce597c2d5ce5ed99512d44b2e3e10f26498787639a93e7505f74d20125094e0a881938826d043be378b0aba5b586d651b4e08f8ea244c4053b&sign=713cc886c0292549929cb6d65757b21ad59079bbe535bc04a68f78df61dc2670",
"PreviewFileUrl": "",
"PreviewPdfUrl": "",
"RequestId": "62e859ea-9218-436a-bdce-3d94d6c56fe0",
"SealId": "yD3JaUUckpelefu5UxsWLnwv3JrS25PH",
"SealOperatorVerifyPath": "",
"SealOperatorVerifyQrcodeUrl": ""
}
}

5. 错误码

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

错误码描述
FailedOperation操作失败。
FailedOperation.FailedConverToQiWeiUserId发起人未在企微实名
FailedOperation.FailedOpenWkAppReview企业未开启审批功能,客户自己设置关闭了
FailedOperation.FailedUpdateTemplateOperation未更新模板
InternalError内部错误。
InternalError.Decryption解密失败。
InternalError.DependsApi依赖的第三方API返回错误。
InternalError.DependsDb数据库执行错误。
InternalError.Encryption加密失败。
InternalError.System系统错误,请稍后重试。
InvalidParameter.ParamError参数错误。
OperationDenied操作被拒绝。
OperationDenied.AlreadyHas当前用户创建的数据已经存在了,不需要重复调用。
OperationDenied.Forbid禁止此项操作。
OperationDenied.NoLogin用户未登录,请先登录后再操作。
OperationDenied.OrganizationClosing企业注销中
OperationDenied.SubOrgNotJoin子企业暂未加入。
ResourceNotFound.WeWorkUser所有审批人未在企微实名
更多开发者交流反馈