eSign.AIeSign.AI
開発者センター

署名ファイルを追加

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

ビジネス情報

【注意】 エラー状況は message のマッチングではなく code に基づいて判断してください。message は変更される可能性があるためです。

data

object

ビジネスデータ

レスポンス例

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