开发者中心

添加签署文件

POST /esignglobal/v1/envelope/files/addSignFiles

接口描述

信封未开启时,支持向信封中添加待签署文件,已经开启的信封不支持追加签署文件。

请求参数

参数名称

类型

必填

说明

envelopeId

string

true

信封 ID

signFiles

array

true

签署文件信息集合,显示顺序为文件添加顺序。

 

fileKey

string

true

签署文件fileKey,仅支持PDF格式

 documentFieldsarrayfalse文件维度控件列表。用于在指定文件上添加不绑定签署人的文件维度控件。
  

fieldType

string

false

控件类型。传 eMeterai 表示印尼印花税控件。

  

pageNo

string

false

控件所在页码。印尼印花税控件仅支持指定单页,需传入单个页码,不支持 1-3、1,3 等连续或非连续多页格式。

  posXfloatfalsex 轴偏移量,页面左下角为坐标原点。坐标范围与其他控件坐标范围一致。
  posYfloatfalsey 轴偏移量,页面左下角为坐标原点。坐标范围与其他控件坐标范围一致。

请求示例

{   
  "envelopeId": "9fbe6c8190824227bde29136b0145c81",
  "signFiles": [
  {
    "fileKey": "4150a67c-d4f0-45e6-88e9-541ce6d0c73c"
  }
]
}

响应参数

参数名称

类型

说明

code

int

业务码,0表示成功,非0表示异常。

message

string

业务信息

【注意】 请根据code 来判断错误情况,不应该依赖 message匹配,因为 message 可能会调整

data

object

业务数据

响应示例

{
    "code": "0",
    "message": "success",
    "data": null
}