发起合同

POST

/api/contractStart

V1.0.0V1.1.0V1.4.0

企业发起需要权限：
1.corp_sign_task_init：授权允许代表企业发起签署
或个人：
1.psn_sign_task_init：授权允许代表个人发起签署

注意

发起合同扣费，是扣除发起人的可用合同数（其他方式可联系客服修改）

如果发起企业自身需要快速签署，可以使用静默签静默签使用说明

合同签署方合同签署请看获取参与方操作链接（签署链接）

接入流程

合同发起方（signFlowInitiator）需认证授权：见用户认证&授权流程

上传合同文件：【上传合同文件】或【基于模板创建合同文件】（必须），获得文件filecode。亦可【上传合同附件】（非必须）

通过filecode 调用此接口发起合同

请求头格式

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

请求参数

Body 参数application/json

contractName

string

合同名称

必需

合同名称

contractCategoryId

integer

合同分类ID

可选

合同类目ID，企业必填，通过【查询企业合同类目】接口获取，或者【企业控制台】-【合同类型查看】

fileCode

string

签署合同文件Code

必需

签署合同文件需要先调用【上传合同文件】或【基于模版创建合同文】接口，获取filecode

attachmentFileCodes

array[string] | null

合同附件Code

可选

签署合同文件需要先调用【上传合同附件】接口，获取filecode

signers

array [object {6}]

必需

签署方信息，最多不超过10个

seqNo

integer

签署顺序

必需

签署顺序1开始不可重复

psnSignerInfo

object | null

个人签署信息

必需

个人签署信息与企业签署信息2选1

corpSignerInfo

object | null

企业签署信息

必需

企业签署信息与个人签署信息2选1

signFields

array [object {5}] | null

签署区域配置

可选

签署（印章）区域配置可以多个

authConfig

object

认证方式

必需

指定意愿认证方式

noticeConfig

object

签署通知方式

必需

发起合同时，签署通知方式

copyReceivers

array [object {2}] | null

抄送人信息

可选

抄送人信息，最多不超过10个

psnCopyReceiverInfo

object

个人签署信息

必需

个人签署信息与企业签署信息2选1

corpCopyReceiver

object

企业签署信息

必需

个人签署信息与企业签署信息2选1

signFlowConfig

object

必需

签署流程其他配置相关信息

seqSigning

boolean

是否顺序签署

必需

是否顺序签署true - 顺序签署，false - 无序签署

approvalId

string | null

审批流程ID

可选

企业发起人可使用，调用接口【列表查询用户可用的审批流程】获取ID

signDeadline

string | null

签署截止时间

可选

LocalDate类型或 yyyy-MM-dd格式字符串签署截止时间，只能1年内有效

signFlowInitiator

object

必需

签署流程的发起方（指在平台中发起合同签约的一方，合同的归属方，有权限查看签署的文件，签署通知中展示：“XXX 通知您签署... ”中的XXX即为发起方名字。）（corpInitiator与psnInitiator 二选一传入）；当指定发起方为非应用ID所属企业时，需先经过用户授权（代个人/企业用户发起合同签署权限）。

corpInitiator

object | null

企业发起方信息

必需

（corpInitiator与psnInitiator 二选一传入）；

psnInitiator

object | null

个人发起方信息

必需

（corpInitiator与psnInitiator 二选一传入）；

示例

{
  "contractName": "《签盾员工入职合同》",
  "contractCategoryId": 7336,
  "fileCode": "FC_20240326115921rosVEhuRQwLHyBE",
  "attachmentFileCodes": null,
  "signers": [
    {
      "seqNo": 1,
      "psnSignerInfo": null,
      "corpSignerInfo": {
        "corpName": "测试测试测试有限公司",
        "receiverName": "测试员工",
        "receiverPhone": "15212341234"
      },
      "signFields": null,
      "authConfig": {
        "intentionAuthenticationMode": "PSN_FACE_ALIPAY"
      },
      "noticeConfig": {
        "noticeTypes": 1
      }
    },
    {
      "seqNo": 2,
      "psnSignerInfo": {
        "receiverPhone": "15212341236",
        "receiverName": "测试个人"
      },
      "corpSignerInfo": null,
      "signFields": null,
      "authConfig": {
        "intentionAuthenticationMode": "PSN_FACE_ALIPAY"
      },
      "noticeConfig": {
        "noticeTypes": 1
      }
    }
  ],
  "copyReceivers": null,
  "signFlowConfig": {
    "seqSigning": false,
    "approvalId": 224,
    "signDeadline": "2025-01-01"
  },
  "signFlowInitiator": {
    "corpInitiator": {
      "openCorpId": "1713823122383572992",
      "staffId": "1694661686113472521",
      "transactor": null
    },
    "psnInitiator": null
  }
}

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'api.pre-qiandun365.com/api/contractStart' \
--header 'Content-Type: application/json' \
--data-raw '{
    "contractName": "《签盾员工入职合同》",
    "contractCategoryId": 7336,
    "fileCode": "FC_20240326115921rosVEhuRQwLHyBE",
    "attachmentFileCodes": null,
    "signers": [
        {
            "seqNo": 1,
            "psnSignerInfo": null,
            "corpSignerInfo": {
                "corpName":"测试测试测试有限公司",
                "receiverName":"测试员工",
                "receiverPhone":"15212341234"

            },
            "signFields": null,
            "authConfig": {
                "intentionAuthenticationMode": "PSN_FACE_ALIPAY"
            },
            "noticeConfig": {
                "noticeTypes": 1
            }
        },
        {
            "seqNo": 2,
            "psnSignerInfo": {
                "receiverPhone" : "15212341236",
                "receiverName" : "测试个人"
            },
            "corpSignerInfo": null,
            "signFields": null,
            "authConfig": {
                "intentionAuthenticationMode": "PSN_FACE_ALIPAY"
            },
            "noticeConfig": {
                "noticeTypes": 1
            }
        }
    ],
    "copyReceivers": null,
    "signFlowConfig": {
        "seqSigning": false,
        "approvalId": 224,
        "signDeadline": "2025-01-01"
    },
    "signFlowInitiator": {
        "corpInitiator": {
            "openCorpId": "1713823122383572992",
            "staffId": "1694661686113472521",
            "transactor": null
        },
        "psnInitiator": null
    }
}'

返回响应

🟢200成功

application/json

Body

code

string

请求返回code

必需

msg

string

请求返回msg

必需

result

string | null

合同contractId

必需

success

boolean

是否成功

必需

logKey

string

日志key

必需

string

时间戳

必需

示例

成功示例参数错误

{
  "result": "7904",
  "code": "200",
  "msg": "成功",
  "logKey": "e5420d41",
  "ts": "1711434441129",
  "success": true
}

修改于 2025-04-28 08:45:39

获取文件关键字坐标

获取参与方操作链接（签署链接）

发起合同

接入流程#

请求头格式#

请求参数

示例代码

返回响应

接入流程

请求头格式