通过页面发起签署

更新时间:2024-09-24 15:51:25

接口描述

通过此接口开发者将获取到一个发起签署可视化页面(免登录),由用户在此页面中选择签署文件、签署方等,并设置签署区位置等相关信息,页面发起签署流程后,开发者通过《签署发起成功通知》接收签署流程ID(signFlowId)。该接口获取到的发起签署页面参考:

注意事项

1. 接口中预设置的信息(签署文件、签署方、签署区等),页面允许用户在此基础上进行添加,不允许用户编辑和修改。

2. 单个签署流程中对签署文件(docs)要求如下:

  • 单个签署流程中所添加的文件个数不可超过50个。
  • 单个文件大小不可超过50MB。
  • 单个文件内单页大小不可超过20MB(文件内含图片时,需特别关注单页大小)。
  • 单个签署流程中所添加的文件大小总和不可超过500MB。

3. 单个签署流程中所添加的签署方(signers)不要超过10个,且每个签署方对应一个签署主体(个人或机构)。

4. 单个签署流程中所添加的签署区(signFields)总和不要超过300个。

接口地址&请求方法

点击下述蓝色字体{host}可跳转至API请求域名说明文档

接口地址:https://{host}/v3/sign-flow/sign-flow-initiate-url/by-file

请求方法:POST

请求头格式

具体请求头参数,请查看公共请求头格式。

请求参数

展开全部参数参数名称(点击左侧“+”一键展开参数)

参数类型

必选

参数位置

参数说明(请左右滑动查看完整描述)

initiatePageConfig(点击“+”展开详情)

object

否

body

发起签署页面配置项

customBizNum

string

否

body

自定义业务编号(用于关联开发者的业务系统,流程发起成功后将在签署发起成功通知中和签署流程ID一同返回)

【注】接口不对该参数的值做重复性校验。

initiateButtons

string

否

body

页面中展示的发起按钮,默认值为1,2(按钮全部展示,英文逗号分隔)

1 - 立即发起,2 - 指定位置发起

  • 传1- 立即发起:将依据接口中设置的签署区位置信息发起签署流程,接口中未指定签署区时,则由签署方自由签署;
  • 传2 - 指定位置发起:允许用户在页面中选择拖拽签署区,设置签署位置(接口中若设置了签署区,页面不可编辑修改,允许再增加)。

redirectUrl

string

否

body

页面发起流程成功后的跳转地址(需符合 https /http 协议地址)

补充说明:

  • 该地址为签署流程发起成功的重定向地址,不是用户签署完成的重定向跳转;
  • 贵司的重定向域名需要在系统提前放行,否则会报错:“您即将访问的页面可能有安全风险”。

redirectDelayTime

int

否

body

发起成功后的重定向跳转延迟时间,单位秒(可选值0、3,默认值为 3)

  • 传0时,操作完成直接跳转重定向地址;
  • 传3时,展示操作完成结果页,倒计时3秒后,自动跳转重定向地址。

【注】当redirectUrl不传的情况下,该字段无需传入,操作完成不跳转

orgSealType

string

否

body

页面中新增企业签署方时展示哪些企业签章类型,默认仅展示企业章,多项请使用英文逗号隔开

1 - 企业章

2 - 法定代表人章

uneditableFields

list

否

body

禁止用户在页面上修改或追加的内容

  • signFlowTitle-签署流程标题(禁用文本框)
  • docs-待签文件(隐藏添加签署文件按钮)
  • signers-签署方(隐藏签署方区域的添加企业和添加个人按钮)
  • signFields-追加签署区(禁用签署方在页面追加签署区)
  • signFlowExpireTime-签署截止时间(禁用时间选择框)
  • copiers-抄送方(隐藏抄送方区域的添加企业和添加个人按钮)
  • attachments-附件(隐藏添加附件按钮)

signFlowConfig(点击“+”展开详情)

object

是

body

签署流程配置项

signFlowTitle

string

是

body

签署任务主题(将展示在发起页面中,页面默认允许用户修改主题)

【注】主题名称不可含有以下9个特殊字符:/ \ : * " < > | ?以及所有emoji表情

signFlowExpireTime

int64

否

