合同发起

描述

使用此接口发起电子合同。

接口说明

授权对象 APP

请求地址 POST /open/agreement/flow

请求规则 请查阅开发必读

请求参数

参数名称	变量名称	参数类型[长度限制]	是否必填	描述
合同主题	title	string	是	示例值：BOOL电子合同
签署人列表	signers	object[]	否	body
文档列表	docs	object[]	否	body

签署人列表 signers

参数名称	变量名称	参数类型[长度限制]	是否必填	描述
个人签署方	psnSigner	object	条件必填	个人签署方信息，与企业签署方二选一
企业签署方	orgSigner	object	条件必填	企业签署方信息，与个人签署方二选一
签署顺序	signOrder	int32	否	示例值：1

个人签署方 psnSigner

参数名称	变量名称	参数类型[长度限制]	是否必填	描述
姓名	name	string	是	示例值：BOOL
账户信息	psnAccount	object	是	个人账户信息

个人账户信息 psnAccount

参数名称	变量名称	参数类型[长度限制]	是否必填	描述
手机号	accountMobile	string	是	示例值：13024777828
邮箱	accountEmail	string	否	示例值：service@boolc.cn

企业签署方 orgSigner

参数名称	变量名称	参数类型[长度限制]	是否必填	描述
企业名称	orgName	string	是	示例值：贵州不二云科技有限公司
经办人信息	transactor	object	是	经办人信息，结构同个人签署方

文档列表 docs

参数名称	变量名称	参数类型[长度限制]	是否必填	描述
文件地址	downloadUrl	string	是	示例值：https://boolc.cn/download/contract.pdf
文件名称	fileName	string	是	示例值：BOOL电子合同.pdf

请求示例

{
  "title": "BOOL电子合同",
  "signers": [
    {
      "psnSigner": {
        "name": "BOOL",
        "psnAccount": {
          "accountMobile": "13024777828",
          "accountEmail": "service@boolc.cn"
        }
      },
      "signOrder": 1
    },
    {
      "orgSigner": {
        "orgName": "贵州不二云科技有限公司",
        "transactor": {
          "name": "BOOL",
          "psnAccount": {
            "accountMobile": "13024777829",
            "accountEmail": "hr@boolc.cn"
          }
        }
      },
      "signOrder": 2
    }
  ],
  "docs": [
    {
      "downloadUrl": "https://boolc.cn/download/contract.pdf",
      "fileName": "BOOL电子合同.pdf",
    }
  ]
}

响应参数

参数名称	变量名称	参数类型	是否必填	描述
链接地址	url	string	是	合同发起链接 示例值：https://boolc.cn/sign
合同ID	signFlowId	string	否	示例值：BOOL_FLOW_123456

响应示例

{
  "url": "https://boolc.cn/sign",
  "signFlowId": "BOOL_FLOW_123456"
}