Referenz zu waafir-esign
Der Server waafir-esign stellt einem verbundenen KI-Client den eigenen E-Signatur-Dienst von Waafir
bereit: einen Umschlag (Envelope) über eine Datei Ihrer Organisation erstellen,
ihn von den Unterzeichnern signieren (oder ablehnen) lassen, den Status verfolgen und das signierte
PDF herunterladen. Die Signaturen sind eIDAS-AES (PAdES), erzeugt von Waafirs eigener Signatur-Engine; jede Signatur erfasst die Zustimmung des Unterzeichners (IP-Adresse, User-Agent,
Zeitstempel) in einem manipulationssicheren Audit-Trail, und das signierte PDF wird als
neueste Version der Quelldatei gespeichert.
Verbindung: https://app.waafir.io/api/mcp/waafir oder der Bereichsserver
https://app.waafir.io/api/mcp/waafir-esign — siehe
Einrichtung. Die Tool-Namen sind auf beiden gleich. Lese-Tools benötigen den Scope
read, auf einer durch Anmeldung hergestellten Verbindung oder auf einem
PAT; Erstellen, Senden,
Ablehnen, Ändern der Unterzeichner und Stornieren benötigen den Scope write. Signieren
erfordert write und die Berechtigung, Dokumente zu signieren: bei einer Verbindung auf dem
Zustimmungsbildschirm genehmigt oder beim Erstellen eines Tokens eingeschaltet (siehe
Ein Token Dokumente signieren lassen);
ohne sie ist esign_sign in der Tool-Liste ausgeblendet und wird bei einem Aufruf abgelehnt. Eine auf bestimmte Datenräume beschränkte Verbindung
oder ein solches Token kann nur mit Umschlägen über Dateien in diesen Datenräumen arbeiten — dieselbe
Grenze, die auch die Datenraum-Tools durchsetzen.
Ein monatliches Umschlagkontingent
E-Signaturen werden pro Umschlag abgerechnet — ein Dokument / ein Signaturauftrag zählt einmal, unabhängig davon, wie viele Unterzeichner er hat. Dieser MCP-Server und die Signaturoberfläche in der App greifen beide auf einen gemeinsamen monatlichen Pool zu:
- Der Zugang erfordert das E-Signatures-Add-on oder ein aktives Waafir-Abonnement. Ohne beides wird jede Anfrage an
waafir-esignbereits am Eingang mit HTTP 402 abgelehnt, bevor ein Tool läuft — eine Ablehnung auf Ebene 1.ADDON_NOT_PURCHASEDerscheint immessage-Text dieser Antwort; es ist kein separates maschinenlesbares Feld, verzweigen Sie also anhand des 402-Status, nicht anhand eines Codes. Aufwaafirsind dieesign_-Tools stattdessen in der Tool-Liste ausgeblendet, und ein Aufruf eines solchen Tools wird auf Ebene 2 mitQUOTA_EXCEEDEDund einer Meldung abgelehnt, die das Tool nennt und ebenfallsADDON_NOT_PURCHASEDenthält. - Ihr Tarif enthält ein monatliches Umschlagpaket: Starter 10, Premium 50, Enterprise 50 pro aktivem Platz (Kalendermonat).
- Jede erworbene Einheit des E-Signatures-Add-ons fügt 100 Umschläge pro Monat zu Ihrem Tarifpaket hinzu; Einheiten lassen sich in jedem Tarif kombinieren.
- Das Kontingent ist eine harte Obergrenze: Wenn Sie an der Grenze einen Umschlag senden,
wird das Senden mit dem Wire-Code
QUOTA_EXCEEDEDabgelehnt, mit der Aufforderung, weitere Einheiten zu kaufen oder den Tarif zu wechseln — es wird nie automatisch pro Umschlag abgerechnet. Der Meldungstext nennt außerdem ein internesESIGN_QUOTA_EXCEEDED-Token; das ist Fließtext, verzweigen Sie also anhand vonerror.code, dasQUOTA_EXCEEDEDlautet. Ein Erstellen mitsend: true, das an die Obergrenze stößt, hinterlässt trotzdem den Entwurf — senden Sie ihn, sobald wieder Spielraum besteht, statt ihn erneut zu erstellen.
Das Kontingent wird verbraucht, wenn ein Umschlag gesendet (zur Signatur geöffnet) wird, nicht pro
Signatur — Signieren und Ablehnen verbrauchen also nie Kontingent. Lesezugriffe und Downloads
ebenfalls nicht. Prüfen Sie den Spielraum jederzeit mit esign_quota_status.
Ihre eigene NDA, elektronisch unterzeichnet
Wenn Ihre Organisation ihre eigene NDA hochlädt (Investoren → NDA → Laden Sie Ihre eigene NDA hoch, siehe Anpassbarkeit), unterzeichnet jeder Investor sie in Waafirs Signatur-Oberfläche: Ein angemeldeter Investor wählt NDA unterzeichnen, und das Dokument öffnet sich in einem neuen Tab; ein Besucher über einen Share-Link erhält den Signaturlink per E-Mail an die von ihm eingegebene Adresse. Diese NDA-Umschläge werden nicht auf das monatliche Kontingent angerechnet, und die NDA-Vorlage selbst kann nicht wie ein gewöhnlicher Umschlag gesendet werden.
Tools
Argument- und Ergebnisschlüssel auf diesem Server sind
snake_case— dieselbe Konvention, die jeder andere Waafir-MCP-Server verwendet.file_id,envelope_id,signing_mode,field_layout,consent_affirmed,confirm_send,download_url,has_more.
Inkompatible Änderung —
waafir-esignnahm frühercamelCase-Argumente entgegen.fileId,envelopeId,signingMode,fieldLayoutundconsentAffirmedwerden nicht mehr akzeptiert; jedes hat jetzt einesnake_case- Schreibweise, die in den Tabellen unten aufgeführt ist.confirm_sendist unverändert — es war bereits snake_case.Wo die abgeschaffte Schreibweise ein erforderliches Argument war, wird sie abgelehnt, nicht > stillschweigend akzeptiert: Ein Aufruf, der weiterhin
fileIdanesign_create_envelopesendet, scheitert an der Argumentvalidierung, diefile_idals fehlenden Schlüssel nennt. Wo sie optional war, wird sie stillschweigend verworfen, genau wie jeder andere unbekannte Schlüssel — siehe die beiden Fehlerarten unten. Stellen Sie Ihre Aufrufe auf die Schreibweisen auf dieser Seite um.
Ein falsch geschriebener Schlüssel scheitert auf eine von zwei Arten, und eine davon ist still. Ein unbekanntes Argument wird verworfen, nie abgelehnt, daher hängt das Weitere nur davon ab, ob der gemeinte Schlüssel erforderlich war:
-
Erforderlicher Schlüssel → der Aufruf wird abgelehnt. Das Argument fehlt einfach. Das ist der laute, sichere Fall, und er betrifft
esign_create_envelope(file_id),esign_get_envelope,esign_sign(envelope_idundconsent_affirmed),esign_decline,esign_void_envelope,esign_revise_signers(envelope_idundsignatories) undesign_download_signed— einschließlich jeder abgeschafften camelCase-Schreibweise dieser Schlüssel.Er enthält keinen
error.code. Argumente werden gegen das veröffentlichte Schema des Tools validiert, bevor das Tool läuft, daher kommt ein fehlender erforderlicher Schlüssel — oder einer vom falschen Typ — als Fehlerergebnis zurück, das der Server selbst erzeugt: Die Antwort ist als Fehler gekennzeichnet und ihr Text nennt das fehlerhafte Argument, aber es lief kein Tool, sodass nichts das Felderror.codeder Ebene 2 befüllt. Verzweigen Sie bei einem Fehler in der Argumentform nicht anhand vonINVALID_ARGUMENT— lesen Sie die Meldung.INVALID_ARGUMENTerhalten Sie weiterhin bei einer Ablehnung, die ein Tool nach seinem Start auslöst, etwa bei einem fehlerhaftenconfirm_token. -
Optionaler Schlüssel → der Aufruf gelingt und tut etwas anderes. Sie erhalten ein
200und ein wohlgeformtes Ergebnis, das eine andere Frage beantwortet:- Die Filter von
esign_list_envelopessind optional, daher wird ein verirrtesfileIdverworfen, und Sie erhalten die ungefilterte Liste aller Umschläge, die das Token sehen kann — eine Obermenge, zurückgegeben, als wäre sie die gefilterte Antwort. - Bei
esign_create_envelopebelässt ein verworfenessigningMode: "sequential"den Umschlag in seinem Standardmodusparallel. Das Senden schickt dann eine rechtsverbindliche Signaturanfrage an alle Unterzeichner gleichzeitig, was genau das ist, was die Anforderung vonsequentialverhindern sollte.fieldLayoutwird auf dieselbe Weise verworfen.
- Die Filter von
Da ein verworfener optionaler Schlüssel sich nicht bemerkbar machen kann, prüfen Sie, ob das Ergebnis das widerspiegelt, was Sie angefordert haben — der erstellte Umschlag meldet seinen eigenen
signing_mode, und esign_list_envelopes ist nur gefiltert, wenn Sie den
Filter korrekt geschrieben haben.
esign_create_envelope (Schreiben)
Erstellt einen Umschlag über eine Datei Ihrer Organisation und benennt dessen Unterzeichner. Jede E-Mail-Adresse wird akzeptiert — ein Unterzeichner benötigt kein Waafir-Konto. Wie jeder Einzelne erreicht wird, entscheidet sich beim Senden des Umschlags, danach, ob für diese Adresse bereits ein Waafir-Konto besteht: Ein Kontoinhaber signiert in der Sitzung (eine In-App-Benachrichtigung plus eine E-Mail mit Link zum Signaturbildschirm), und alle anderen erhalten per E-Mail einen Gast-Signaturlink. Entscheidend ist, ob ein Konto existiert, nicht die Mitgliedschaft in Ihrer Organisation, daher signiert auch ein Unterzeichner, der einer anderen Organisation angehört, in der Sitzung. Jeder ausstehende Unterzeichner erhält genau eines von beiden — nie beides, nie keines.
| Feld | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
file_id | string (UUID) | ja | Die zu signierende Datei. Muss zu Ihrer Organisation gehören. |
signatories | array | ja | 1–50 Einträge der Form { "email": string, "name"?: string }. Jede E-Mail wird akzeptiert — Unterzeichner müssen keine Waafir-Nutzer sein; externe Adressen erhalten einen Gast-Signaturlink. |
transaction_id | string (UUID) | nein | Veraltet und ignoriert. Wird akzeptiert, damit bestehende Integrationen weiter funktionieren; senden Sie es nicht mehr. |
send | boolean | nein | Bei true wird der Umschlag sofort zur Signatur geöffnet, in zwei Schritten (siehe unten). Erfordert ein Token mit An Personen außerhalb Ihrer Organisation senden. |
confirm_token | string | nein | Nur mit send: true: das Token aus dem Vorschauaufruf. |
confirm_send | boolean | nein | Veraltet und ignoriert: send: true verwendet jetzt confirm_token. |
signing_mode | "parallel" | "sequential" | nein | Signaturreihenfolge. "parallel" ist der Standard: Unterzeichner können in beliebiger Reihenfolge signieren, und beim Senden werden alle gleichzeitig per E-Mail benachrichtigt. "sequential" benachrichtigt nur den ersten und gibt jeden Unterzeichner frei, sobald alle vorherigen signiert haben; Signieren außerhalb der Reihenfolge wird mit CONFLICT abgelehnt. Weggelassen — oder falsch geschrieben als signingMode — bedeutet "parallel". |
field_layout | array | nein | Überschreibung des Feld-Layouts; weglassen für das Standardlayout. |
observers | array | nein | Bis zu 20 Beobachter (CC) der Form { "email": string, "name"?: string }. Ein Beobachter erhält per E-Mail eine Kopie der Signaturanfrage und jeder Erinnerung, mit einem schreibgeschützten Link, um den Status zu verfolgen. Beobachter signieren nie und erhalten die signierte Kopie nicht. |
send: true funktioniert in zwei Schritten, weil das Senden echte,
rechtsverbindliche Signaturanfrage-E-Mails an jede aufgeführte Adresse verschickt, sobald es
gelingt. Der erste Aufruf erstellt und sendet nichts: Er gibt eine Vorschau zurück (die
Unterzeichner, die Anzahl der Beobachter und Ihr Kontingent) plus ein confirm_token. Rufen Sie
mit identischen Argumenten und dem Token erneut auf, um zu erstellen und zu senden. Ein Token funktioniert
einmal und läuft nach wenigen Minuten ab. Ohne die Berechtigung wird send: true
mit FORBIDDEN (GRANT_REQUIRED) abgelehnt; erstellen Sie den Umschlag dann ohne send
und senden Sie ihn stattdessen in Waafir.
esign_revise_signers verwendet dieselben zwei Schritte und benötigt dieselbe Berechtigung, wenn
es jemandem eine E-Mail senden würde: einem neuen Unterzeichner oder Beobachter auf einem gesendeten Umschlag.
Gibt den Umschlag zurück. Seine Felder sind genau id, file_id, status,
signing_mode, created_by, signed_output_name,
signed_output_version_count, field_layout, packet_page_count und
expires_at — das Ergebnis ist eine manuell zugeordnete Allow-List, daher wird nichts anderes
übertragen. Zeitstempel sind ISO-8601-Zeichenketten.
Ein Umschlagentwurf muss gesendet werden, bevor jemand signieren kann. Das Senden verbraucht einen Umschlag aus Ihrem monatlichen Kontingent — an der Obergrenze gibt ein send
QUOTA_EXCEEDED zurück, und der Umschlag bleibt ein Entwurf, den Sie später senden können. Ein irrtümlich gesendeter
Umschlag kann mit esign_void_envelope zurückgerufen werden.
Eine Datei, die noch geprüft wird. Ist die Datei ein neuer Upload oder eine
neue Version, deren Prüfung Waafir noch nicht abgeschlossen hat, antwortet der
Aufruf mit UNAVAILABLE, error.reason: "ACTIVATION_PENDING" und der Meldung
This file is still being checked. Try again shortly. Es wird nichts erstellt;
rufen Sie das Tool nach kurzer Wartezeit erneut auf.
esign_list_envelopes (Lesen)
Listet die Umschläge Ihrer Organisation auf, die neuesten zuerst, mit den
Unterzeichnern und Status jedes Umschlags. Optionaler Filter: file_id. (transaction_id ist veraltet und wird ignoriert.)
Da die Filter optional sind, wird eine abgeschaffte camelCase-Schreibweise stillschweigend verworfen,
und der Aufruf gibt statt eines Fehlers die ungefilterte Liste zurück; siehe den Hinweis
zu Schlüsseln oben.
Paginiert — limit (optional, 1–100, Standard 25) und offset (optional,
Standard 0) müssen Zahlen sein; ein Wert eines anderen Typs scheitert an der Argumentvalidierung wie jede andere Typabweichung. Eine Zahl außerhalb des Bereichs wird
begrenzt, nicht abgelehnt — limit: 10000 wird zu 100, offset: -2 wird zu
0. Gibt zurück:
{ envelopes: [...],
pagination: { limit, offset, count, has_more, next_offset, total },
filtered_by_pat_scope: boolean }Verwenden Sie has_more, um ein abgeschnittenes von einem vollständigen Ergebnis zu unterscheiden, und folgen Sie
next_offset, bis es null ist; schließen Sie nie aus
count === limit auf weitere Seiten. total ist die Anzahl der Umschläge, die dieses Token sehen kann.
filtered_by_pat_scope ist true, wenn das Token auf bestimmte Datenräume beschränkt ist und diese Allow-List das Ergebnis eingeschränkt hat — das Fenster wird nach
dem Filter angewendet, daher sind die Seiten immer exakt. Es ist bewusst ein Boolean und keine
Anzahl ausgeblendeter Umschläge: Die Angabe, wie viele zurückgehalten wurden, würde die
Existenz und Menge von Umschlägen preisgeben, die das Token nicht sehen darf.
esign_get_envelope (Lesen)
Ruft einen Umschlag mit seinen Unterzeichnern und deren Status ab
(pending / signed / declined). Eingabe: envelope_id. Zusätzlich zu den
oben genannten Feldern des Erstellungs-Tools enthält der Umschlag created_at,
updated_at und signatories (jeweils
{ id, email, name, status, signed_at }).
esign_sign (Schreiben)
Signiert Ihren eigenen ausstehenden Unterzeichnerplatz — den Platz, dessen E-Mail mit dem Nutzer übereinstimmt, dem das Token gehört. Signieren verbraucht kein Kontingent (der Umschlag wurde bereits beim Senden abgerechnet). Erfordert ein Token, bei dem Dokumente signieren eingeschaltet ist.
Das Signieren erfordert zwei Aufrufe, damit Ihr Assistent Ihnen zeigt, was Sie signieren werden, bevor etwas signiert wird:
- Vorschau. Rufen Sie ohne
confirm_tokenauf. Es wird nichts signiert. Das Ergebnis istdry_run: truemit dem Umschlag, dendocumentsin Reihenfolge, einemdocument_hash, der sie alle abdeckt, demsigner, den von Ihnen übergebenenfields, der Zustimmungserklärung, einemconfirm_tokenund dessenexpires_at. - Bestätigen. Sobald die Person zustimmt, rufen Sie erneut mit identischen Argumenten
plus diesem
confirm_tokenauf. Dieser Aufruf signiert.
Ein confirm_token funktioniert einmal, nur für dieses Token und diese Argumente, und
läuft nach fünf Minuten ab. Wenn sich der Umschlag, seine Dokumente, Ihr Platz in der
Signaturreihenfolge oder Ihre Felder zwischenzeitlich ändern, wird die Bestätigung abgelehnt, und Sie
erstellen erneut eine Vorschau.
| Feld | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
envelope_id | string (UUID) | ja | Der zu signierende Umschlag. |
consent_affirmed | boolean | ja | Muss buchstäblich true sein — eine ausdrückliche Bestätigung der Zustimmungserklärung. Es gibt keinen Standardwert; Weglassen oder Übergeben von false lässt den Aufruf an der Protokollgrenze scheitern. |
fields | object | nein | Ausfüllwerte, nach Feldbezeichnung geordnet; Name und Datum werden bei Weglassen vorbelegt. |
confirm_token | string | nein | Weglassen für die Vorschau. Übergeben Sie das von der Vorschau gelieferte Token, um zu signieren. |
Die Bestätigung gibt { envelope } zurück, den Umschlag in derselben Allow-List-Form,
die esign_create_envelope zurückgibt.
Mögliche Fehler: FORBIDDEN, wenn Sie kein ausstehender Unterzeichner des
Umschlags sind, CONFLICT, wenn der Umschlag nicht zur Signatur geöffnet ist — oder, bei einem
sequential-Umschlag, wenn ein vorheriger Unterzeichner noch nicht signiert hat. Dies sind
error.code-Werte in der Nutzlast, keine HTTP-Status — siehe
Einrichtung.
Die zweistufige Bestätigung fügt diese Ablehnungen hinzu, jeweils mit ihrem (code: …) in der
Meldung:
error.code | code: | Was zu tun ist |
|---|---|---|
FORBIDDEN | GRANT_REQUIRED | Das Token kann nicht signieren. Erstellen Sie ein neues mit eingeschaltetem Dokumente signieren. |
INVALID_ARGUMENT | CONFIRM_TOKEN_MALFORMED | Rufen Sie ohne confirm_token erneut auf, um eines zu erhalten. |
CONFLICT | CONFIRM_TOKEN_INVALID | Das Token ist abgelaufen, wurde bereits verwendet oder gehört zu einem anderen Token. Erstellen Sie erneut eine Vorschau. |
CONFLICT | CONFIRM_ARGS_MISMATCH | Die Argumente weichen von denen der Vorschau ab. Erstellen Sie erneut eine Vorschau. |
CONFLICT | CONFIRM_STATE_CHANGED | Der Umschlag hat sich seit der Vorschau geändert. Erstellen Sie erneut eine Vorschau und zeigen Sie sie der Person. |
CONFLICT | DOCUMENT_NOT_PINNED | Der Umschlag wurde vor der Einführung der Dokumentfixierung gesendet. Signieren Sie ihn in Waafir über die Signatur-E-Mail. |
UNAVAILABLE | CONFIRM_UNAVAILABLE | Die Bestätigung ist kurzzeitig nicht verfügbar. Versuchen Sie es in Kürze erneut. |
Wenn das Layout des Umschlags Pflichtfelder hat und fields diese nicht
liefert, wird der Aufruf mit INVALID_ARGUMENT und einer Meldung abgelehnt, die
(code: MISSING_REQUIRED_FIELDS) enthält. Die Meldung nennt die fehlenden
Bezeichnungen nicht; der Signaturbildschirm in der App tut es. Füllen Sie sie aus und rufen Sie erneut auf.
esign_decline (Schreiben)
Lehnt Ihren eigenen ausstehenden Platz ab (endgültig — der Umschlag wird declined).
Eingabe: envelope_id. Gibt { id, status: "declined" } zurück. Verbraucht kein Kontingent.
esign_void_envelope (Schreiben)
Ruft einen irrtümlich gesendeten Umschlag zurück. Das ist die Abhilfe, wenn eine Signaturanfrage verschickt wurde, die nicht hätte verschickt werden sollen: Der Umschlag nimmt keine Signaturen mehr an, alle noch offenen Gast-Signaturlinks werden sofort ungültig, und ausstehende Unterzeichner können nicht mehr handeln.
Eingabe: envelope_id. Gibt den stornierten Umschlag zurück, in derselben Allow-List-Form, die esign_create_envelope zurückgibt.
- Endgültig. Ein stornierter Umschlag kann nicht erneut gesendet werden — erstellen Sie stattdessen einen neuen.
- Bereits erfasste Signaturen und der vollständige Audit-Trail bleiben erhalten; das Stornieren löscht nicht, was bereits signiert wurde.
- Nur zulässig, solange der Umschlag
draft,sentoderpartially_signedist. Jeder andere Status liefertCONFLICT, und ein abgelaufener Umschlag meldet dies statt eines veralteten Status. - Wer stornieren darf: nur die Person, die die Signaturanfrage erstellt hat, oder ein
Eigentümer oder Administrator der Organisation. Alle anderen erhalten
FORBIDDEN; ein Aufrufer, der überhaupt keine Partei des Umschlags ist, erhältNOT_FOUND, sodass das Tool die Existenz eines Umschlags niemandem bestätigt, der davon nichts wissen sollte. - Das Stornieren verbraucht kein Kontingent — und erstattet keines. Kontingent wird berechnet, wenn ein Umschlag gesendet wird.
esign_revise_signers (Schreiben, destruktiv)
Korrigiert, wer zur Signatur aufgefordert wird, ohne den Umschlag zu stornieren und einen zweiten Umschlag aus Ihrem Kontingent zu verbrauchen: eine vertippte E-Mail, eine vergessene Gegenpartei, die falsche Signaturreihenfolge. Der Umschlag behält seine ID, seinen Audit-Trail und seine Kontingenteinheit. Verbraucht kein Kontingent.
| Feld | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
envelope_id | string (UUID) | ja | Der zu ändernde Umschlag. |
signatories | array | ja | Die vollständige Unterzeichnerliste, die der Umschlag am Ende haben soll, in Signaturreihenfolge: 1–50 Einträge der Form { "email": string, "name"?: string }. Sie ersetzt die aktuelle Liste. |
signing_mode | "parallel" | "sequential" | nein | Ändert die Signaturreihenfolge. Weggelassen bedeutet, dass der aktuelle Modus beibehalten wird; er wird nicht auf "parallel" zurückgesetzt. |
observers | array | nein | Die vollständige Beobachterliste (CC), bis zu 20. Weggelassen bedeutet, dass die aktuellen Beobachter beibehalten werden; ein Beobachter, den Sie weglassen, wird entfernt und sein schreibgeschützter Link funktioniert nicht mehr. |
Es ist destruktiv. Ein Unterzeichner, den Sie in signatories weglassen, wird entfernt:
Seine Einladung wird zurückgezogen, sein Signaturlink funktioniert sofort nicht mehr,
und er wird nicht benachrichtigt. Alle für ihn platzierten Felder werden gelöscht. Ein Unterzeichner, der
bereits auf dem Umschlag steht, behält seinen Link und erhält keine erneute E-Mail. Ein neuer
Unterzeichner wird sofort eingeladen, wenn der Umschlag bereits gesendet wurde. Das
Tool ist mit destructiveHint: true gekennzeichnet, sodass ein Client, der destruktive
Aufrufe bestätigen lässt, vor der Ausführung nachfragt.
- Nur bis zur ersten Signatur. Sobald jemand signiert hat, sind die Unterzeichnerliste
und der Signaturmodus eingefroren: Der Aufruf wird mit
CONFLICT(code: ESIGN_SIGNERS_FROZEN)abgelehnt, und die Abhilfe besteht darin, den Umschlag zu stornieren und einen neuen zu erstellen. Ein abgelaufener Umschlag wird ebenfalls mitCONFLICTabgelehnt. - Nur die Beobachter ändern. Übergeben Sie die unveränderte Unterzeichnerliste (und den Modus)
mit einer neuen
observers-Liste. Das Entfernen eines Beobachters ist jederzeit erlaubt, auch nach dem Signieren oder Abschluss. Das Hinzufügen ist nur erlaubt, solange der Umschlag ein Entwurf ist oder sich in der Signatur befindet. - Wer einen gesendeten Umschlag ändern darf: nur die Person, die die Signaturanfrage erstellt hat, oder ein Eigentümer oder Administrator der Organisation; alle anderen erhalten
FORBIDDEN. Einen Entwurf kann jeder ändern, der ihn sehen kann. - Andere Ablehnungen nennen ihren Grund in der Meldung: Eine doppelte Adresse
(
ESIGN_DUPLICATE_SIGNATORY) oder eine leere Liste (ESIGN_EMPTY_ROSTER) istINVALID_ARGUMENT; ein neuer Unterzeichner oder Beobachter auf einem gesendeten Umschlag, wenn Sie nicht jedes Dokument lesen können, das er umfasst, istFORBIDDEN.
Gibt den Umschlag in derselben Form wie
esign_get_envelope zurück, plus eine revision-Zusammenfassung
der Änderungen (und observer_revision, wenn Beobachter übergeben wurden).
esign_list_my_pending_signatures (Lesen)
Listet die Umschläge auf, die in dieser Organisation auf Ihre eigene Signatur warten: jeden
offenen Umschlag mit einem ausstehenden Unterzeichnerplatz, der zur E-Mail des Token-Eigentümers passt. Dies ist der nützlichste Lesezugriff vor esign_sign.
Keine Eingaben. Gibt
{ envelopes: [{ id, file_id, document_name, status, created_at }] } zurück.
Beschränkt auf die Organisation dieses Tokens und, falls das Token eingeschränkt ist, auf dessen Datenraum-Allow-List — ausstehende Signaturen in anderen Organisationen werden nie angezeigt, auch wenn Sie dort Unterzeichner sein mögen.
esign_download_signed (Lesen)
Liefert eine kurzlebige vorsignierte Download-URL für das signierte PDF. Eingabe:
envelope_id. Gibt { download_url, expires_in_seconds } zurück. Der Umschlag
muss mindestens eine erfasste Signatur haben; das signierte PDF ist im
Produkt auch als neueste Version der Quelldatei verfügbar. Erfordert ein Token, bei dem
Dokumentinhalt lesen eingeschaltet ist; ohne diese Berechtigung wird der Aufruf mit
GRANT_REQUIRED abgelehnt.
esign_quota_status (Lesen)
Keine Eingaben. Gibt { quota, used, remaining } für den aktuellen Kalendermonat zurück — gesamtes Umschlagkontingent (Tarifpaket + erworbene Einheiten), gesendete Umschläge
und den Spielraum bis zur Obergrenze.
esign_remind (Schreiben)
Eingabe envelope_id. Sendet jedem ausstehenden Unterzeichner eines Umschlags, der sich in der
Signatur befindet, erneut eine E-Mail und jedem Beobachter eine Kopie, höchstens einmal pro Stunde und Umschlag. Erfordert An Personen außerhalb Ihrer Organisation senden und verwendet zwei Schritte: Der erste Aufruf sendet nichts
und gibt zurück, wer eine E-Mail erhalten würde, Beobachter namentlich, plus ein confirm_token; rufen Sie
damit erneut auf. Ein zwischenzeitlich hinzugefügter Beobachter lässt die Bestätigung scheitern.
Nur für Deal-Team-Mitglieder.
esign_resend_signatory (Schreiben)
Eingaben envelope_id, signatory_id. Hebt die Sperre einer unzustellbaren oder unterdrückten Adresse auf und
sendet diesem Unterzeichner erneut eine E-Mail. Gleiche Berechtigung und zwei Schritte wie bei esign_remind.
esign_send_draft (Schreiben)
Eingabe envelope_id. Sendet einen gespeicherten Entwurf: Jeder Unterzeichner erhält per E-Mail eine
rechtsverbindliche Signaturanfrage, jeder Beobachter eine Kopie, und ein Umschlag des
Kontingents wird verbraucht. Gleiche Berechtigung und zwei Schritte; die Vorschau nennt die Unterzeichner,
die Beobachter und Ihr Kontingent, und es werden genau die Unterzeichner und Beobachter gesendet, die Sie in der Vorschau
gesehen haben. Das Ergebnis listet jede suppressed-Adresse auf, an die keine
E-Mail gesendet wurde.
esign_preview (Lesen)
Eingabe envelope_id. Gibt den Umschlag so zurück, wie ihn sein Signaturbereich zeigt:
{ envelope_id, status, file_id, document_name, is_creator, signers, placed, fields, shows_signed_output, shows_live_source }. document_name ist null, wenn
Sie das Dokument nicht lesen dürfen. Es wird kein Dokumentinhalt zurückgegeben. Nur für Deal-Team-Mitglieder.
esign_verify (Lesen)
Eingabe envelope_id. Gibt die Zertifikats- und Integritätszusammenfassung zurück, die die Waafir-Verifizierungsseite anzeigt. Nur für Deal-Team-Mitglieder.
Rechtsgültigkeit
Die Signaturen sind eIDAS-fortgeschrittene elektronische Signaturen (AES, PAdES), gültig für NDAs und Verträge nach US ESIGN/UETA und EU eIDAS. Die Zustimmung des Unterzeichners (IP, User-Agent, Zeitstempel) wird zum Zeitpunkt der Signatur im nur anfügbaren, hash-verketteten Audit-Trail von Waafir erfasst. Über diesen MCP-Server erstellte oder gesendete Umschläge werden in diesem Trail als tokeninitiierte Aktionen erfasst, sodass ein von einem Agenten ausgelöstes Senden immer von einem unterscheidbar ist, das eine Person in der App ausgeführt hat. Qualifizierte Signaturen (QES) sind nicht Teil dieses Releases.