body

签署截止时间(将展示在发起页面中,页面默认允许用户修改截止时间)

补充说明:

默认在签署流程创建后的90天时截止(指定值最大不能超过90天,只能指定90天内的时间戳)。签署中如需延期请调用【延期签署截止时间】接口。

autoFinish

boolean

否

body

所有签署方签署完成后签署流程自动完结,默认值 false

true - 自动完结

false - 非自动完结,需调用【完结签署流程】接口完结

补充说明:

【注】设置了自动完结的流程中不允许再追加签署区、抄送方,点击这里了解更多流程状态说明。

notifyUrl

string

否

body

接收相关回调通知的Web地址,详见【签署回调通知接收说明】。

redirectConfig

object

否

body

用户侧签署完成重定向配置项

redirectUrl

string

否

body

用户侧签署完成后跳转页面(除app和小程序端集成外,地址需符合 https /http 协议地址)

【注】

  • 该地址为签署方签署操作完成后的重定向地址。
  • 贵司的重定向域名需要在系统提前放行,否则会报错:“您即将访问的页面可能有安全风险”。

redirectDelayTime

int32

否

body

用户侧签署完成重定向跳转延迟时间,单位秒(可选值0、3,默认值为 3)

  • 传0时,签署完成直接跳转重定向地址;
  • 传3时,展示签署完成结果页,倒计时3秒后,自动跳转重定向地址。

【注】当redirectUrl不传的情况下,该字段无需传入,签署完成不跳转

signConfig

object

否

body

签署配置项

availableSignClientTypes

string

否

body

签署终端类型,默认值1和2(英文逗号分隔)

1 - 网页(自适配H5/PC样式),2 - 支付宝

【注】如果是开发者自己的app或者支付宝小程序等端内嵌系统H5/PC,需要传:1(网页端)

showBatchDropSealButton

boolbean

否

body

签署页面是否显示“同时盖在所有签署区”按钮,默认值 true

true - 显示(显示按钮并默认开启)

false - 不显示(不显示按钮,即:不能同时盖在所有签署区)

signTipsTitle

string

否

body

签署前提示弹框自定义签署声明--文案标题(最多20字)

补充说明:

  • 在签署页面进入后,展示该弹框提示,点击“我已知悉上述内容”按钮后关闭弹框,进入签署合同页。
  • 必须与下方signTipsContent字段配套使用。
  • 流程中的所有签署方都会展示此弹框文案

signTipsContent

string

否

body

签署前提示弹框自定义签署声明--文案内容(最多500字)

补充说明:

  • 在签署页面进入后,展示该弹框提示,点击“我已知悉上述内容”按钮后关闭弹框,进入签署合同页。
  • 必须与上方signTipsTitle字段配套使用。
  • 流程中的所有签署方都会展示此弹框文案

noticeConfig

object

否

body

流程整体通知配置项

noticeTypes

string

否

body

通知类型,通知发起方、签署方、抄送方,默认不通知(值为""空字符串),允许多种通知方式,请使用英文逗号分隔)

传空 - 不通知(默认值)

1 - 短信通知

examineNotice

boolean

否

body

通知给企业印章用印审批人员的通知类型,按照账号中的手机号的填写情况进行通知。
true - 发送消息(短信+邮件+系统官网站内信)

false - 不发送消息

【注】不传值默认取noticeTypes配置的通知方式

authConfig

object

否

body

流程整体认证配置项

willingnessAuthModes

list

否

body

签署意愿认证方式,可选值如下:

  • CODE_SMS - 短信验证码
  • PSN_FACE_ALIPAY - 支付宝刷脸
  • PSN_FACE_ESIGN - 快捷刷脸
  • PSN_FACE_WECHAT - 微信小程序刷脸(仅限微信小程序中使用)
  • SIGN_PWD - 签署密码

【注】使用iframe内嵌集成不支持对接刷脸方式

psnAvailableAuthModes

list

否

body

个人实名认证方式,可选值:

  • PSN_MOBILE3 - 个人运营商三要素认证
  • PSN_FACE - 刷脸认证
  • PSN_BANKCARD4 - 个人银行卡四要素认证

