添加手动盖章签署区
接口地址 /v1/signflows/{flowId}/signfields/handSign
请求方式 POST
接口描述 向指定流程中创建签署区,每个签署区视为一个任务,系统会自动按照流程流转。 签署区的添加必须在签署文档添加之后, 签署区信息内部包含签署文档信息.
签署区创建完成,流程开启后,通过获取签署地址接口,可获取用户手动签署链接,通过此链接可打开文件签署页面,进行人工确认签署。
请求参数
参数名称 | 说明 | 参数类型 | 必填 | 类型 | ||
---|---|---|---|---|---|---|
flowId | 流程id | path | true | string | ||
signfields | 签署区列表数据 | body | true | array | ||
fileId | 文件file id | body | true | string | ||
signerAccountId | 签署操作人个人账号标识,即操作本次签署的个人,如需e签宝通知用户签署,则系统向该账号下绑定的手机、邮箱发送签署链接 | body | true | string | ||
authorizedAccountId | 签约主体账号标识,即本次签署对应任务的归属方,如传入机构id,则签署完成后,本任务可在企业账号下进行管理,默认是签署操作人个人 | body | false | string | ||
actorIndentityType | 机构签约类别,当签约主体为机构时必传:2-机构盖章; | body | false | int32 | ||
assignedPosbean | 是否指定位置,如指定位置则posBean不可为空;一旦设置为TRUE,表示用户签署时不允许更新位置 | body | false | boolean | ||
order | 签署区顺序,默认1,且不小于1,顺序越小越先处理 | body | false | int32 | ||
posBean | 签署区位置信息 。signType为0时,本参数无效; signType为1时, 页码和XY坐标不能为空; signType为2时, 页码和Y坐标不能为空 | body | false | object | ||
posPage | 页码信息,当签署区signType为2时, 页码可以'-'分割, 其他情况只能是数字 | body | false | string | ||
posX | x坐标,默认空 | body | false | float | ||
posY | y坐标 | body | false | float | ||
width | 签署区宽,默认印章宽度 | body | false | float | ||
signDateBeanType | 是否需要添加签署日期,0-禁止 1-必须 2-不限制,默认0 | body | false | int32 | ||
signDateBean | 签章日期信息 | body | false | SignDateBean | ||
fontSize | 签章日期字体大小,默认12 | body | false | int32 | ||
format | 签章日期格式,yyyy年MM月dd日 | body | false | string | ||
posPage | 页码信息,当signDateBeanType为1时,代表签署的印章必须展示签署日期,默认放在印章正下方,签署人可拖拽日期到当前页面的其他位置,如果发起方指定签署位置的同时,需要同时指定日期盖章位置,则需传入日期盖章页码(与印章页码相同),在传入X\Y坐标即可。 | body | false | int32 | ||
posX | x坐标,默认0 | body | false | float | ||
posY | y坐标,默认0 | body | false | float | ||
sealType | 签署方式,个人签署时支持多种签署方式,0-手绘签名 ,1-个人签章盖章,多种类型时逗号分割,为空不限制 | body | false | string | ||
sealId | 印章id | body | false | string | ||
signType | 签署类型,0-不限,1-单页签署,2-骑缝签署,默认1 | body | false | int32 | ||
thirdOrderNo | 第三方业务流水号id,保证相同签署人、相同签约主体、相同签署顺序的任务,对应的第三方业务流水id唯一,默认空 | body | false | string |
请求示例
POST https://openapi.esign.cn/v1/signflows/{flowId}/signfields/handSign
{
"signfields":[
{
"signerAccountId":"faea8237c61a4fdea864ee8d7621e14f",
"authorizedAccountId":"2c7de24aff3340f5b944ebac49545b8e",
"actorIndentityType":2,
"fileId":"fe7df2f477d649c18ebcfdfffeba253d",
"order":1,
"assignedPosbean":true,
"posBean":{
"posPage":"1",
"posX":158.72531,
"posY":431.05658
},
"sealType":"0",
"sealId":"0123",
"signType":1
}
]
}
响应参数
参数名称 | 说明 | 类型 | |
---|---|---|---|
signfieldBeans | 签署区列表数据 | array | |
accountId | 用户ID | string | |
fileId | 文档ID | string | |
signfieldId | 签署区id | string |
响应示例
{
"code":0,
"data":{
"signfieldBeans":[
{
"accountId":"faea8237c61a4fdea864ee8d7621e14f",
"fileId":"fe7df2f477d649c18ebcfdfffeba253d",
"signfieldId":"b76b69d5b48d4f689cae997e42809ac4"
}
]
},
"message":"成功"
}
错误码
错误码 | 错误信息 | 错误原因 |
---|---|---|
1437511 | 文档不存在,fileId:XXX | 签署区里的fileId为空或fileId无效 |
1437306 | XXXX:签署页码超出文档页数 | 签署区的页码大于文档页数 |
1435002 | 未定义的signType | 签署类型无效, signType仅支持: 0-不限, 1-单页签署, 2-骑缝签 |
未定义的actorIndentityType | 主体类型无效, 0-个人主体, 1- 机构主体 | |
缺少签署主体信息 | actorIndentityType为1场景下,authorizedAccountId值为空 | |
未定义的sealType | 印章类型无效, 0-手绘印章,1-模版印章,为空不限制 | |
缺少签署印章数据 | 签署区的assignedSeal值为true场景下, 印章数据为空 | |
位置信息为空 | 签署区的assignedPosbean值为true场景下, 签署坐标信息为空 | |
单页签署:必须指定正确的page、x、y | 单页签署没有指定页码和XY轴坐标 | |
关键字签署:必须指定keyword | 关键字签署的签署区关键字信息为空 | |
骑缝签署:必须指定y | 骑缝签的签署区没有指定y轴坐标 | |
骑缝签署:必须满足'-'分割 | 骑缝签的签署区指定的页码格式不对, 页码要以'-'分隔, 比如1-5 | |
签署区设置自动执行,没有指定印章 | 签署区的autoExecute值为true但是没有指定印章信息 | |
签署区设置自动执行,签署主体不允许为空 | 签署区的autoExecute值为true但是没有指定签署主体信息 | |
签署区设置自动执行,签署类型错误 | 签署区的autoExecute值为true但是指定的签署类型无效, 有效的签署类型为: 1-单页签署, 2-骑缝签 |