開発者センター

封筒を閉じる

POST/esignglobal/v1/envelope/finish

インターフェースの説明

手動でエンベロープを終了します。エンベロープを終了する前に、エンベロープ内のすべての署名者が署名を完了する必要があります。署名プロセスが完了すると、すべてのリソースを変更できなくなります。

連携プラットフォームが「クイックエンベロープ作成」インターフェースを使用してエンベロープを作成する場合、このインターフェースを呼び出す必要はありません。署名が完了すると、システムが自動的に呼び出します。

リクエストパラメータ

パラメータ名

タイプ

必須

説明

envelopeId

string

true

エンベロープID

リクエスト例

{
  "envelopeId":"flow1234567890"
}

レスポンスパラメータ

パラメータ名

タイプ

説明

envelopeId

string

封筒ID

envelopeStatus

int

封筒ステータス

0 - 作成済み(下書き)

1 - 署名中

2 - 完了

3 - 期限切れ

5 - 取り消し済み

レスポンスの例

{
  "code": "0",
    "data": {
    "envelopeId": "xxxx",
      "envelopeStatus": 2
  },
  "message": "success"
}

 

インターフェースの説明
リクエストパラメータ
リクエスト例
レスポンスパラメータ
レスポンスの例