【注】使用iframe内嵌集成不支持对接刷脸方式

orgAvailableAuthModes

list

否

body

机构实名认证方式,可选值:

  • ORG_BANK_TRANSFER - 对公打款认证
  • ORG_ALIPAY_CREDIT - 法人快捷认证(必须操作人为法定代表人本人场景才会显示,需要法人支付宝刷脸授权完成认证)
  • ORG_LEGALREP_AUTHORIZATION - 法人授权认证(必须操作人 非法定代表人本人场景才会显示,会通知法人在线签署授权书,授权给操作人)
  • ORG_LEGALREP - 法定代表人认证(必须操作人为法定代表人本人场景才会显示,法人任选一种个人认证方式完成认证)

audioVideoTemplateId

string

否

body

智能视频认证模板ID,请联系交付顾问提供

contractConfig

boolean

否

body

合同相关配置项

allowToRescind

boolean

否

body

该签署流程是否允许发起解约,默认true

true - 允许

false - 不允许

docs(点击“+”展开详情)

array

否

body

预设置待签署文件信息

  • 不传入待签署文件,则默认由用户在发起页面中进行上传;
  • 通过接口预设置的签署文件,发起签署页面仅限预览,无法修改删除;
  • 支持预设置多份签署文件,可传入多个docs数组;
  • 发起签署页面允许用户在页面再添加签署文件。

fileId

string

否

body

待签署文件ID

fileName

string

否

body

文件名称(需要添加PDF文件后缀名,“xxx.pdf”)

【注】文件名称不可含有以下9个特殊字符:/ \ : * " < > | ?以及所有emoji表情

neededPwd

boolbean

否

body

是否需要密码,默认false

fileEditPwd

string

否

body

文件编辑密码

attachments(点击“+”展开详情)

array

否

body

预设置合同附件信息(指无需签名的文件,仅用于查看)

  • 通过接口预设置的合同附件,发起签署页面仅限预览,无法修改删除;
  • 发起签署页面默认允许用户再添加合同附件。

fileId

string

否

body

合同附件的文件ID

fileName

string

否

body

合同附件名称(需要添加文件真实后缀名,例如:“xxx.pdf”)

【注】名称不可含有以下9个特殊字符:/ \ : * " < > | ?以及所有emoji表情

signFlowInitiator(点击“+”展开详情)

object

否

body

签署流程的发起方(指在平台中发起合同签约的一方,合同的归属方,有权限查看签署的文件,签署通知中展示:“XXX 通知您签署... ”中的XXX即为发起方名字。)

  • 不传则默认为应用ID所属的企业来发起签署流程;
  • 发起方可以为个人或者机构,但不可同时传值(orgInitiator与psnInitiator 二选一传入);

orgInitiator

object

否

body

机构发起方信息

  • 当指定发起方为非应用ID所属企业时:

需先经过【用户授权】(代企业和经办人用户发起合同签署权限);

orgId

string

否

body

机构账号ID

【注】账号ID获取方式请使用【查询机构认证信息】接口通过组织机构名称/组织机构证件号进行查询

transactor

object

否

body

机构发起方的经办人(机构发起签署场景,经办人账号ID为必传项)

psnId

string

否

body

经办人账号ID

【注】账号ID获取方式请使用【查询个人认证信息】接口通过个人账号标识(手机号)/个人用户的证件号进行查询

psnInitiator

object

否

body

个人发起方信息

psnId

string

否

body

个人账号ID

【注】账号ID获取方式请使用【查询个人认证信息】接口通过个人账号标识(手机号)/个人用户的证件号进行查询

signers(点击“+”展开详情)

array

否

body

预设置签署方信息(指参与签署的个人或者机构)

  • 不传入签署方信息,则默认由用户在发起页面中添加;
  • 接口预设置的签署方信息页面不可进行修改编辑,允许用户再添加签署方。
  • 单个签署方数组中,机构签署方、个人签署方二选一传入(orgSignerInfo与psnSignerInfo二选一即可);
  • 多方签署场景,可传多个签署方数组;

signConfig

object

否

body

签署人配置项

forcedReadingTime

int32

否

body

设置页面强制阅读倒计时时间,默认值为 0(单位:秒,最大值999)

