开启签署流程

更新时间:2023-08-29 17:53:36

接口描述

签署流程开启之后,签署任务会按照流程既定配置开始执行(通知相关签署人开始签署等),签署流程此时为“签署中”状态。

注意事项:

  • 签署流程开启后,将不允许向签署流程中添加或删除文件(包括待签文件和附属材料文件)。
  • 签署流程开启后,签署中可向签署流程中再添加签署区(签署方),参考文档【追加签署区】。注意,如果是自动完结的流程,即发起签署时autoFinish(自动完结)参数设置了true,不允许向此流程中添加签署区(签署方)

接口地址&请求方法

接口地址:https://{host}/v3/sign-flow/{signFlowId}/start

请求方法:POST

请求头格式

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

请求参数

参数名称

参数类型

必选

参数位置

参数说明

signFlowId

string

是

path

签署流程ID

响应参数

参数名称

参数类型

必选

参数说明

code

int32

是

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

message

string

否

业务信息

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

data

object

否

业务数据

请求示例

POST https://esignapi.bestcert.net/v3/sign-flow/429b1d30**0a63d7e4c0d/start

响应示例

{
    "code": 0,
    "message": "成功",
    "data": null
}

错误码

点击查看错误码