接口描述
此接口用于完结签署流程,完成后的签署流程不允许再添加、删除签章区域,也不允许撤销签署流程。
注意事项:
(1)签署流程中添加的签署方全部完成签章后才可以完结流程。
(2)完结签署流程后才允许调用【下载已签文件及附属材料】接口下载已签章的文件。
(3)发起签署时 autoFinish 参数设置为true,全部签章完成时流程将自动完结,无需再调用此接口。
(4)发起签署时 autoFinish 参数设置为false,需要开发者主动调用此接口将签署流程状态变更为已完成。
接口地址&请求方法
接口地址:https://{host}/v3/sign-flow/{signFlowId}/finish
请求方法:POST
请求头格式
具体请求头参数,请查看公共请求头格式。
请求参数
参数名称 | 参数类型 | 必选 | 参数位置 | 参数说明 |
signFlowId | string | 是 | path | 签署流程ID |
响应参数
参数名称 | 参数类型 | 必选 | 参数说明 | ||||
code | int32 | 是 | 业务码,0表示成功,非0表示异常。 | ||||
message | string | 否 | 业务信息 请根据 code 来判断错误情况,不应该依赖 message 匹配,因为 message 可能会调整。 | ||||
data | object | 否 | 业务数据 |
请求示例
POST https://openapi.esign.cn/v3/sign-flow/429b1d30**0a63d7e4c0d/finish
响应示例
{
"code": 0,
"message": "成功",
"data": null
}