signOrder

int32

否

body

设置签署方的签署顺序

  • 按序签时传入顺序值 1 - 255;
  • 同时签时,允许值重复;
  • 接口传入的顺序依次固定,页面若用户新增了签署方,则页面允许用户选择是否“顺序签署”,并拖拽新增的签署方顺序在预设置的签署方之前或之后。

signTipsTitle

string

否

body

签署前提示弹框自定义签署声明--文案标题(最多20字)

补充说明:

  • 当前签署方在签署页面进入后,展示该弹框提示,点击“我已知悉上述内容”按钮后关闭弹框,进入签署合同页。
  • 必须与下方signTipsContent字段配套使用。

signTipsContent

string

否

body

签署前提示弹框自定义签署声明--文案内容(最多500字)

补充说明:

  • 当前签署方在签署页面进入后,展示该弹框提示,点击“我已知悉上述内容”按钮后关闭弹框,进入签署合同页。
  • 必须与上方signTipsTitle字段配套使用。

noticeConfig

object

否

body

设置签署方的通知方式

noticeTypes

string

否

body

通知类型,默认不通知(值为""空字符串),允许多种通知方式,请使用英文逗号分隔

传空 - 不通知(默认值)

1 - 短信通知

  • 该通知是签署方维度的,只控制签署人的签署提醒短信,不控制流程的撤销、完成、抄送等短信通知。(流程维度在signFlowConfig里的noticeTypes控制)

signerType

int32

是

body

签署方类型,0 - 个人,1 - 企业/机构,2 - 法定代表人,3 - 经办人签

  • 若指定签署方为个人,则psnSignerInfo为必传项;
  • 若指定签署方为机构或法定代表人手动签署(autoSign参数为false)时,则orgSignerInfo为必传项;
  • 若指定签署方为经办人,在同级数组内必须还有机构类型存在,且orgSignerInfo为必传项,即:指定3 - 经办人签的前提是必须同时存在1 - 企业/机构(且autoSign参数为false),且经办人签属于企业合同,不在个人名下。

signerRole

string

否

body

签署方角色标识(可以自定义命名,如:甲方、乙方)

补充说明:

  • 主要用于固定签署区位置,签署方信息由发起签署页面操作人自行补充(若接口同时指定了签署方角色标识和下方签署方信息,发起签署页面支持操作人修改签署方信息);
  • 若不指定下方具体的签署方信息时,必须传入签署方角色标识;
  • 签署方角色标识无法在发起签署页面中修改;
  • 在同一次请求里,签署方角色标识不可以重复。

orgSignerInfo

object

否

body

企业/机构签署方信息

  • 当签署主体为企业/机构用户、autoSign参数为false手动签章时,请必须传入此对象(orgName与orgId二选一传值即可)
  • 当企业/机构用户选择静默签署,autoSign参数为true自动落章时,此对象可以不传,后台会默认取appId所属主体企业盖章

orgId

string

否

body

企业/机构账号ID

【注】用户在系统注册实名后才有账号ID,账号ID获取方式请使用【查询机构认证信息】接口通过组织机构名称/组织机构证件号进行查询

orgName

string

否

body

企业/机构名称(账号标识)

orgInfo

object

否

body

企业/机构签署方信息(将展示在机构认证页面)

legalRepName

string

否

body

法定代表人姓名

legalRepIDCardNum

string

否

body

法定代表人证件号

legalRepIDCardType

string

否

body

法定代表人证件类型,可选值如下:

CRED_PSN_CH_IDCARD - 中国大陆居民身份证(默认值)

CRED_PSN_CH_HONGKONG - 香港来往大陆通行证(回乡证)

CRED_PSN_CH_MACAO - 澳门来往大陆通行证(回乡证)

CRED_PSN_CH_TWCARD - 台湾来往大陆通行证(台胞证)

CRED_PSN_PASSPORT - 护照

orgIDCardNum

string

否

body

企业/机构证件号

orgIDCardType

string

否

body

企业/机构证件类型,可选值如下:

CRED_ORG_USCC - 统一社会信用代码

CRED_ORG_REGCODE - 工商注册号

transactorInfo

