签约发起说明
服务说明
[!NOTE] 君子签整合的所有的合同发起方式为一个接口，虽然参数很多，但对于最简单的签署只需要2-3个字段传入即可发起签署。 通过发起合同接口可以发起： 半自动签署，手动签署（用户有感知）,自动签署（用户无感知），保全存证，hash保全，批量签署合同等多种合同类型。
http请求方式
[!NOTE] POST multipart/form-data
http请求地址
[!NOTE] $SERVICE_URL/v2/sign/applySign #其中$SERVICE_URL为生产或测试的地址
http请求参数
| 参数 | 类型 | 是否必填 | 默认值 | 说明 |
|---|---|---|---|---|
| contractName | string | * | 合同名称非空，最长100个字符 | |
| signatories | JSONArray | * | 签约方，参考后面签约方说明 | |
| serverCa | int | * | 0 | 是否需要服务端云证书：非1不需要(默认);1需要;建议需要，否则影响后续司法服务 |
| dealType | int | * | 0 | 处理方式:为空或0时默认为手签合同(用户有感知);1自动签约(用户无感知);2只保全;5部份自动签;6HASH只保全;17收集信息批量签 |
| hashValue | int | + | dealType=6时必须传入,文件的sha512HexString值 | |
| fileType | int | * | 0 | 合同上传方式:0或null直接上传PDF;1url地址下载;2tmpl模版生成;3html文件上传 |
| file | file | + | 合同文件;请使用form表单上传文件dealType!=6,fileType=0或null,时必须传入 | |
| url | file | + | 合同PDF文件的url地址（传规范的url地址）;dealType!=6,fileType=1,时必须传入 | |
| templateNo | string | + | 合同模版编号,dealType!=6,fileType=2,时必须传入 | |
| templateParams | JSONString | + | 合同模版参数JSON字符串,dealType!=6,fileType=2,时必须传入 | |
| htmlContent | string | + | 合同html文件,dealType!=6,fileType=3,时必须传入,utf8编码 | |
| positionType | int | ? | 0 | 指定公章位置类型:0或null使用签字座标位置或不指定签字位置;1表单域定位(表单域如果上传为pdf时,需pdf自行定义好表单域,html及url及tmpl等需定义好input标签);2关键字定义 |
| faceThreshold | int | + | 验证方式为人脸时必传,人脸识别阀值:默认等级(1-100之间整数)，建议范围(60-79),验证方式在签收方中设置 | |
| orderFlag | int | ? | 0 | 是否按顺序签字，非1为不按，1为按 |
| sequenceInfo | object | ? | 多合同顺序签约或批量签合同关联信息，参考后面表格说明 |
http请求其它扩展参数
| 参数 | 类型 | 是否必填 | 默认值 | 说明 |
|---|---|---|---|---|
| qrCode | int | ? | 0 | 合同查看二维码0默认不1显示 |
| noEbqSign | int | ? | 0 | 不显示ebq的保全章:1 不显示但会签名,2不显示也不签名;0或其它-显示 |
| contractAmount | float | ? | 合同金额 | |
| remark | string | ? | 备注 | |
| preRecored | string | ? | 前置记录，此记录会计录到签约日志中，并保全到日志保全和最终的证据保全中，最大字符不能超过2000char | |
| attachFiles | file[] | ? | 合同附件,虽不限个数,但包括合同原文件,不能超过30MB,*SDK引用中的多文件同名情况的上传说明 | |
| ifWebRtc | int | ? | 0 | 是否使用视频签约:0或null不使用;1使用(使用时必须购买相应套餐) |
| needQifengSign | int | ? | 0 | 是否使用骑缝章:1使用;其它不使用 |
| isArchive | int | ? | 1 | 是否归档:0不归档;1归档(默认),设置不归档可以签约完后再添加签约方,可以失效合同 |
| canRefuse | int | ? | 1 | 是否可以拒签:0或null不能拒签(默认);1可拒签,用于页面是否显示拒签按钮 |
| noBorderSign | int | ? | 1 | 是否不显示个人标准章边框:1不显示,其它显示边框(默认) |
signatories字段说明
[!NOTE] signatories是合同的签署方信息，为JSONArray结构，即JSONObject数组,且签约人不能存在相同的证件号。签署人参数说明如下：
| 参数 | 类型 | 是否必填 | 默认值 | 说明 |
|---|---|---|---|---|
| fullName | string | * | 签约方名称,不超过50个字符 | |
| identityType | int | * | 身份类型:1身份证,2护照,3台胞证,4港澳居民来往内地通行证,11营业执照,12统一社会信用代码 | |
| identityCard | string | * | 个人传身份证号，企业传营业执照号/统一社会信用代码号 | |
| mobile | string | + | 手机号码（个人必传），11个字符 | |
| string | + | 邮箱,企业必传（必须与调“企业实名认证”接口时传的邮箱一致） | ||
| orderNum | int | + | 签字顺序:连续签（orderNum只是针对于当前合同,对批量签多个合同顺序不能指定）,顺序签时必传,[0,100) | |
| chapteJson | JSONArray | + | 签字位置座标信息:positionType=0时可以传入chapteJson | |
| chapteName | string | + | 签字位置-表单域名ID:positionType=1时必须传入 | |
| searchKey | string | + | 签字位置-按关键字签署，positionType=2时必须传入，关键字支持多个;以英文;分隔 | |
| authLevel | array |
? | 验证等级(传数组字符串)例:[2,10];2 银行卡四要素认证； 10 银行卡三要素认证； 11 人脸识别；12 短信验证码 ；13 运营商三要素认证 | |
| authLevelRange | int | ? | 最小验证种类:默认为authLevel数组长度;必须小于authLevel长度且大于0(等于0时按authLevel数组长度计录);如authLevel=[2,10],authLevelRange=2表过只需要验证其中的两项即可 | |
| signLevel | int | ? | 签字类型，标准图形章或公章:0标准图形章,1公章或手写,2公章手写或手写 |
signatories其它扩展参数
| 参数 | 类型 | 是否必填 | 默认值 | 说明 |
|---|---|---|---|---|
| searchExtend | JSONObject | ? | 签字位置-按关键字查询-扩展，positionType=2时可以传入,支持指定查询页数/关键字颜色/透明度.可参考相关说明 | |
| searchConvertExtend | JSONObject | ? | 签字位置-按关键字查询-结果转换的配置，positionType=2时可以传入,可配置查询结果的位置偏移.可参考后面说明 | |
| noNeedVerify | int | ? | 0 | 签约方需要手签时是否不先行验证手机或邮箱:1不验证，其它验证(默认) |
| serverCaAuto | int | ? | 0 | 是否使用自动签署完成，0或null不使用，1自动(当且只当合同处理方式为部份自动或收集批量签时有效) |
| forceEvidence | int | ? | 0 | 强制添加现场:0或null：不强制添加现场,1：强制添加现场 |
| insureYear | int | ? | 买保险年数:1-3购买年限,基它不买;注需要有相应的套餐 | |
| readTime | int | ? | 强制阅读时间；当通过君子签在线签合同时，可以设置用户必须预览合同多少秒后，才可以继续签署合同 | |
| signId | long | ? | 企业用户指定签章ID:此值需为商户上传的自定义公章ID，或商户创建的企业的自定义公章ID。自定义公章可通过sass或api上传 | |
| nameHideStatus | long | ? | 标准章时是否对个人或企业章图片打码：0不打，1打码(章图片) | |
| h5FaceOrderNo | string | ? | h5人脸订单号,如使用过君子签提供的人脸认证服务可以上传其订单号(生成签约日志时会记录，并会保全到证据中) | |
| onlyVideoEvidence | string | ? | 0 | 现场存证只能上传视频:1是，其它不是(默认) |
| evidenceTitle | string | ? | 0 | 现场存证自定义标题 |
| safeKeepLetterFlag | string | ? | 0 | 是否使用电子保管函：1使用0或其它不使用;使用时需有相应套餐 |
| frontIdentityCard | string | ? | 参数数据来源文件上传接口(v2/file/upload)返回值 | 个人身份证正面图片（safeKeepLetterFlag=1且保管函对象是个人时必传） |
| versoIdentityCard | string | ? | 参数数据来源文件上传接口(v2/file/upload)返回值 | 个人身份证反面图片（safeKeepLetterFlag=1且保管函对象是个人时必传） |
| businessLicenseImg | string | ? | 参数数据来源文件上传接口(v2/file/upload)返回值 | 企业营业执照图片（safeKeepLetterFlag=1且保管函对象是企业时必传） |
| frontLegalIdentityCard | string | ? | 参数数据来源文件上传接口(v2/file/upload)返回值 | 企业法人身份证正面图片（safeKeepLetterFlag=1且保管函对象是企业时必传） |
| versoLegalIdentityCard | string | ? | 参数数据来源文件上传接口(v2/file/upload)返回值 | 企业法人身份证反面图片（safeKeepLetterFlag=1且保管函对象是企业时必传） |
sequenceInfo字段说明
[!NOTE] sequenceInfo 用于指定多个不同合同之间的关联顺序。可用于合同的在线连续签署，和批量一次性签署合同文件。为JSONObject结构，参数说明如下：
| 参数 | 类型 | 是否必填 | 默认值 | 说明 |
|---|---|---|---|---|
| businessNo | string | * | 客户方合同的唯一编号，可用于批量签署，由于客户指定 | |
| sequenceOrder | int | * | 签约合同在业务中的顺序号,为[1,20)整数 | |
| totalNum | int | * | 总份数,为[1,20)整数 |
http返回参数
[!NOTE] 返回response为application/json的数据，其字段说明如下
| 参数 | 类型 | 是否必返回 | 说明 |
|---|---|---|---|
| success | bool | * | 成功true；异常false |
| msg | string | ? | 异常时，返回异常原因 |
| resultCode | int | ? | 错误码，参考附录 |
| data | string | ? | 合同编号信息(APLXXXXX) |
[!NOTE] 返回结果，参考：
//{"msg":"app_secret不可用","resultCode":"HTTP_PARAM_ERROR","success":false}
//{"success":true,data:"APLXXXXXXXXXX"}