Briefumschlag beenden

POST/esignglobal/v1/envelope/finish

Schnittstellenbeschreibung

Beendet einen Umschlag manuell. Vor dem Beenden des Umschlags müssen alle Unterzeichner im Umschlag die Unterzeichnung abgeschlossen haben. Nach Abschluss des Unterzeichnungsprozesses können alle Ressourcen nicht mehr geändert werden.

Wenn die Andockplattform die Schnittstelle „Umschlag schnell initiieren“ verwendet, um einen Umschlag zu erstellen, ist es nicht erforderlich, diese Schnittstelle aufzurufen. Das System ruft sie automatisch auf, nachdem die Unterzeichnung abgeschlossen ist.

Anfrageparameter

Parametername	Typ	Erforderlich	Beschreibung
envelopeId	string	true	Umschlag-ID

Beispielanfrage

{
  "envelopeId":"flow1234567890"
}

Antwortparameter

Parametername

Typ

Beschreibung

envelopeId

string

Briefumschlag-ID

envelopeStatus

int

Briefumschlagstatus

0-Erstellt (Entwurf)

1-In Bearbeitung

2-Abgeschlossen

3-Abgelaufen

5-Widerrufen

Beispielantwort

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