object

否

body

企业/机构经办人信息

  • 企业/机构手动签署(autoSign为false),经办人信息必传;
  • 集成方企业自动落章(autoSign为true),请不要传该参数。

psnAccount

string

否

body

经办人账号标识,手机号(指定orgName时,该参数为必传项)

【注】为了保证签署人准确,建议配合姓名信息传入

psnId

string

否

body

经办人账号ID(指定orgId时,该参数为必传项)

【注】用户在系统注册实名后才有账号ID,账号ID获取方式请使用【查询个人认证信息】接口通过个人账号标识(手机号)/个人用户的证件号进行查询

psnInfo

object

否

body

经办人身份信息

psnName

string

否

body

经办人姓名

psnIDCardNum

string

否

body

经办人证件号

psnIDCardType

string

否

body

经办人证件类型,可选值如下:

CRED_PSN_CH_IDCARD - 中国大陆居民身份证(默认值)

CRED_PSN_CH_HONGKONG - 香港来往大陆通行证(回乡证)

CRED_PSN_CH_MACAO - 澳门来往大陆通行证(回乡证)

CRED_PSN_CH_TWCARD - 台湾来往大陆通行证(台胞证)

CRED_PSN_PASSPORT - 护照

psnSignerInfo

object

否

body

个人签署方信息

【注】当签署主体为个人时请传此对象,psnAccount与psnId二选一传值即可

psnAccount

string

否

body

个人账号标识(手机号)

【注】为了保证签署人准确,建议配合姓名信息传入

psnId

string

否

body

个人账号ID

【注】账号ID获取方式请使用【查询个人认证信息】接口通过个人账号标识(手机号)/个人用户的证件号进行查询

psnInfo

object

否

body

个人签署方身份信息

补充说明:

  • 已实名用户,若传入的psnInfo与在系统绑定的psnAccount一致,则无需重复实名,签署页直接进行签署意愿认证;
  • 已实名用户,若传入的psnInfo与在系统绑定的psnAccount不一致,则接口将会报错,建议核实用户身份信息后重新发起流程;
  • 未实名用户,签署页将根据传入的身份信息进行用户实名认证。

psnName

string

否

body

个人姓名

psnIDCardNum

string

否

body

个人证件号

psnIDCardType

string

否

body

个人证件类型,可选值如下:

CRED_PSN_CH_IDCARD - 中国大陆居民身份证(默认值)

CRED_PSN_CH_HONGKONG - 香港来往大陆通行证(回乡证)

CRED_PSN_CH_MACAO - 澳门来往大陆通行证(回乡证)

CRED_PSN_CH_TWCARD - 台湾来往大陆通行证(台胞证)

CRED_PSN_PASSPORT - 护照

psnMobile

string

否

body

个人手机号(运营商实名登记手机号或银行卡预留手机号,仅用于认证)

bankCardNum

string

否

body

个人银行卡号

signFields

array

否

body

签署区信息(设置签署方 盖章/签名/文字输入的区域)

  • 接口预设置的签署区,将展示在发起页面,且不可进行修改编辑,允许用户再添加签署区。
  • 单个签署方若对应多个签署区,可传多个数组(整个流程中,签署区不能超过300个)

fileId

string

是

body

签署区所在待签署文件ID

【注】这里的fileId需先添加在docs数组中,否则会报错“参数错误: 文件id不在签署流程中”。

customBizNum

string

否

body

开发者自定义业务编号

【注】该参数会在【签署方-签署结果通知】中原样返回,用于标识开发者自身业务

signFieldType

int32

否

body

签署区类型,默认值 0

0 - 签章区(用于加盖印章或签名),1 - 备注区(用于添加备注文字信息)

normalSignFieldConfig

object

否

body

签章区配置项(指定signFieldType为 0 -签章区时,该参数为必传项)

freeMode

boolbean

否

body

是否自由签章,默认值 false

true - 是,false - 否。

补充说明:

  • 自由签章 指不限制印章、签署位置、签章样式(单页、骑缝)、和签章个数。
  • 自由签章模式下,无需传normalSignFieldConfig对象下的其他参数。

autoSign

boolbean

否

body

