追加手动签署区

文档变更

2022年时，添加签署方手动盖章签署区变为追加手动签署区，以便开发者更容易理解，仅中文名称变更，其功能保持不变。无特殊说明时，文档其他地方及参数中的【签署区】字样等同于【签章区】。

接口描述

添加手动签署区是指向签署流程中添加某签署方信息、签章位置与待签署文件之间的关系并由签署方手动签署。

签署区添加完毕后，可以调用【开启签署流程】接口让签署任务进入签署执行阶段。

若签署流程创建时设置noticeType，此时签署方会收到e签宝短信或邮件通知进行签署操作。

开发者也可调用【获取签署地址】接口获取签署链接，然后业务系统内跳转加载签署链接或自行发送通知。

签署区要素主要包括以下信息：

1. 待签署文件：参数 fileId 代表待签署文件。请确保此fileId已通过【追加待签文件】接口添加到签署流程中。
2. 签署方信息：参数 signerAccountId 代表签署方。若多方签署，可在 signfields 数组中构建多个签署区信息。注意：此处所说签署方具体指平台方的企业用户或个人用户。平台方签署信息请通过【追加自动签署区】接口添加。
3. 签署顺序：如果需要按顺序签署，请通过 order 参数进行设置。值为1时表示首先签署，数字越大签署顺序越靠后。
4. 签章类型：支持指定单页签章、骑缝签章或用户自由选择，由参数 signType 控制（0-页面自由选择，1-单页签章，2-骑缝签章，默认1）。
5. 签章位置：通过页码和XY坐标来确定签章加盖位置，由参数 posPage、posX和posY 控制，页码posPage值从1开始计算且不可超过PDF文件实际总页数。

签署区位置（posBean）需要与签章类型（signType）组合使用，组合使用方法如下：

• signType值为1（单页签章）时，posX、posY和posPage 必须指定具体值，如下：

{
    "signfields":[
        {
           //省略...
           "posBean":{
               "posPage":"3",// 表示 PDF中第三页
               "posX":158.725,// 表示 从页面左下角向右偏移158.725像素
               "posY":431.565// 表示 从页面左下角向上偏移431.565像素
           },
          //省略...
        }
    ]
}

说明：文件内如需多页签章时，可添加多个 signfields 分别设置具体posX、posY和posPage。

• signType值为2（骑缝签章）时，posY和posPage 必须指定具体值，骑缝页码范围通过英文连字号"-"指定，传“all”代表盖全部页码。如下：

{
    "signfields":[
        {
           //省略...
           "posBean":{
               "posPage":"1-5",// 表示 从第1页连续到第5页加盖骑缝章
               "posY":400.000// 表示 从页面右侧边缘向上偏移400.000像素
           },
          //省略...
        }
    ]
}

• signType值为0（用户自由选择）时，posX、posY和posPage所传值无效，以用户页面实际操作为准，因此signType值为0时，posBean对象可以不传。

接口地址&请求方式

接口地址：/v2/signflows/{flowId}/signfields/handSign

请求方式：POST

请求头格式

具体请求头格式结构，请点击查看公共参数说明。

请求参数

响应参数

请求示例  

POST https://openapi.esign.cn/v2/signflows/{flowId}/signfields/handSign

参数示例仅供参考，请根据实际情况传参（演示场景为个人用户和企业用户双方签署）

{
    "signfields": [
        {
            "fileId": "11f2c7031a094256a9d14a6d661612f2",
            "signerAccount": "13100001111",
            "signerAccountInfo": {
                "name": "张三",
                "certNo": "110101199603121978",
                "certType": "CRED_PSN_CH_IDCARD",
                "bankCardNo": ""
            },
            "assignedPosbean": false,
            "posBean": {
                "addSignTime": true,
                "posPage": "1",
                "posX": 200.25,
                "posY": 214.45
            },
            "signType": 1
        },
        {
            "fileId": "11f2c7031a094256a9d14a6d661612f2",
            "signerAccount": "13100001111",
            "authorizedAccount": "esigntest啦啦啦测试企业",
            "actorIndentityType": 2,
            "orgAccountInfo": {
                "certNo": "911112200000000001",
                "certType": "CRED_ORG_USCC",
                "legalRepCertNo": "110101198703182896",
                "legalRepCertType": "CRED_PSN_CH_IDCARD",
                "legalRepName": "李四"
            },
            "signerAccountInfo": {
                "name": "张三",
                "certNo": "110101199603121978",
                "certType": "CRED_PSN_CH_IDCARD",
                "bankCardNo": ""
            },
            "assignedPosbean": false,
            "posBean": {
                "addSignTime": true,
                "posPage": "1",
                "posX": 300.25,
                "posY": 400.45
            },
            "signType": 1
        }
    ]
}

响应示例

{
    "code": 0,
    "message": "成功",
    "data": {
        "signfieldBeans": [
            {
                "signfieldId": "00c05de98d5e4ed4ad17c4f2aadbb001",
                "fileId": "2e6d9f8fe394485896b7714e5e584001",
                "accountId": "d0c38bf54af5408e88582a86a8eb4001"
            },
            {
                "signfieldId": "369783ed7fbf429c81b9d8faeb29e002",
                "fileId": "2e6d9f8fe394485896b7714e5e584002",
                "accountId": "d0c38bf54af5408e88582a86a8eb4002"
            }
        ]
    }
}