手动签署
简要描述
手动签署
请求地址
/v4/api/fdd/operateExtSignHeader
| 参数名 | 必选 | 类型 | 说明 |
|---|---|---|---|
| Token | 是 | string | 应用令牌 |
请求参数
| 参数名 | 必选 | 类型 | 层级 | 说明 | 示例 |
|---|---|---|---|---|---|
| transactionId | 是 | string | 1 | 交易号 | FDDXXXXXXXXXXX |
| contractId | 是 | string | 1 | 合同编号 | HT202605260001 |
| customerId | 是 | string | 1 | 客户编号 | 3E4B4CXXXX |
| outhCustomerId | 否 | string | 1 | 代理人客户编号 | |
| docTitle | 是 | string | 1 | 文档标题 | 运输合同 |
| signKeyword | 否 | string | 1 | 定位关键字 关键字为文档中的文字内容(要能使用ctrl+f搜索到)。法大大按此关键字进行签章位置的定位,将电子章盖在这个关键字上面。凡出现关键字的地方均会盖上指定用户的电子章,建议关键字在合同中保持唯一。 | |
| keywordStrategy | 否 | string | 1 | 关键字签章策略 0:所有关键字签章(默认);1:第一个关键字签章;2:最后一个关键字签章 | 0 |
| signaturePositions | 否 | array | 1 | 定位坐标 | |
| pagenum | 否 | string | 2 | 页码 签章页码,从 0开始。即在第一页签章,传值 0 | 0 |
| x | 否 | string | 2 | 盖章点x坐标 以左上角为原点(0.0),取鼠标位置为图片中心点;坐标请以图片宽度为 800 为基准 | 181 |
| y | 否 | string | 2 | 盖章点y坐标 以左上角为原点(0.0),取鼠标位置为图片中心点 坐标请以图片高度为 1131 为基准 | 132 |
| signatureId | 否 | string | 1 | 印章编号 调新增签章接口返回 | SEALXXXXXXXXXX |
| returnUrl | 否 | string | 1 | 页面跳转URL(签署结果同步通知) 当签章完成后,在签章页面停留数秒后浏览器会自动跳转到此URL,内容由接入平台自行展示;若需跳入小程序path格式:pages/index/index 需要配合open_environment且不支持跳转tabBar页面 使用return_url最大长度为500 | https://xxx/return |
| notifyUrl | 否 | string | 1 | 签署结果异步通知URL 如果指定,当签章完成后,法大大将向此URL发送签署结果。notify_url最大长度为500 | https://xxx/notify |
| resultType | 否 | string | 1 | 刷脸成功后是否显示刷脸结果页面 1、直接跳转到同步地址,2、需要用户点击完成验证按钮后才跳转到同步地址。默认为2 | 2 |
| readTime | 否 | string | 1 | 合同必读时间 0-60秒 | 0 |
| readType | 否 | string | 1 | 是否需要短信验证打开链接 0:否 1:是 不传值,默认为否 | 0 |
| requiredRead | 否 | string | 1 | 合同是否必读至末页 0:非必读 1:必读 | 0 |
| lang | 否 | string | 1 | 页面语言 zh:中文,en:英文 | zh |
| mobileSignType | 否 | string | 1 | 签章类型 0:全部;1:标准;2:手写 当接口中该参数传入有值时,以接口传入的配置为准,否则则取运营后台配置 | 1 |
| writingTrack | 否 | string | 1 | 是否开启手写轨迹 0:关闭 1:开启 手写轨迹仅支持汉字 当接口中该参数传入有值时,以接口传入的配置为准,否则则取运营后台配置 | 0 |
| pcHandSignature | 否 | string | 1 | 支持pc手写印章 1:pc端支持手写印章(需mobile_sign_type签章类型为2时支持) | 0 |
| trackType | 否 | string | 1 | 手写轨迹背景板不显示文字 1:隐藏背景文字,仅显示田字格(仅当开启手写轨迹时才生效) | |
| signVerifyWay | 否 | string | 1 | 签署意愿方式 1:短信验证;3:刷脸验证 10:短信验证和刷脸验证二选一 当传参为1或10时,前提为认证时需要采集手机号 当接口中该参数传入有值时,以接口传入的值为准,否则则取运营后台配置 | 1 |
| verifyWayFlag | 否 | string | 1 | 签署意愿方式选择人脸识别时,人脸识别失败后自动调整为短信 默认为0 0:不切换;1:切换 | 0 |
| openEnvironment | 否 | string | 1 | 打开环境 (默认)0、跳转h5;1、支持在客户小程序path中跳转,path的写法如 /page/page1;2、跳转法大大公证处小程序 4、由中间页跳转法大大公证处小程序 9、支付宝小程序 13、旷视小程序刷脸 | 0 |
| signatureShowTime | 否 | string | 1 | 时间戳显示方式 不传默认为1 1:以后台配置为准,如果存在部分签署显示、部分签署不显示的场景,需要配置显示时间戳,以及时间戳显示样式 2:不显示时间戳 | 1 |
| acrossType | 否 | string | 1 | 骑缝章定位方式 0-坐标(默认)1-页面拖拽 说明:若合同页数少于2页,则不可盖骑缝章 若为页面拖拽,则“骑缝章印章的客户编号”、“骑缝章ID”和”骑缝章Y坐标“参数需为空,否则将报错 | 0 |
| keyx | 否 | string | 1 | 关键字偏移量,偏移x位置 [-595,595]之间的数字 | -80 |
| keyy | 否 | string | 1 | 关键字偏移量,偏移y位置 [-842,842]之间的数字 | -60 |
| acrossY | 否 | string | 1 | 骑缝章y坐标 | |
| acrosspageCustomerId | 否 | string | 1 | 骑缝章印章的客户编号 当与customer_id非同一个时,需传有授权自动签权限的客户编号。且盖骑缝章合同的页数必须大于1页。 | |
| acrossSignatureId | 否 | string | 1 | 骑缝章id 该印章必须属于acrosspage_customer_id,该印章不会显示在签署页面,用户签署时直接加盖在合同上。骑缝章定位方式为“拖拽签”时此字段需为空 | |
| saveHandSignature | 否 | string | 1 | 是否保存手写签名印章作为默认章 0:默认不保存 1:保存仅对个人类型且签章类型为手写时生效 | 0 |
入参示例
json
{
"transactionId": "FDDXXXXXXXXXXX",
"contractId": "HT202605260001",
"customerId": "3E4B4CXXXX",
"docTitle": "运输合同",
"signKeyword": "甲方签字",
"keywordStrategy": "0",
"signatureId": "SEALXXXXXXXXXX",
"returnUrl": "https://xxx/return",
"notifyUrl": "https://xxx/notify"
}返回参数
| 参数名 | 类型 | 层级 | 说明 |
|---|---|---|---|
| code | int | 1 | 状态码 |
| msg | string | 1 | 请求结果 |
| total | int | 1 | 返回总条数 |
| requestId | string | 1 | 请求编号 |
| data | object | 1 | 返回数据 |
| url | string | 2 | 签约地址 |
成功返回示例
json
{
"code": 200,
"msg": "业务处理成功",
"data": {
"url": "https://xxx/sign"
},
"total": null,
"requestId": "ef1945c"
}失败返回示例
json
{
"code": 500,
"msg": "业务处理失败",
"data": null,
"total": null,
"requestId": "661df7a1"
}