是否后台自动落章,默认值 false

true - 后台自动落章(无感知),false - 签署页手动签章

补充说明:

  • 当签署方为个人时,不支持自动签章。
  • 当签署方为机构(且非应用Id所属企业),静默签署自动落章需先经过印章授权,点击查看印章授权规则。
  • 当签署方为应用Id所属主体企业自身静默签署时,支持后台自动落章。

movableSignField

boolbean

否

body

页面是否可移动签章区,默认值 false

true - 可移动 ,false - 不可移动

assignedSealId

string

否

body

指定印章ID

availableSealIds

list

否

body

手动签章时页面可选的印章列表

orgSealBizTypes

string

否

body

页面可选机构印章类型,默认值ALL(多项请使用英文逗号分隔)

ALL - 显示所有类型的印章

PUBLIC - 机构主体公章

CONTRACT - 合同专用章

FINANCE - 财务专用章

PERSONNEL -人事专用章

COMMON -其他类印章(无具体业务类型的章)

psnSealStyles

string

否

body

页面可选个人印章样式,默认值0和1(英文逗号分隔)

0 - 手写签名

1 - 姓名印章

2 - 手写签名AI校验

signFieldSize

int

否

body

签章区尺寸(正方形的边长,单位为px)

补充说明:

  • 指定的签署区的宽度,高度等比缩放;不指定默认以印章原始大小加盖
  • 不能与signFieldWidth、signFieldHeight同时传入

signFieldWidth

int

否

body

签署区宽度(矩形的左右边距距离,单位为px)

补充说明:

  • 印章需要自定义规格时传入该参数(根据指定的签署区宽高适配);不指定默认以印章原始大小加盖
  • 与signFieldHeight搭配使用,但不能与signFieldSize同时传入

signFieldHeight

int

否

body

签署区高度(矩形的上下边距距离,单位为px)

补充说明:

  • 印章需要自定义规格时传入该参数(根据指定的签署区宽高适配);不指定默认以印章原始大小加盖
  • 与signFieldWidth搭配使用,但不能与signFieldSize同时传入

signFieldStyle

int32

否

body

签章区样式

1 - 单页签章,2 - 骑缝签章

signFieldPosition

object

否

body

签章区位置信息

acrossPageMode

string

否

body

骑缝章模式选择

ALL - 全部页盖骑缝章,AssignedPages - 指定页码盖骑缝章

positionPage

string

否

body

签章区所在页码

补充说明:

  • 当signFieldStyle为 1 - 单页签章时,只能传单个页码;
  • 当signFieldStyle为 2 - 骑缝签章时,且acrossPageMode为AssignedPages即指定页码范围时,连续页码可使用'-'指定页码范围,多个页码范围用逗号分隔,例如:1-3,6-10。

positionX

float

否

body

签章区所在X坐标(当signFieldStyle为2即骑缝签章时,该参数不生效,可不传值)

【注】可选择如下方式可以确定坐标:

(1)开放平台拖章定位工具【请点击】

(2)根据关键字辅助定位接口【请点击】

positionY

float

否

body

签章区所在Y坐标

remarkSignFieldConfig

object

否

body

备注区配置项(指定signFieldType为 1- 备注区时,该参数为必传项)

freeMode

boolbean

否

body

自由备注模式,默认值 false

true - 是,false - 否。

补充说明:

自由备注 指由用户选择是否备注,且不限备注位置和备注区个数。

inputType

int32

否

body

文字输入方式,默认值:1

1 - 手写抄录方式,2 - 键盘输入方式

【注】inputType=2(键盘输入方式)时,aiCheck和remarkContent参数值不生效

aiCheck

int32

否

body

是否开启手写抄录AI校验,默认值:0

0 - 不开启 ,1 - 开启 AI 校验 ,2 - 强制 AI 校验

remarkContent

string

否

body

预设待抄录信息,最多支持50个汉字(含标点符号)

【注】inputType=1时手写抄录方式此参数必须传值

movableSignField

boolbean

否

body

备注区是否可以移动,默认值 false

true - 可移动,false - 位置固定

remarkFontSize

int32

否

body

备注文字字号,默认值14px

signFieldHeight

float

