開發者中心

新增簽署檔案

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
}