电子合同API开发文档 v5

创建合同

创建合同
备注:
1、如果需要在web.1dq.com 中看到所有的合同,如果signed_data 中没有您企业的easy_id; 需要 增加参数copy_data = 您企业的easy_id
2、需要要把easy_id放在签署人中,只有signed_data中用户才能签署合同

Header 请求参数:

参数名 是否必填 长度 类型 默认值 描述 内容
appId 32 string - 贵司的appId,可在后台可以查看
signature 64 string - 签名效验,请参考签名生成
version 6 long - 版本号
token 60-256 string - 用户的token,可通过用户登录接口获取Token
clientType 2-10 string API 用户客户端类型,如WEB、H5、APP、API等
clientId 32 string - 用户客户端ID,请传递真实的客户端ID

body 请求参数:

参数名 是否必填 长度 类型 默认值 描述 内容
easy_id 18 STRING
发起方的id,如您账户存在多个企业,每个企业均不同
file_id 36 STRING
文件Id,通过上传文件接口获得,如果传递了tpl_id,该参数可为空
name - STRING
合同名称
open_id - STRING
发起方个人账户的open_id, 如果合同属于机构请填写org_id
signed_data - JSON
签署人列表,最多10人,使用JSON 格式传递,格式为 [ { "open_id": "个人账户的open_id必填项", "org_id": "选填-机构的org_id请确保该个人已经加入在这个机构内" }, { "open_id": "个人账户的open_id", "company_org_id": "选填" } ]
signed_data - STRING
该份合同需要哪些人签署,请填写签署人的easy_id,多个用,号分开
attachment - JSON
附件列表,JSON LIST格式,通过附件上传接口上传可获取到id,注意:如非LIST格式系统会忽略,请参考示范; 在新版本中,附件将合并到主合同中,新版本最多20个附件,如附件过大,将导致合同签署或预览缓慢; 附件无需签署,但同样具备法律效力,(如您附件过大,或数量较多请使用旧版本)
ca_type - INT 1
CA数字证书类型,1 系统默认,最优选择;其他请与商务联系
channel - STRING api
通道名称,默认api,可选项api/autoApi
copy_custom_user - JSON
选填项,自定义抄送人,无需先创建用户,JSON数组,适用场景可参考官网发起合同或与客服联系
copy_data - JSON
抄送人列表, 使用JSON 格式传递,格式为 [ { "open_id": "个人账户的open_id必填项", "org_id": "选填-机构的org_id请确保该个人已经加入在这个机构内" }, { "open_id": "个人账户的open_id", "company_org_id": "选填" } ]
copy_data - STRING
选填项,该份合同需要抄送给哪些,请填写抄送人人的easy_id,多个用,号分开
deposit_certificate_type - INT 1
存证类型,默认1支付宝存证,1支付宝存证,2其他区块链存证,-1无需存证,
file_end_date 20 STRING
合同到期日期,为空不设置,格式为 2010-12-01 00:00:00
notice_signed - STRING 1
是否通知签署人, 1通知 -1 不通知,默认不通知
org_id - STRING
发起方主体机构的org_id, 如果这份合同属于机构,请填写
pdf_password 50 STRING
pdf文档密码,如果pdf有密码,需要设置此项
sign_end_date 20 STRING
签署截止日期,为空不设置,格式为 2010-12-01 00:00:00
signed_custom_user - JSON
选填项,自定义签署人,无需先创建用户,JSON数组,适用场景可参考官网发起合同或与客服联系
tpl_data - JSON
选填项,替换模板内的自定义变量后自动生成合同,支持docx格式的模板文件替换,详情请参考<a href="https://oss2.1dq.com/public/模板替换.pdf">模板替换文档</a>
tpl_id - STRING
模板的ID,通过合同文件上传-> 合同模板上传 接口可获得,填写次参数后,file_id 参数为空