否

body

备注区高度(矩形的上下距离,单位为px)

signFieldWidth

float

否

body

备注区宽度(矩形的左右距离,单位为px)

signFieldPosition

object

否

body

备注区位置

positionPage

string

否

body

备注区所在页码,只能传单个页码。

positionX

float

否

body

备注区所在X坐标

positionY

float

否

body

备注区所在Y坐标

signDateConfig

object

否

body

签署日期配置项

dateFormat

string

否

body

日期格式

yyyy年MM月dd日(默认值)

yyyy-MM-dd

yyyy/MM/dd

yyyy-MM-dd HH:mm:ss

fontSize

int32

否

body

日期字体大小,默认值 12px

showSignDate

int32

否

body

是否显示签署日期,默认值 0

0 - 不显示,1 - 固定位置显示,2 - 不固定位置

补充说明:

  • 传1时,可以设置签署日期位置的X、Y坐标(如不传入位置坐标,日期默认显示在签署区下方,但不传位置用户手动签署时可移动日期位置,传了位置则不可移动)
  • 传2时,由用户在签署页面中选择是否开启显示签署日期(默认不开启),开启后日期位置可在页面移动调整。日期格式、字体大小参数都不生效,需要用户在页面选择。

signDatePositionX

float

否

body

签署日期所在位置X坐标,当showSignDate为1-固定位置显示时生效。

signDatePositionY

float

否

body

签署日期所在位置Y坐标,当showSignDate为1-固定位置显示时生效。

copiers(点击“+”展开详情)

array

否

body

预设置抄送方信息(指不参与签署的机构或者个人,流程结束后将收到通知,允许查看签署文件)

  • 接口预设置的抄送方页面不可进行修改编辑,允许用户再添加抄送方。
  • 如需抄送多个企业或个人,允许传入多个抄送方数组;
  • copierOrgInfo与copierPsnInfo二选一传值;

copierOrgInfo

object

否

body

机构抄送方信息(orgName与orgId,二选一传值)

orgName

string

否

body

机构名称

orgId

string

否

body

机构账号ID

copierPsnInfo

object

否

body

个人抄送方信息(psnAccount与psnId,二选一传值)

psnAccount

string

否

body

个人账号标识(手机号/邮箱号)

psnId

string

否

body

个人账号ID

响应参数

展开全部参数参数名称

参数类型

必选

参数说明

code

int32

是

业务码,0表示成功,非0表示异常。

message

string

否

业务信息

请根据 code 来判断错误情况,不应该依赖 message匹配,因为 message 可能会调整。

data(点击“+”展开详情)

object

否

业务数据

signFlowInitiateUrl

string

否

发起签署页面链接(有效期30天)

【注】当页面链接已经成功发起了签署流程后就会失效,不可以继续发起新的签署流程。

signFlowInitiateLongUrl

string

否

发起签署页面长链接(有效期30天)

【注】

  • 当页面长链接已经成功发起了签署流程后就会失效,不可以继续发起新的签署流程。
  • 长链接支持自定义域名,微信小程序H5内嵌场景需要使用此长链接

请求示例

{
    "initiatePageConfig": {
        "customBizNum": "这是一串开发者自定义的业务编号",
        "redirectUrl": "https://xxx.cn",
        "uneditableFields": [
            "signFlowTitle",
            "signFlowExpireTime",
            "copiers",
            "attachments"
        ]
    },
    "signFlowConfig": {
        "signFlowTitle": "这是本次签署任务的主题",
        "autoFinish": true,
        "noticeConfig": {
            "noticeTypes": "1"
        },
        "redirectConfig": {
            "redirectUrl": "https://xxx.cn/"
        },
        "notifyUrl": "http://xx.xx.xx.xx:8081/notify"
    }
}

响应示例

{
    "code": 0,
    "message": "成功",
    "data": {
        "signFlowInitiateUrl": "https://smlt.esign.cn/DXXXXX8vZ",
        "signFlowInitiateLongUrl": "https://smlh5.esign.cn/start/home/pc/sign/set?context=o7CG1jMbGAXH&batchSerialId=d6dc6*****1e0500"
    }
}

错误码

点击查看错误码