基础介绍
当API发起的双方或多方合同文件在签署方均已完成签署后，其中任一签署方可以申请发起合同解约。解约发起成功后，原合同中的所有签署方需要重新手动签订一份“解约协议”来对原有的合同进行解约。“解约协议”在双方或多方签署成功后，原签署文件将失效。
注：仅限已完结状态流程中的签署方来作为发起方进行发起合同解约；单方签署的流程不支持发起解约（流程中必须包含2个及以上的签署方）。
效果展示
API接口
API接口（点击直接跳转相关API文档） | API描述 | 是否必需 |
（两个接口二选一） |
| 必需 |
| 建议 |
发起合同解约接口代码案例
相关参数
- signFlowId（已完成状态的签署流程ID）：在请求URL的path路径上传入原有合同的签署流程ID。
- rescindReason（解约原因）：在e签宝给出的几个原因中选择，其他可以在附加原因：rescindReasonNotes中说明。
- rescindFileList（本次需要解约的签署文件ID列表）：需要解约的文件ID，必须是原签署流程中的文件。
- rescissionInitiator（合同解约发起方信息）：对应【基于文件发起签署】接口中的signers（签署方）或者signFlowInitiator（发起方）参数，必须由原合同流程中的参与方来发起合同解约。
注：指定发起方之前，需先给机构/个人发起方进行 用户授权（授权允许平台代表机构/个人用户发起合同签署权限： org_initiate_sign/psn_initiate_sign）。
- signFlowConfig（解约流程配置项）：可传入解约计费配置项、用户通知配置项，以及开发者回调通知地址。
- autoSignOrg（指定本次解约使用自动签署的机构签署方）：平台或者授权平台的企业自动盖章时传入。
- orgSignerTransactor（指定本次解约机构签署方经办人信息）：企业手动签署时可以传入进行指定本次签署解约协议的企业经办人信息。
代码案例
由原合同中的机构签署方发起解约并自动盖章场景示例：
{
"rescindReason": "1",
"rescindFileList": [
"a5f72*******038573a268"
],
"rescissionInitiator": {
"orgInitiator": {
"orgId": "842ec8c******5fc91662f",
"transactor": {
"psnId": "7ffc******8f0ef0a8f6"
}
}
},
"signFlowConfig": {
"chargeConfig": {
"chargeMode": 0
},
"noticeConfig": {
"noticeTypes": "1,2"
},
"notifyUrl": "http://*******/notify"
},
"autoSignOrg": [
{
"orgName": "XXXX有限公司",
"sealId": "ac8ce1b0-08e9-****-ca82a343"
}
]
}由原合同中的个人签署方发起解约并且机构签署方经办人手动签署示例：
{
"rescindReason": "1",
"rescindFileList": [
"f78dd1****33f0d122b74"
],
"rescissionInitiator": {
"psnInitiator": {
"psnId": "39c4d66******4438c8"
}
},
"signFlowConfig": {
"chargeConfig": {
"chargeMode": 0
},
"noticeConfig": {
"noticeTypes": "1,2"
},
"notifyUrl": "http://*******/notify"
},
"orgSignerTransactor": [
{
"orgName": "XXXX有限公司",
"transactorInfo": {
"psnAccount": "153****0000"
}
}
]
}通过页面发起合同解约接口代码案例
相关参数
- signFlowId（已完成状态的签署流程ID）：在请求URL的path路径上传入原有合同的签署流程ID。
- rescissionInitiator（合同解约发起方信息）：对应【基于文件发起签署】接口中的signers（签署方）或者signFlowInitiator（发起方）参数，必须由原合同流程中的参与方来发起合同解约。
注：指定发起方之前，需先给机构/个人发起方进行 用户授权（授权允许平台代表机构/个人用户发起合同签署权限： org_initiate_sign/psn_initiate_sign）。
- signFlowConfig（解约流程配置项）：可传入计费配置项、重定向配置项，解约协议通知配置项以及回调通知地址。
当解约协议发起成功后，会触发【合同发起解约通知】发送消息给接口配置的回调通知地址。
当解约协议签署完成后，会触发【合同解约成功通知】发送消息给接口配置的回调通知地址。
代码案例
由原合同中的机构签署方发起解约场景示例：
{
"rescissionInitiator": {
"orgInitiator": {
"orgId": "0c5bd49248***5648bfbf",
"transactor": {
"psnId": "c7e002947***310541e7"
}
}
},
"signFlowConfig": {
"chargeConfig": {
"chargeMode": 0
},
"noticeConfig": {
"noticeTypes": "1,2"
},
"redirectConfig": {
"redirectUrl": "https://web.esign.cn/"
},
"notifyUrl": "http://******/notify"
}
}由原合同中的个人签署方发起解约场景示例：
{
"rescissionInitiator": {
"psnInitiator": {
"psnId": "39c4d66******4438c8"
}
},
"signFlowConfig": {
"chargeConfig": {
"chargeMode": 0
},
"noticeConfig": {
"noticeTypes": "1,2"
},
"redirectConfig": {
"redirectUrl": "https://web.esign.cn/"
},
"notifyUrl": "http://******/notify"
}
}通过页面发起合同解约效果展示
页面版发起需要打开返回的链接，在e签宝页面里选择待解约文件，解约原因，解约签署方等信息。
我要纠错