Freigeben über

SignatureAPI

Senden Sie Dokumente zum Signieren, verfolgen Sie ihren Fortschritt und erledigen Sie ihre Arbeit schneller mit SignatureAPI, der für die Automatisierung entwickelten elektronischen Signaturplattform. https://signatureapi.com/docs/integrations/power-automate/getting-started

Dieser Connector ist in den folgenden Produkten und Regionen verfügbar:

Dienstleistung Class Regions
Copilot Studio Premium Alle Power Automate-Regionen mit Ausnahme der folgenden Bereiche:
     - US Government (GCC)
     - US Government (GCC High)
     - China Cloud betrieben von 21Vianet
     - US Department of Defense (DoD)
Logik-Apps Norm Alle Logik-Apps-Regionen mit Ausnahme der folgenden Bereiche:
     – Azure Government-Regionen
     - Azure China-Regionen
     - US Department of Defense (DoD)
Power Apps Premium Alle Power Apps-Regionen mit Ausnahme der folgenden:
     - US Government (GCC)
     - US Government (GCC High)
     - China Cloud betrieben von 21Vianet
     - US Department of Defense (DoD)
Power Automate Premium Alle Power Automate-Regionen mit Ausnahme der folgenden Bereiche:
     - US Government (GCC)
     - US Government (GCC High)
     - China Cloud betrieben von 21Vianet
     - US Department of Defense (DoD)
Kontakt
Name Signatur-API, Inc.
URL https://signatureapi.com
Email support@signatureapi.com
Connectormetadaten
Herausgeber SignatureAPI
Webseite https://signatureapi.com/power-automate
Datenschutzrichtlinie https://signatureapi.com/privacy
Kategorien Zusammenarbeit; Produktivität

SignatureAPI

SignatureAPI ist eine elektronische Signaturplattform, die für die Automatisierung entwickelt wurde.

Senden Sie Dokumente zum Signieren und Nachverfolgen ihres Fortschritts mithilfe unserer E-Signatur-Plattform für Power Automate, die verschiedene Aktionen und Trigger bereitstellt, die Sie beim Erstellen einfacher und komplexer Workflows unterstützen.

Elektronische Signaturen, die mit SignatureAPI erstellt werden, sind rechtsverbindlich und global akzeptiert, genau wie herkömmliche Freihandsignaturen in den meisten Rechtsordnungen.

SignatureAPI bietet kostengünstige Preise für die Automatisierung mit hohem Volumen. Sehen Sie sich unsere Preisdetails an.

Wichtige Merkmale

  • Mehrere Empfänger: Senden von Dokumenten an bis zu 10 Signierer in einer einzelnen Transaktion.
  • Parallele oder sequenzielle Signatur: Wählen Sie aus, dass Dokumente gleichzeitig oder in einer bestimmten Reihenfolge an alle Empfänger gesendet werden sollen.
  • Dokumentvorlagen: Erstellen Sie Dokumente programmgesteuert mithilfe von Vorlagen und dynamischen Daten.
  • Sprachen und Lokalisierung: Passen Sie die Signaturschnittstelle mit verschiedenen Sprachen, Datums-/Uhrzeitformaten und Zeitzonen an.
  • Kontoloses Signieren: Empfängern das Signieren von Dokumenten erlauben, ohne sich bei einem Konto anzumelden.
  • Überwachungsprotokoll: Verwalten Sie ein detailliertes Protokoll des Dokumentzugriffs, der Überprüfung und der Signaturereignisse.
  • Manipulationsprüfung: Sicherstellen der Dokumentintegrität mit überprüfter, unwiderstehlicher Nachweis nach der Signatur.
  • Umschläge nachverfolgen: Überwachen des Signierfortschritts über ein benutzerfreundliches Dashboard.
  • Real-Time Benachrichtigungen: Empfangen von sofort aktualisierten Signaturaktivitäten per E-Mail und Webhooks.

Voraussetzungen

Um diesen Connector zu verwenden, registrieren Sie sich für ein SignatureAPI-Konto, und generieren Sie einen API-Schlüssel. Rufen Sie einen kostenlosen Test-API-Schlüssel ab, und richten Sie Ihre Verbindung ein.

Erste Schritte

Der am häufigsten verwendete Workflow umfasst das Senden eines oder mehrerer Dokumente an Empfänger für die Signatur. Die Empfänger erhalten eine E-Mail mit einem Link für den Zugriff auf die Signaturschnittstelle.

SignatureAPI unterstützt erweiterte Workflows. In unseren Konnektorhandbüchern finden Sie schrittweise Anleitungen, Anwendungsfälle und Automatisierungsstrategien.

Schritt 1: Erstellen eines Umschlags

Beginnen Sie mit dem Erstellen eines leeren Umschlags. Ein Umschlag ist ein Container, der Dokumente enthält und den Signaturprozess verwaltet.

Zu den Optionen gehören:

Schritt 2: Hinzufügen von Empfängern

Geben Sie an, wer die Dokumente signieren muss, indem Sie Empfänger zu Ihrem Umschlag hinzufügen. Derzeit werden nur Signierer unterstützt, aber in Zukunft werden weitere Empfängertypen verfügbar sein.

Schritt 3: Hinzufügen von Dokumenten

Fügen Sie die Dokumente hinzu, die Signaturen benötigen. Sie können PDF- oder DOCX-Dateien hochladen oder Dokumente mithilfe von Daten aus Vorlagen generieren.

Schritt 4: Definieren von Orten in den Dokumenten

Orte sind bestimmte Bereiche innerhalb eines Dokuments, in denen ein Empfänger interagiert, z. B. Signieren, Bereitstellen von Initialen oder Hinzufügen von Text. Sie können auch statische oder berechnete Werte wie Abschlusstermine enthalten.

Schritt 5: Starten des Signierungsprozesses

Sobald der Umschlag vollständig vorbereitet ist, initiieren Sie den Signiervorgang.

Schritt 6: Warten, bis der Umschlag abgeschlossen ist

Damit der gesamte Workflow innerhalb desselben Flusses bleibt, können Sie warten, bis der Umschlag abgeschlossen ist. Dadurch wird sichergestellt, dass alle Empfänger signiert sind und der Lieferumfang (signiertes Dokument) generiert wird.

Alternativ können Sie einen separaten Workflow auslösen, wenn der Umschlag abgeschlossen ist und der Lieferumfang generiert wird.

Schritt 7: Abrufen des signierten Dokuments

Rufen Sie nach Abschluss des Vorgangs das signierte Dokument (Lieferumfang) ab.

Arbeiten mit Triggern

SignatureAPI bietet Trigger, um Ihre Workflows zu automatisieren und Prozesse zu optimieren. Erfahren Sie mehr über die vollständige Liste der Trigger und deren Verwendung.

Häufig verwendete Trigger

Wenn ein Lieferumfang generiert wird

Wird ausgelöst, wenn der Umschlag abgeschlossen ist und das signierte Dokument (Lieferumfang) bereit ist.

Wenn ein Empfänger einen Umschlag abschließt

Wird jedes Mal ausgelöst, wenn ein Empfänger seinen Teil des Signiervorgangs beendet hat.

Wenn eine Empfänger-E-Mail unzustellbarkeiten

Wird ausgelöst, wenn die E-Mail-Adresse eines Empfängers die Anforderung nicht empfangen kann.

Bekannte Probleme und Einschränkungen

  • Verwenden Sie einen API-Testschlüssel, um Testumschläge zu erstellen. Diese Umschläge senden keine echten E-Mails und werden nicht in Rechnung gestellt, sodass sie perfekt zum Testen geeignet sind. Erfahren Sie mehr über Testumschläge.
  • Die Aktion "Auf Umschlag warten" wird nach 30 Tagen ausgecheckt. Wenn Sie erwarten, dass Empfänger länger dauern, verwenden Sie stattdessen einen neuen Workflow, der mit dem Trigger "Wenn ein Lieferumfang generiert wird" beginnt.

Häufige Fehler und Lösungen

  • Stellen Sie sicher, dass die Aktion "Lieferumfang abrufen " nach der Aktion "Auf Umschlag warten " ausgeführt wird. Lieferumfang sind nur verfügbar, wenn alle Empfänger ihren Teil abgeschlossen haben.
  • Wenn Sie von einem Test-API-Schlüssel zu einem Live-API-Schlüssel wechseln, aktualisieren Sie den Trigger, um sicherzustellen, dass der Webhook in der richtigen Umgebung erstellt wird (Live oder Test). Ausführliche Informationen finden Sie in unserem Handbuch zur Problembehandlung .

Erstellen einer Verbindung

Der Connector unterstützt die folgenden Authentifizierungstypen:
Vorgabe Parameter zum Erstellen einer Verbindung. Alle Regionen Nicht teilbar

Vorgabe

Anwendbar: Alle Regionen

Parameter zum Erstellen einer Verbindung.

Dies ist keine freigabefähige Verbindung. Wenn die Power-App für einen anderen Benutzer freigegeben wird, wird ein anderer Benutzer aufgefordert, eine neue Verbindung explizit zu erstellen.

Name Typ Description Erforderlich
API-Schlüssel securestring Der API-Schlüssel für Ihr SignatureAPI-Konto. Richtig

Drosselungsgrenzwerte

Name Aufrufe Verlängerungszeitraum
API-Aufrufe pro Verbindung 100 60 Sekunden

Aktionen

Abrufen eines Empfängers

Ruft Die Empfängerdetails anhand ihrer ID ab. https://signatureapi.com/docs/integrations/power-automate/actions/get-recipient
Abrufen eines erfassten Werts

Ruft einen Wert ab, der von einem Empfänger während der Signatur an einem Eingabeort eingegeben wurde. https://signatureapi.com/docs/integrations/power-automate/actions/get-capture
Abrufen eines Lieferumfangs

Ruft einen Lieferumfang mithilfe seiner ID ab. Verwenden Sie sie, um eine signierte Kopie des Umschlags herunterzuladen. https://signatureapi.com/docs/integrations/power-automate/actions/get-deliverable
Abrufen eines Umschlags

Ruft Umschlagdetails anhand der ID ab. https://signatureapi.com/docs/integrations/power-automate/actions/get-envelope
Auf Umschlag warten

Wartet auf einen Umschlag, um einen abgeschlossenen Status oder einen anderen endgültigen Status zu erreichen. https://signatureapi.com/docs/integrations/power-automate/actions/wait-envelope
Erstellen einer Zeremonie – benutzerdefinierte Authentifizierung

Erstellt eine Zeremonie, bei der der Empfänger extern bei SignatureAPI authentifiziert wird. Verwenden Sie dies, um eine Zeremonie-URL für die Freigabe für Empfänger zu erhalten. Vor der Verwendung von benutzerdefiniertem Authentifizierungslesevorgang https://signatureapi.com/docs/integrations/power-automate/actions/create-ceremony-custom
Erstellen einer Zeremonie – E-Mail-Linkauthentifizierung

Erstellt eine Zeremonie, bei der der Empfänger über einen Link authentifiziert wird, der an seine E-Mail gesendet wird. https://signatureapi.com/docs/integrations/power-automate/actions/create-ceremony-email-link
Erstellen eines Umschlags

Erstellt einen neuen Umschlag, dem Sie Empfänger und Dokumente hinzufügen können. Wenn Sie bereit sind, verwenden Sie die Aktion "Umschlag starten", um den Signiervorgang zu initiieren. https://signatureapi.com/docs/integrations/power-automate/actions/create-envelope
Hinzufügen einer Stelle – Text

Fügt einem Dokument eine Textstelle hinzu. https://signatureapi.com/docs/integrations/power-automate/actions/add-text-place
Hinzufügen einer Stelle – Texteingabe

Fügt einem Dokument eine Texteingabestelle hinzu. https://signatureapi.com/docs/integrations/power-automate/actions/add-text-input-place
Hinzufügen einer Vorlage – DOCX

Fügt einem Umschlag eine DOCX-Vorlage hinzu. https://signatureapi.com/docs/integrations/power-automate/actions/add-template
Hinzufügen eines Dokuments – DOCX

Fügt einem Umschlag ein DOCX-Dokument hinzu. https://signatureapi.com/docs/integrations/power-automate/actions/add-document-docx
Hinzufügen eines Dokuments – PDF

Fügt einem Umschlag ein PDF-Dokument hinzu. https://signatureapi.com/docs/integrations/power-automate/actions/add-document
Hinzufügen eines Empfängers – Signierer

Fügt einen Empfänger zu einem Umschlag hinzu. https://signatureapi.com/docs/integrations/power-automate/actions/add-recipient
Hinzufügen von Daten zur Vorlage

Fügt einer Vorlage Daten hinzu. https://signatureapi.com/docs/integrations/power-automate/actions/add-template-data
Löschen eines Umschlags

Löscht einen Umschlag und alle zugehörigen Informationen. https://signatureapi.com/docs/integrations/power-automate/actions/delete-envelope
Ort hinzufügen – Datum der Fertigstellung des Empfängers

Fügt einem Dokument einen Abgeschlossenen Datumsplatz eines Empfängers hinzu. https://signatureapi.com/docs/integrations/power-automate/actions/add-recipient-completed-date-place
Ort hinzufügen – Datum der Fertigstellung des Umschlags

Fügt einem Dokument einen umschlag abgeschlossenen Termin hinzu. https://signatureapi.com/docs/integrations/power-automate/actions/add-envelope-completed-date-place
Ort hinzufügen – Initialen

Fügt einem Dokument eine Initiale hinzu. https://signatureapi.com/docs/integrations/power-automate/actions/add-initials-place
Ort hinzufügen – Signatur

Fügt einem Dokument eine Signaturstelle hinzu. https://signatureapi.com/docs/integrations/power-automate/actions/add-signature-place
Starten eines Umschlags

Initiiert den Signierungsprozess für einen Umschlag. https://signatureapi.com/docs/integrations/power-automate/actions/start-envelope

Abrufen eines Empfängers

Vorgangs-ID:
GetRecipient

Ruft Die Empfängerdetails anhand ihrer ID ab. https://signatureapi.com/docs/integrations/power-automate/actions/get-recipient

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Empfänger-ID
 recipientId True string

Die ID des Empfängers.

Gibt zurück

Body
Recipient

Abrufen eines erfassten Werts

Vorgangs-ID:
GetCapture

Ruft einen Wert ab, der von einem Empfänger während der Signatur an einem Eingabeort eingegeben wurde. https://signatureapi.com/docs/integrations/power-automate/actions/get-capture

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Umschlag-ID
 envelopeId True string

Die ID des Umschlags.
Aufnahmeschlüssel
 captureKey True string

Der Schlüssel des erfassten Werts.

Gibt zurück

Body
Capture

Abrufen eines Lieferumfangs

Vorgangs-ID:
GetDeliverable

Ruft einen Lieferumfang mithilfe seiner ID ab. Verwenden Sie sie, um eine signierte Kopie des Umschlags herunterzuladen. https://signatureapi.com/docs/integrations/power-automate/actions/get-deliverable

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Lieferumfangs-ID
 deliverableId True string

Die ID des Lieferumfangs.

Gibt zurück

Body
Deliverable

Abrufen eines Umschlags

Vorgangs-ID:
GetEnvelope

Ruft Umschlagdetails anhand der ID ab. https://signatureapi.com/docs/integrations/power-automate/actions/get-envelope

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Umschlag-ID
 envelopeId True string

Die ID des Umschlags.

Gibt zurück

Body
Envelope

Auf Umschlag warten

Vorgangs-ID:
WaitEnvelope

Wartet auf einen Umschlag, um einen abgeschlossenen Status oder einen anderen endgültigen Status zu erreichen. https://signatureapi.com/docs/integrations/power-automate/actions/wait-envelope

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Umschlag-ID
 envelopeId True string

Die ID des Umschlags.

Gibt zurück

Body
Envelope

Erstellen einer Zeremonie – benutzerdefinierte Authentifizierung

Vorgangs-ID:
CreateCeremonyCustom

Erstellt eine Zeremonie, bei der der Empfänger extern bei SignatureAPI authentifiziert wird. Verwenden Sie dies, um eine Zeremonie-URL für die Freigabe für Empfänger zu erhalten. Vor der Verwendung von benutzerdefiniertem Authentifizierungslesevorgang https://signatureapi.com/docs/integrations/power-automate/actions/create-ceremony-custom

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Empfänger-ID
 recipientId True string

Die ID des Empfängers.
Authentifizierungsanbieter
 provider True string

Der Name des Authentifizierungsanbieters. Dieser Wert ist beliebig und wird in den Überwachungsprotokollen des Umschlags angezeigt.
Authentifizierungsdaten
 data True array of string

Schlüssel: Wertpaar, das Authentifizierungsmetadaten enthält. Diese Details werden in die Überwachungsprotokolle des Umschlags aufgenommen.
Umleitungs-URL
 redirect_url string

Eine URL zum Umleiten des Empfängers nach Abschluss einer Zeremonie. Weitere Informationen finden Sie unter: https://signatureapi.com/docs/resources/ceremonies/redirect-url
Zusätzliche Eigenschaften
 extra string

Zusätzliche Eigenschaften zur Erweiterbarkeit

Gibt zurück

Body
CreateCeremonyCustomOutput

Erstellen einer Zeremonie – E-Mail-Linkauthentifizierung

Vorgangs-ID:
CreateCeremonyEmailLink

Erstellt eine Zeremonie, bei der der Empfänger über einen Link authentifiziert wird, der an seine E-Mail gesendet wird. https://signatureapi.com/docs/integrations/power-automate/actions/create-ceremony-email-link

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Empfänger-ID
 recipientId True string

Die ID des Empfängers.
Umleitungs-URL
 redirect_url string

Eine URL zum Umleiten des Empfängers nach Abschluss einer Zeremonie. Weitere Informationen finden Sie unter: https://signatureapi.com/docs/resources/ceremonies/redirect-url
Zusätzliche Eigenschaften
 extra string

Zusätzliche Eigenschaften zur Erweiterbarkeit

Gibt zurück

response
object

Erstellen eines Umschlags

Vorgangs-ID:
CreateEnvelope

Erstellt einen neuen Umschlag, dem Sie Empfänger und Dokumente hinzufügen können. Wenn Sie bereit sind, verwenden Sie die Aktion "Umschlag starten", um den Signiervorgang zu initiieren. https://signatureapi.com/docs/integrations/power-automate/actions/create-envelope

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Umschlagtitel
 title True string

Der Titel dieses Umschlags. Dies kann Empfängern angezeigt werden.
Briefumschlagetikett
 label string

Benutzerdefiniertes Etikett, das dem Umschlag zur einfacheren Identifizierung zugewiesen wird. Bezeichnungen dienen zur internen Verwendung und werden empfängern nicht angezeigt.
Briefumschlagnachricht
 message string

Eine Nachricht, die an die Empfänger gesendet wird.
Umschlagmodus
 mode string

Testmodusumschläge sind nicht verbindlich und nicht in Rechnung gestellt.
Umschlagweiterleitung
 routing string

Die Reihenfolge, in der empfänger den Umschlag signieren. Es kann parallel sein, wobei alle Empfänger gleichzeitig oder sequenziell signieren können, wobei sich die Empfänger hintereinander signieren.
Language
 language string

Die Standardsprache, die bei der Signierungszeremonie und zu Lieferumfangn verwendet werden soll. Wenn nicht angegeben, wird die Standardsprache des Kontos verwendet. https://signatureapi.com/docs/localization/language
Zeitzone
 timezone string

Die Zeitzone, die für Zeitstempel in Lieferumfangen verwendet werden soll. Wenn nicht angegeben, wird der Standard-Zeitzonenoffset des Kontos verwendet. https://signatureapi.com/docs/localization/timezone
Zeitstempelformat
 timestamp_format string

Das Datums- und Uhrzeitformat, das in Zeitstempeln für Lieferumfang verwendet werden soll. Wenn nicht angegeben, wird das Standardzeitstempelformat des Kontos verwendet. https://signatureapi.com/docs/localization/timestamp_format
Briefumschlagnachweis
 attestation string

Nachweis gesetzlicher Vorschriften oder Compliance
Name
 name string

Der Name des Absenders.
Email
 email string

Die E-Mail-Adresse des Absenders.
Briefumschlagthemen
 topics array of string

Dient zum Klassifizieren von Umschlägen und Filtern von Webhook-Benachrichtigungen.
Zusätzliche Eigenschaften
 extra string

Zusätzliche Eigenschaften zur Erweiterbarkeit

Gibt zurück

Body
CreateEnvelopeOutput

Hinzufügen einer Stelle – Text

Vorgangs-ID:
AddPlaceText

Fügt einem Dokument eine Textstelle hinzu. https://signatureapi.com/docs/integrations/power-automate/actions/add-text-place

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Dokument-ID
 documentId True string

Die ID des Dokuments.
Ortungsschlüssel
 key True string

Ein Schlüssel, der diese Stelle im Dokument identifiziert.
Wert
 value True string

Der Wert für diesen Textplatz.
Schriftgrad
 font_size number

Der Schriftgrad in Punkt.
Schriftfarbe
 font_color string

Die Schriftfarbe in hexadezimaler Schreibweise.
Seitennummer
 page number

Die Seitenzahl, die an dieser Stelle positioniert werden soll.
Abstand von oben
 top number

Der Abstand (in Punkt) vom oberen Rand der Seite zum unteren Rand der Stelle.
Abstand von links
 left number

Der Abstand (in Punkt) von der linken Seite zur Stelle.
Zusätzliche Eigenschaften
 extra string

Zusätzliche Eigenschaften zur Erweiterbarkeit

Hinzufügen einer Stelle – Texteingabe

Vorgangs-ID:
AddPlaceTextInput

Fügt einem Dokument eine Texteingabestelle hinzu. https://signatureapi.com/docs/integrations/power-automate/actions/add-text-input-place

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Dokument-ID
 documentId True string

Die ID des Dokuments.
Ortungsschlüssel
 key True string

Ein Schlüssel, der diese Stelle im Dokument identifiziert.
Empfängerschlüssel
 recipient_key True string

Der Schlüssel des Empfängers, auf den sich dieser Ort bezieht.
Erfassen als
 capture_as string

Ein Schlüssel, der die Eingabe des Empfängers speichert und in den Umschlagerfassungen enthalten ist.
Hint
 hint string

Eine QuickInfo-Nachricht, die über dem Eingabefeld für den Empfänger angezeigt wird.
Prompt
 prompt string

Eine Platzhaltermeldung, die während der Signierzeremonie im Eingabetextfeld angezeigt wird.
Anforderung
 requirement string

Gibt an, ob der Empfänger dieses Feld ausfüllen muss, um die Signaturzeremonie abzuschließen.
Format
 format string

Gibt das gültige Format für die Benutzereingabe an. Weitere Informationen finden Sie in der Dokumentation zu zulässigen Werten.
Nachricht formatieren
 format_message string

Die Meldung, die angezeigt wird, wenn die Eingabe des Benutzers nicht mit dem erforderlichen Format übereinstimmt.
Seitennummer
 page number

Die Seitenzahl, die an dieser Stelle positioniert werden soll.
Abstand von oben
 top number

Der Abstand (in Punkt) vom oberen Rand der Seite zum unteren Rand der Stelle.
Abstand von links
 left number

Der Abstand (in Punkt) von der linken Seite zur Stelle.
Zusätzliche Eigenschaften
 extra string

Zusätzliche Eigenschaften zur Erweiterbarkeit

Hinzufügen einer Vorlage – DOCX

Vorgangs-ID:
AddTemplate

Fügt einem Umschlag eine DOCX-Vorlage hinzu. https://signatureapi.com/docs/integrations/power-automate/actions/add-template

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Umschlag-ID
 envelopeId True string

Die ID des Umschlags.
Dokumenttitel
 title string

Der Titel dieses Dokuments. Dies kann Empfängern angezeigt werden.
Inhalt der Datei
 file_content True byte

Der Inhalt der Dokumentdatei.
Vorlagendaten
 data array of string

Field: Value pair containing data to fill into the template.
Zusätzliche Eigenschaften
 extra string

Zusätzliche Eigenschaften zur Erweiterbarkeit

Gibt zurück

Body
AddDocumentOutput

Hinzufügen eines Dokuments – DOCX

Vorgangs-ID:
AddDocumentDocx

Fügt einem Umschlag ein DOCX-Dokument hinzu. https://signatureapi.com/docs/integrations/power-automate/actions/add-document-docx

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Umschlag-ID
 envelopeId True string

Die ID des Umschlags.
Dokumenttitel
 title string

Der Titel dieses Dokuments. Dies kann Empfängern angezeigt werden.
Inhalt der Datei
 file_content True byte

Der Inhalt der Dokumentdatei.
Zusätzliche Eigenschaften
 extra string

Zusätzliche Eigenschaften zur Erweiterbarkeit

Gibt zurück

Body
AddDocumentOutput

Hinzufügen eines Dokuments – PDF

Vorgangs-ID:
AddDocument

Fügt einem Umschlag ein PDF-Dokument hinzu. https://signatureapi.com/docs/integrations/power-automate/actions/add-document

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Umschlag-ID
 envelopeId True string

Die ID des Umschlags.
Dokumenttitel
 title string

Der Titel dieses Dokuments. Dies kann Empfängern angezeigt werden.
Inhalt der Datei
 file_content True byte

Der Inhalt der Dokumentdatei.
Zusätzliche Eigenschaften
 extra string

Zusätzliche Eigenschaften zur Erweiterbarkeit

Gibt zurück

Body
AddDocumentOutput

Hinzufügen eines Empfängers – Signierer

Vorgangs-ID:
AddRecipient

Fügt einen Empfänger zu einem Umschlag hinzu. https://signatureapi.com/docs/integrations/power-automate/actions/add-recipient

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Umschlag-ID
 envelopeId True string

Die ID des Umschlags.
Empfängername
 name True string

Der Name des Empfängers.
Empfänger-E-Mail
 email True string

Die E-Mail-Adresse des Empfängers.
Empfängerschlüssel
 key True string

Ein Schlüssel, der einen Empfänger innerhalb eines Umschlags identifiziert.
Empfängerzeremonienerstellung
 ceremony_creation string

Wie die Zeremonien für einen Empfänger erstellt werden.
Empfängerübermittlungstyp
 delivery_type string

Wie der Lieferumfang an den Empfänger gesendet wird.
Zusätzliche Eigenschaften
 extra string

Zusätzliche Eigenschaften zur Erweiterbarkeit

Gibt zurück

Body
AddRecipientSignerOutput

Hinzufügen von Daten zur Vorlage

Vorgangs-ID:
AddTemplateData

Fügt einer Vorlage Daten hinzu. https://signatureapi.com/docs/integrations/power-automate/actions/add-template-data

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Dokument-ID
 documentId True string

Die ID des Dokuments.
Feldname
 field_name True string

Der Name des Felds in der Vorlage.
Wert
 value True string

Der Wert für das Feld in der Vorlage.

Löschen eines Umschlags

Vorgangs-ID:
DeleteEnvelope

Löscht einen Umschlag und alle zugehörigen Informationen. https://signatureapi.com/docs/integrations/power-automate/actions/delete-envelope

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Umschlag-ID
 envelopeId True string

Die ID des Umschlags.

Ort hinzufügen – Datum der Fertigstellung des Empfängers

Vorgangs-ID:
AddPlaceRecipientCompletedDate

Fügt einem Dokument einen Abgeschlossenen Datumsplatz eines Empfängers hinzu. https://signatureapi.com/docs/integrations/power-automate/actions/add-recipient-completed-date-place

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Dokument-ID
 documentId True string

Die ID des Dokuments.
Ortungsschlüssel
 key True string

Ein Schlüssel, der diese Stelle im Dokument identifiziert.
Empfängerschlüssel
 recipient_key True string

Der Schlüssel des Empfängers, auf den sich dieser Ort bezieht.
Datumsformat
 date_format string

Definiert das Format des Datums und der Uhrzeit. Weitere Informationen finden Sie in der Dokumentation zu zulässigen Werten.
Seitennummer
 page number

Die Seitenzahl, die an dieser Stelle positioniert werden soll.
Abstand von oben
 top number

Der Abstand (in Punkt) vom oberen Rand der Seite zum unteren Rand der Stelle.
Abstand von links
 left number

Der Abstand (in Punkt) von der linken Seite zur Stelle.
Zusätzliche Eigenschaften
 extra string

Zusätzliche Eigenschaften zur Erweiterbarkeit

Ort hinzufügen – Datum der Fertigstellung des Umschlags

Vorgangs-ID:
AddPlaceEnvelopeCompletedDate

Fügt einem Dokument einen umschlag abgeschlossenen Termin hinzu. https://signatureapi.com/docs/integrations/power-automate/actions/add-envelope-completed-date-place

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Dokument-ID
 documentId True string

Die ID des Dokuments.
Ortungsschlüssel
 key True string

Ein Schlüssel, der diese Stelle im Dokument identifiziert.
Datumsformat
 date_format string

Definiert das Format des Datums und der Uhrzeit. Weitere Informationen finden Sie in der Dokumentation zu zulässigen Werten.
Seitennummer
 page number

Die Seitenzahl, die an dieser Stelle positioniert werden soll.
Abstand von oben
 top number

Der Abstand (in Punkt) vom oberen Rand der Seite zum unteren Rand der Stelle.
Abstand von links
 left number

Der Abstand (in Punkt) von der linken Seite zur Stelle.
Zusätzliche Eigenschaften
 extra string

Zusätzliche Eigenschaften zur Erweiterbarkeit

Ort hinzufügen – Initialen

Vorgangs-ID:
AddPlaceInitials

Fügt einem Dokument eine Initiale hinzu. https://signatureapi.com/docs/integrations/power-automate/actions/add-initials-place

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Dokument-ID
 documentId True string

Die ID des Dokuments.
Ortungsschlüssel
 key True string

Ein Schlüssel, der diese Stelle im Dokument identifiziert.
Empfängerschlüssel
 recipient_key True string

Der Schlüssel des Empfängers, auf den sich dieser Ort bezieht.
Höhe platzieren
 height number

Legen Sie eine benutzerdefinierte Höhe fest, wird die Breite proportional angepasst.
Seitennummer
 page number

Die Seitenzahl, die an dieser Stelle positioniert werden soll.
Abstand von oben
 top number

Der Abstand (in Punkt) vom oberen Rand der Seite zum unteren Rand der Stelle.
Abstand von links
 left number

Der Abstand (in Punkt) von der linken Seite zur Stelle.
Zusätzliche Eigenschaften
 extra string

Zusätzliche Eigenschaften zur Erweiterbarkeit

Ort hinzufügen – Signatur

Vorgangs-ID:
AddPlaceSignature

Fügt einem Dokument eine Signaturstelle hinzu. https://signatureapi.com/docs/integrations/power-automate/actions/add-signature-place

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Dokument-ID
 documentId True string

Die ID des Dokuments.
Ortungsschlüssel
 key True string

Ein Schlüssel, der diese Stelle im Dokument identifiziert.
Empfängerschlüssel
 recipient_key True string

Der Schlüssel des Empfängers, auf den sich dieser Ort bezieht.
Höhe platzieren
 height number

Legen Sie eine benutzerdefinierte Höhe fest, wird die Breite proportional angepasst.
Seitennummer
 page number

Die Seitenzahl, die an dieser Stelle positioniert werden soll.
Abstand von oben
 top number

Der Abstand (in Punkt) vom oberen Rand der Seite zum unteren Rand der Stelle.
Abstand von links
 left number

Der Abstand (in Punkt) von der linken Seite zur Stelle.
Zusätzliche Eigenschaften
 extra string

Zusätzliche Eigenschaften zur Erweiterbarkeit

Starten eines Umschlags

Vorgangs-ID:
StartEnvelope

Initiiert den Signierungsprozess für einen Umschlag. https://signatureapi.com/docs/integrations/power-automate/actions/start-envelope

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Umschlag-ID
 envelopeId True string

Die ID des Umschlags.

Gibt zurück

Body
StartEnvelopeOutput

Auslöser

Beim Erstellen eines Umschlags

Dieses Ereignis tritt auf, wenn ein Umschlag erstellt wird.
Nach Abschluss eines Empfängers

Dieses Ereignis tritt auf, wenn ein Empfänger seinen Teil des Signierungsprozesses abgeschlossen hat.
Nach Abschluss eines Umschlags

Dieses Ereignis tritt auf, wenn ein Umschlagstatus von in_progress zu abgeschlossen wechselt und angibt, dass es von allen Empfängern abgeschlossen wurde.
Wenn ein Empfänger abgelehnt wird

Dieses Ereignis tritt auf, wenn ein Empfänger den Umschlag ablehnt.
Wenn ein Empfänger abspringt

Dieses Ereignis tritt auf, wenn eine E-Mail nicht zustellbar ist, entweder vorübergehend (soft-bounce) oder dauerhaft (hard-bounce).
Wenn ein Empfänger erneut gesendet wird

Dieses Ereignis tritt auf, wenn eine Anforderung an einen Empfänger erneut gesendet wird.
Wenn ein Empfänger ersetzt wird

Dieses Ereignis tritt auf, wenn ein Empfänger durch einen neuen ersetzt wird.
Wenn ein Empfänger fehlschlägt

Dieses Ereignis tritt auf, wenn ein Fehler im Zusammenhang mit einem Empfänger auftritt, was zu einem Fehler des Empfängerstatus führt.
Wenn ein Empfänger gesendet wird

Dieses Ereignis tritt auf, wenn eine Anforderung an einen Empfänger gesendet wird.
Wenn ein Empfänger losgelassen wird

Dieses Ereignis tritt auf, wenn ein Empfänger bereit ist, eine Anforderung zum Abschließen eines Umschlags zu senden.
Wenn ein Lieferumfang fehlschlägt

Dieses Ereignis tritt auf, wenn die Generierung eines Lieferumfangs fehlschlägt, was zu einem Fehler des Lieferumfangs führt.
Wenn ein Lieferumfang generiert wird

Dieses Ereignis tritt auf, wenn ein Lieferumfang, z. B. ein Überwachungsprotokoll, erfolgreich generiert wird.
Wenn ein Umschlag abgebrochen wird

Dieses Ereignis tritt auf, wenn der Signiervorgang vor Abschluss absichtlich beendet wurde, was zu einem Umschlagstatus des Abgebrochenen führt.
Wenn ein Umschlag fehlschlägt

Dieses Ereignis tritt auf, wenn ein Umschlag fehlschlägt, was zu einem Fehler des Umschlagstatus führt.
Wenn ein Umschlag gestartet wurde

Dieses Ereignis tritt auf, wenn ein Umschlagstatus von der Verarbeitung zu in_progress wechselt und an die Empfänger gesendet werden kann.

Beim Erstellen eines Umschlags

Vorgangs-ID:
CreateEndpointForEnvelopeCreated

Dieses Ereignis tritt auf, wenn ein Umschlag erstellt wird.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Themen
 topics array of string

Dient zum Klassifizieren von Umschlägen und Filtern von Webhook-Benachrichtigungen.

Gibt zurück

Body
NotificationForEnvelopeCreated

Nach Abschluss eines Empfängers

Vorgangs-ID:
CreateEndpointForRecipientCompleted

Dieses Ereignis tritt auf, wenn ein Empfänger seinen Teil des Signierungsprozesses abgeschlossen hat.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Themen
 topics array of string

Dient zum Klassifizieren von Umschlägen und Filtern von Webhook-Benachrichtigungen.

Gibt zurück

Body
NotificationForRecipientCompleted

Nach Abschluss eines Umschlags

Vorgangs-ID:
CreateEndpointForEnvelopeCompleted

Dieses Ereignis tritt auf, wenn ein Umschlagstatus von in_progress zu abgeschlossen wechselt und angibt, dass es von allen Empfängern abgeschlossen wurde.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Themen
 topics array of string

Dient zum Klassifizieren von Umschlägen und Filtern von Webhook-Benachrichtigungen.

Gibt zurück

Body
NotificationForEnvelopeCompleted

Wenn ein Empfänger abgelehnt wird

Vorgangs-ID:
CreateEndpointForRecipientRejected

Dieses Ereignis tritt auf, wenn ein Empfänger den Umschlag ablehnt.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Themen
 topics array of string

Dient zum Klassifizieren von Umschlägen und Filtern von Webhook-Benachrichtigungen.

Gibt zurück

Body
NotificationForRecipientRejected

Wenn ein Empfänger abspringt

Vorgangs-ID:
CreateEndpointForRecipientBounced

Dieses Ereignis tritt auf, wenn eine E-Mail nicht zustellbar ist, entweder vorübergehend (soft-bounce) oder dauerhaft (hard-bounce).

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Themen
 topics array of string

Dient zum Klassifizieren von Umschlägen und Filtern von Webhook-Benachrichtigungen.

Gibt zurück

Body
NotificationForRecipientBounced

Wenn ein Empfänger erneut gesendet wird

Vorgangs-ID:
CreateEndpointForRecipientResent

Dieses Ereignis tritt auf, wenn eine Anforderung an einen Empfänger erneut gesendet wird.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Themen
 topics array of string

Dient zum Klassifizieren von Umschlägen und Filtern von Webhook-Benachrichtigungen.

Gibt zurück

Body
NotificationForRecipientResent

Wenn ein Empfänger ersetzt wird

Vorgangs-ID:
CreateEndpointForRecipientReplaced

Dieses Ereignis tritt auf, wenn ein Empfänger durch einen neuen ersetzt wird.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Themen
 topics array of string

Dient zum Klassifizieren von Umschlägen und Filtern von Webhook-Benachrichtigungen.

Gibt zurück

Body
NotificationForRecipientReplaced

Wenn ein Empfänger fehlschlägt

Vorgangs-ID:
CreateEndpointForRecipientFailed

Dieses Ereignis tritt auf, wenn ein Fehler im Zusammenhang mit einem Empfänger auftritt, was zu einem Fehler des Empfängerstatus führt.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Themen
 topics array of string

Dient zum Klassifizieren von Umschlägen und Filtern von Webhook-Benachrichtigungen.

Gibt zurück

Body
NotificationForRecipientFailed

Wenn ein Empfänger gesendet wird

Vorgangs-ID:
CreateEndpointForRecipientSent

Dieses Ereignis tritt auf, wenn eine Anforderung an einen Empfänger gesendet wird.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Themen
 topics array of string

Dient zum Klassifizieren von Umschlägen und Filtern von Webhook-Benachrichtigungen.

Gibt zurück

Body
NotificationForRecipientSent

Wenn ein Empfänger losgelassen wird

Vorgangs-ID:
CreateEndpointForRecipientReleased

Dieses Ereignis tritt auf, wenn ein Empfänger bereit ist, eine Anforderung zum Abschließen eines Umschlags zu senden.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Themen
 topics array of string

Dient zum Klassifizieren von Umschlägen und Filtern von Webhook-Benachrichtigungen.

Gibt zurück

Body
NotificationForRecipientReleased

Wenn ein Lieferumfang fehlschlägt

Vorgangs-ID:
CreateEndpointForDeliverableFailed

Dieses Ereignis tritt auf, wenn die Generierung eines Lieferumfangs fehlschlägt, was zu einem Fehler des Lieferumfangs führt.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Themen
 topics array of string

Dient zum Klassifizieren von Umschlägen und Filtern von Webhook-Benachrichtigungen.

Gibt zurück

Body
NotificationForDeliverableFailed

Wenn ein Lieferumfang generiert wird

Vorgangs-ID:
CreateEndpointForDeliverableGenerated

Dieses Ereignis tritt auf, wenn ein Lieferumfang, z. B. ein Überwachungsprotokoll, erfolgreich generiert wird.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Themen
 topics array of string

Dient zum Klassifizieren von Umschlägen und Filtern von Webhook-Benachrichtigungen.

Gibt zurück

Body
NotificationForDeliverableGenerated

Wenn ein Umschlag abgebrochen wird

Vorgangs-ID:
CreateEndpointForEnvelopeCanceled

Dieses Ereignis tritt auf, wenn der Signiervorgang vor Abschluss absichtlich beendet wurde, was zu einem Umschlagstatus des Abgebrochenen führt.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Themen
 topics array of string

Dient zum Klassifizieren von Umschlägen und Filtern von Webhook-Benachrichtigungen.

Gibt zurück

Body
NotificationForEnvelopeCanceled

Wenn ein Umschlag fehlschlägt

Vorgangs-ID:
CreateEndpointForEnvelopeFailed

Dieses Ereignis tritt auf, wenn ein Umschlag fehlschlägt, was zu einem Fehler des Umschlagstatus führt.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Themen
 topics array of string

Dient zum Klassifizieren von Umschlägen und Filtern von Webhook-Benachrichtigungen.

Gibt zurück

Body
NotificationForEnvelopeFailed

Wenn ein Umschlag gestartet wurde

Vorgangs-ID:
CreateEndpointForEnvelopeStarted

Dieses Ereignis tritt auf, wenn ein Umschlagstatus von der Verarbeitung zu in_progress wechselt und an die Empfänger gesendet werden kann.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Themen
 topics array of string

Dient zum Klassifizieren von Umschlägen und Filtern von Webhook-Benachrichtigungen.

Gibt zurück

Body
NotificationForEnvelopeStarted

Definitionen

Briefumschlag

Name Pfad Typ Beschreibung
Umschlag-ID
 id EnvelopeId

Die ID des Umschlags.
Umschlagtitel
 title EnvelopeTitle

Der Titel dieses Umschlags. Dies kann Empfängern angezeigt werden.
Briefumschlagetikett
 label EnvelopeLabel

Benutzerdefiniertes Etikett, das dem Umschlag zur einfacheren Identifizierung zugewiesen wird. Bezeichnungen dienen zur internen Verwendung und werden empfängern nicht angezeigt.
Briefumschlagnachricht
 message EnvelopeMessage

Eine Nachricht, die an die Empfänger gesendet wird.
sender
 sender EnvelopeSender
Umschlagstatus
 status EnvelopeStatus

Der Status des Umschlags.
lieferbar
 deliverable EnvelopeDeliverable
Umschlag abgeschlossen am
 completed_at EnvelopeCompletedAt

Zeitpunkt, zu dem alle Empfänger den Umschlag abgeschlossen haben.
Umschlagmodus
 mode EnvelopeMode

Testmodusumschläge sind nicht verbindlich und nicht in Rechnung gestellt.
Umschlagweiterleitung
 routing EnvelopeRouting

Die Reihenfolge, in der empfänger den Umschlag signieren. Es kann parallel sein, wobei alle Empfänger gleichzeitig oder sequenziell signieren können, wobei sich die Empfänger hintereinander signieren.
Zeitzone
 timezone EnvelopeTimezone

Die Zeitzone, die für Zeitstempel in Lieferumfangen verwendet werden soll. Wenn nicht angegeben, wird der Standard-Zeitzonenoffset des Kontos verwendet. https://signatureapi.com/docs/localization/timezone
Zeitstempelformat
 timestamp_format EnvelopeTimestampFormat

Das Datums- und Uhrzeitformat, das in Zeitstempeln für Lieferumfang verwendet werden soll. Wenn nicht angegeben, wird das Standardzeitstempelformat des Kontos verwendet. https://signatureapi.com/docs/localization/timestamp_format
Briefumschlagnachweis
 attestation EnvelopeAttestation

Nachweis gesetzlicher Vorschriften oder Compliance
Briefumschlagthemen
 topics EnvelopeTopics

Dient zum Klassifizieren von Umschlägen und Filtern von Webhook-Benachrichtigungen.

Recipient

Name Pfad Typ Beschreibung
Empfänger-ID
 id RecipientId

Die ID des Empfängers.
Umschlag-ID
 envelope_id EnvelopeId

Die ID des Umschlags.
Empfängertyp
 type RecipientType

Der Typ des Empfängers.
Empfängerschlüssel
 key RecipientKey

Ein Schlüssel, der einen Empfänger innerhalb eines Umschlags identifiziert.
Empfängername
 name RecipientName

Der Name des Empfängers.
Empfänger-E-Mail
 email RecipientEmail

Die E-Mail-Adresse des Empfängers.
Empfängerstatus
 status RecipientStatus

Der Status des Empfängers.
Empfängerzeremonienerstellung
 ceremony_creation RecipientCeremonyCreation

Wie die Zeremonien für einen Empfänger erstellt werden.
Empfängerübermittlungstyp
 delivery_type RecipientDeliveryType

Wie der Lieferumfang an den Empfänger gesendet wird.
Empfänger abgeschlossen am
 completed_at RecipientCompletedAt

Zeitpunkt, zu dem der Empfänger den Umschlag abgeschlossen hat.

Lieferbar

Name Pfad Typ Beschreibung
Lieferumfangs-ID
 id DeliverableId

Die ID des Lieferumfangs.
Lieferumfangstyp
 type DeliverableType

Der Typ des Lieferumfangs.
Lieferumfangsstatus
 status DeliverableStatus

Der Status des Lieferumfangs.
Inhalt der Datei
 file_content DeliverableFileContent

Der Dateiinhalt des Lieferumfangs. Verwenden Sie sie, um eine signierte Kopie des Umschlags zu speichern.

Capture

Name Pfad Typ Beschreibung
Aufnahmewert
 value CaptureValue

Der Wert der Empfängereingabeerfassung

CreateEnvelopeOutput

Name Pfad Typ Beschreibung
Umschlag-ID
 id EnvelopeId

Die ID des Umschlags.
Umschlagtitel
 title EnvelopeTitle

Der Titel dieses Umschlags. Dies kann Empfängern angezeigt werden.
Briefumschlagetikett
 label EnvelopeLabel

Benutzerdefiniertes Etikett, das dem Umschlag zur einfacheren Identifizierung zugewiesen wird. Bezeichnungen dienen zur internen Verwendung und werden empfängern nicht angezeigt.
Briefumschlagnachricht
 message EnvelopeMessage

Eine Nachricht, die an die Empfänger gesendet wird.
sender
 sender EnvelopeSender
Umschlagmodus
 mode EnvelopeMode

Testmodusumschläge sind nicht verbindlich und nicht in Rechnung gestellt.
Umschlagweiterleitung
 routing EnvelopeRouting

Die Reihenfolge, in der empfänger den Umschlag signieren. Es kann parallel sein, wobei alle Empfänger gleichzeitig oder sequenziell signieren können, wobei sich die Empfänger hintereinander signieren.
Zeitzone
 timezone EnvelopeTimezone

Die Zeitzone, die für Zeitstempel in Lieferumfangen verwendet werden soll. Wenn nicht angegeben, wird der Standard-Zeitzonenoffset des Kontos verwendet. https://signatureapi.com/docs/localization/timezone
Zeitstempelformat
 timestamp_format EnvelopeTimestampFormat

Das Datums- und Uhrzeitformat, das in Zeitstempeln für Lieferumfang verwendet werden soll. Wenn nicht angegeben, wird das Standardzeitstempelformat des Kontos verwendet. https://signatureapi.com/docs/localization/timestamp_format
Briefumschlagnachweis
 attestation EnvelopeAttestation

Nachweis gesetzlicher Vorschriften oder Compliance
Briefumschlagthemen
 topics EnvelopeTopics

Dient zum Klassifizieren von Umschlägen und Filtern von Webhook-Benachrichtigungen.

StartEnvelopeOutput

Name Pfad Typ Beschreibung
Umschlagstatus
 status EnvelopeStatus

Der Status des Umschlags.

AddDocumentOutput

Name Pfad Typ Beschreibung
Dokument-ID
 id DocumentId

Die ID des Dokuments

AddRecipientSignerOutput

Name Pfad Typ Beschreibung
Empfänger-ID
 id RecipientId

Die ID des Empfängers.
Empfängername
 name RecipientName

Der Name des Empfängers.
Empfänger-E-Mail
 email RecipientEmail

Die E-Mail-Adresse des Empfängers.
Empfängerschlüssel
 key RecipientKey

Ein Schlüssel, der einen Empfänger innerhalb eines Umschlags identifiziert.
Empfängerzeremonienerstellung
 ceremony_creation RecipientCeremonyCreation

Wie die Zeremonien für einen Empfänger erstellt werden.
Empfängerübermittlungstyp
 delivery_type RecipientDeliveryType

Wie der Lieferumfang an den Empfänger gesendet wird.

CreateCeremonyCustomOutput

Name Pfad Typ Beschreibung
Url der Zeremonie
 url CeremonyUrl

Die URL, die der Empfänger besuchen muss, um die Zeremonie zu initiieren

EnvelopeId

Die ID des Umschlags.

Die ID des Umschlags.

Umschlag-ID
string

EnvelopeTitle

Der Titel dieses Umschlags. Dies kann Empfängern angezeigt werden.

Der Titel dieses Umschlags. Dies kann Empfängern angezeigt werden.

Umschlagtitel
string

EnvelopeLabel

Benutzerdefiniertes Etikett, das dem Umschlag zur einfacheren Identifizierung zugewiesen wird. Bezeichnungen dienen zur internen Verwendung und werden empfängern nicht angezeigt.

Benutzerdefiniertes Etikett, das dem Umschlag zur einfacheren Identifizierung zugewiesen wird. Bezeichnungen dienen zur internen Verwendung und werden empfängern nicht angezeigt.

Briefumschlagetikett
string

EnvelopeMessage

Eine Nachricht, die an die Empfänger gesendet wird.

Eine Nachricht, die an die Empfänger gesendet wird.

Briefumschlagnachricht
string

EnvelopeRouting

Die Reihenfolge, in der empfänger den Umschlag signieren. Es kann parallel sein, wobei alle Empfänger gleichzeitig oder sequenziell signieren können, wobei sich die Empfänger hintereinander signieren.

Die Reihenfolge, in der empfänger den Umschlag signieren. Es kann parallel sein, wobei alle Empfänger gleichzeitig oder sequenziell signieren können, wobei sich die Empfänger hintereinander signieren.

Umschlagweiterleitung
string

EnvelopeTimezone

Die Zeitzone, die für Zeitstempel in Lieferumfangen verwendet werden soll. Wenn nicht angegeben, wird der Standard-Zeitzonenoffset des Kontos verwendet. https://signatureapi.com/docs/localization/timezone

Die Zeitzone, die für Zeitstempel in Lieferumfangen verwendet werden soll. Wenn nicht angegeben, wird der Standard-Zeitzonenoffset des Kontos verwendet. https://signatureapi.com/docs/localization/timezone

Zeitzone
string

EnvelopeTimestampFormat

Das Datums- und Uhrzeitformat, das in Zeitstempeln für Lieferumfang verwendet werden soll. Wenn nicht angegeben, wird das Standardzeitstempelformat des Kontos verwendet. https://signatureapi.com/docs/localization/timestamp_format

Das Datums- und Uhrzeitformat, das in Zeitstempeln für Lieferumfang verwendet werden soll. Wenn nicht angegeben, wird das Standardzeitstempelformat des Kontos verwendet. https://signatureapi.com/docs/localization/timestamp_format

Zeitstempelformat
string

EnvelopeSender

Name Pfad Typ Beschreibung
Absendername
 name string

Der Name des Absenders.
Absender-E-Mail
 email string

Die E-Mail-Adresse des Absenders.

EnvelopeStatus

Der Status des Umschlags.

Der Status des Umschlags.

Umschlagstatus
string

EnvelopeMode

Testmodusumschläge sind nicht verbindlich und nicht in Rechnung gestellt.

Testmodusumschläge sind nicht verbindlich und nicht in Rechnung gestellt.

Umschlagmodus
string

EnvelopeTopics

Dient zum Klassifizieren von Umschlägen und Filtern von Webhook-Benachrichtigungen.

Name Pfad Typ Beschreibung
Gegenstände
 string

EnvelopeAttestation

Nachweis gesetzlicher Vorschriften oder Compliance

Nachweis gesetzlicher Vorschriften oder Compliance

Briefumschlagnachweis
string

EnvelopeDeliverable

Name Pfad Typ Beschreibung
Lieferumfangs-ID
 id string

Die ID des Lieferumfangs. Verwenden Sie diese, um eine signierte Kopie des Umschlags herunterzuladen.

EnvelopeCompletedAt

Zeitpunkt, zu dem alle Empfänger den Umschlag abgeschlossen haben.

Zeitpunkt, zu dem alle Empfänger den Umschlag abgeschlossen haben.

Umschlag abgeschlossen am
date-time

DokumentID

Die ID des Dokuments

Die ID des Dokuments

Dokument-ID
string

RecipientId

Die ID des Empfängers.

Die ID des Empfängers.

Empfänger-ID
string

RecipientType

Der Typ des Empfängers.

Der Typ des Empfängers.

Empfängertyp
string

RecipientName

Der Name des Empfängers.

Der Name des Empfängers.

Empfängername
string

RecipientEmail

Die E-Mail-Adresse des Empfängers.

Die E-Mail-Adresse des Empfängers.

Empfänger-E-Mail
string

RecipientKey

Ein Schlüssel, der einen Empfänger innerhalb eines Umschlags identifiziert.

Ein Schlüssel, der einen Empfänger innerhalb eines Umschlags identifiziert.

Empfängerschlüssel
string

RecipientStatus

Der Status des Empfängers.

Der Status des Empfängers.

Empfängerstatus
string

RecipientCeremonyCreation

Wie die Zeremonien für einen Empfänger erstellt werden.

Wie die Zeremonien für einen Empfänger erstellt werden.

Empfängerzeremonienerstellung
string

RecipientDeliveryType

Wie der Lieferumfang an den Empfänger gesendet wird.

Wie der Lieferumfang an den Empfänger gesendet wird.

Empfängerübermittlungstyp
string

RecipientCompletedAt

Zeitpunkt, zu dem der Empfänger den Umschlag abgeschlossen hat.

Zeitpunkt, zu dem der Empfänger den Umschlag abgeschlossen hat.

Empfänger abgeschlossen am
date-time

DeliverableId

Die ID des Lieferumfangs.

Die ID des Lieferumfangs.

Lieferumfangs-ID
string

DeliverableType

Der Typ des Lieferumfangs.

Der Typ des Lieferumfangs.

Lieferumfangstyp
string

DeliverableStatus

Der Status des Lieferumfangs.

Der Status des Lieferumfangs.

Lieferumfangsstatus
string

DeliverableFileContent

Der Dateiinhalt des Lieferumfangs. Verwenden Sie sie, um eine signierte Kopie des Umschlags zu speichern.

Der Dateiinhalt des Lieferumfangs. Verwenden Sie sie, um eine signierte Kopie des Umschlags zu speichern.

Inhalt der Datei
byte

Zeremonieurl

Die URL, die der Empfänger besuchen muss, um die Zeremonie zu initiieren

Die URL, die der Empfänger besuchen muss, um die Zeremonie zu initiieren

Url der Zeremonie
string

CaptureValue

Der Wert der Empfängereingabeerfassung

Der Wert der Empfängereingabeerfassung

Aufnahmewert
string

NotificationForEnvelopeCreated

Name Pfad Typ Beschreibung
Ereignis-ID
 id EventId

Die ID des Ereignisses.
Ereigniszeitstempel
 timestamp EventTimestamp

Das Datum und die Uhrzeit des Ereignisses im ISO 8601-Format.
Ereignistyp
 type EventType

Typ des Ereignisses
Umschlag-ID
 data.envelope_id EventEnvelopeId

Die ID des Umschlags, auf den dieses Ereignis verweist.

NotificationForEnvelopeStarted

Name Pfad Typ Beschreibung
Ereignis-ID
 id EventId

Die ID des Ereignisses.
Ereigniszeitstempel
 timestamp EventTimestamp

Das Datum und die Uhrzeit des Ereignisses im ISO 8601-Format.
Ereignistyp
 type EventType

Typ des Ereignisses
Umschlag-ID
 data.envelope_id EventEnvelopeId

Die ID des Umschlags, auf den dieses Ereignis verweist.

NotificationForEnvelopeCompleted

Name Pfad Typ Beschreibung
Ereignis-ID
 id EventId

Die ID des Ereignisses.
Ereigniszeitstempel
 timestamp EventTimestamp

Das Datum und die Uhrzeit des Ereignisses im ISO 8601-Format.
Ereignistyp
 type EventType

Typ des Ereignisses
Umschlag-ID
 data.envelope_id EventEnvelopeId

Die ID des Umschlags, auf den dieses Ereignis verweist.

NotificationForEnvelopeFailed

Name Pfad Typ Beschreibung
Ereignis-ID
 id EventId

Die ID des Ereignisses.
Ereigniszeitstempel
 timestamp EventTimestamp

Das Datum und die Uhrzeit des Ereignisses im ISO 8601-Format.
Ereignistyp
 type EventType

Typ des Ereignisses
Umschlag-ID
 data.envelope_id EventEnvelopeId

Die ID des Umschlags, auf den dieses Ereignis verweist.
Einzelheit
 data.detail string

Informationen zum Fehler.

NotificationForEnvelopeCanceled

Name Pfad Typ Beschreibung
Ereignis-ID
 id EventId

Die ID des Ereignisses.
Ereigniszeitstempel
 timestamp EventTimestamp

Das Datum und die Uhrzeit des Ereignisses im ISO 8601-Format.
Ereignistyp
 type EventType

Typ des Ereignisses
Umschlag-ID
 data.envelope_id EventEnvelopeId

Die ID des Umschlags, auf den dieses Ereignis verweist.

NotificationForRecipientReleased

Name Pfad Typ Beschreibung
Ereignis-ID
 id EventId

Die ID des Ereignisses.
Ereigniszeitstempel
 timestamp EventTimestamp

Das Datum und die Uhrzeit des Ereignisses im ISO 8601-Format.
Ereignistyp
 type EventType

Typ des Ereignisses
Umschlag-ID
 data.envelope_id EventEnvelopeId

Die ID des Umschlags, auf den dieses Ereignis verweist.
Empfänger-ID
 data.object_id EventRecipientId

Die ID des Empfängers, auf den dieses Ereignis verweist.
Empfängertyp
 data.recipient_type EventRecipientType

Der Empfängertyp dieses Ereignisses.
Empfängerschlüssel
 data.recipient_key EventRecipientKey

Der Schlüssel des Empfängers, auf den dieses Ereignis verweist.

NotificationForRecipientSent

Name Pfad Typ Beschreibung
Ereignis-ID
 id EventId

Die ID des Ereignisses.
Ereigniszeitstempel
 timestamp EventTimestamp

Das Datum und die Uhrzeit des Ereignisses im ISO 8601-Format.
Ereignistyp
 type EventType

Typ des Ereignisses
Umschlag-ID
 data.envelope_id EventEnvelopeId

Die ID des Umschlags, auf den dieses Ereignis verweist.
Empfänger-ID
 data.object_id EventRecipientId

Die ID des Empfängers, auf den dieses Ereignis verweist.
Empfängertyp
 data.recipient_type EventRecipientType

Der Empfängertyp dieses Ereignisses.
Empfängerschlüssel
 data.recipient_key EventRecipientKey

Der Schlüssel des Empfängers, auf den dieses Ereignis verweist.

NotificationForRecipientCompleted

Name Pfad Typ Beschreibung
Ereignis-ID
 id EventId

Die ID des Ereignisses.
Ereigniszeitstempel
 timestamp EventTimestamp

Das Datum und die Uhrzeit des Ereignisses im ISO 8601-Format.
Ereignistyp
 type EventType

Typ des Ereignisses
Umschlag-ID
 data.envelope_id EventEnvelopeId

Die ID des Umschlags, auf den dieses Ereignis verweist.
Empfänger-ID
 data.object_id EventRecipientId

Die ID des Empfängers, auf den dieses Ereignis verweist.
Empfängertyp
 data.recipient_type EventRecipientType

Der Empfängertyp dieses Ereignisses.
Empfängerschlüssel
 data.recipient_key EventRecipientKey

Der Schlüssel des Empfängers, auf den dieses Ereignis verweist.

NotificationForRecipientRejected

Name Pfad Typ Beschreibung
Ereignis-ID
 id EventId

Die ID des Ereignisses.
Ereigniszeitstempel
 timestamp EventTimestamp

Das Datum und die Uhrzeit des Ereignisses im ISO 8601-Format.
Ereignistyp
 type EventType

Typ des Ereignisses
Umschlag-ID
 data.envelope_id EventEnvelopeId

Die ID des Umschlags, auf den dieses Ereignis verweist.
Empfänger-ID
 data.object_id EventRecipientId

Die ID des Empfängers, auf den dieses Ereignis verweist.
Empfängertyp
 data.recipient_type EventRecipientType

Der Empfängertyp dieses Ereignisses.
Empfängerschlüssel
 data.recipient_key EventRecipientKey

Der Schlüssel des Empfängers, auf den dieses Ereignis verweist.
Ursache
 data.reason string

Die Erklärung des Empfängers für die Ablehnung.

NotificationForRecipientBounced

Name Pfad Typ Beschreibung
Ereignis-ID
 id EventId

Die ID des Ereignisses.
Ereigniszeitstempel
 timestamp EventTimestamp

Das Datum und die Uhrzeit des Ereignisses im ISO 8601-Format.
Ereignistyp
 type EventType

Typ des Ereignisses
Umschlag-ID
 data.envelope_id EventEnvelopeId

Die ID des Umschlags, auf den dieses Ereignis verweist.
Empfänger-ID
 data.object_id EventRecipientId

Die ID des Empfängers, auf den dieses Ereignis verweist.
Empfängertyp
 data.recipient_type EventRecipientType

Der Empfängertyp dieses Ereignisses.
Empfängerschlüssel
 data.recipient_key EventRecipientKey

Der Schlüssel des Empfängers, auf den dieses Ereignis verweist.
Einzelheit
 data.detail string

Informationen über die Unzustellbarkeit.

NotificationForRecipientFailed

Name Pfad Typ Beschreibung
Ereignis-ID
 id EventId

Die ID des Ereignisses.
Ereigniszeitstempel
 timestamp EventTimestamp

Das Datum und die Uhrzeit des Ereignisses im ISO 8601-Format.
Ereignistyp
 type EventType

Typ des Ereignisses
Umschlag-ID
 data.envelope_id EventEnvelopeId

Die ID des Umschlags, auf den dieses Ereignis verweist.
Empfänger-ID
 data.object_id EventRecipientId

Die ID des Empfängers, auf den dieses Ereignis verweist.
Empfängertyp
 data.recipient_type EventRecipientType

Der Empfängertyp dieses Ereignisses.
Empfängerschlüssel
 data.recipient_key EventRecipientKey

Der Schlüssel des Empfängers, auf den dieses Ereignis verweist.
Einzelheit
 data.detail string

Informationen zum Fehler.

NotificationForRecipientReplaced

Name Pfad Typ Beschreibung
Ereignis-ID
 id EventId

Die ID des Ereignisses.
Ereigniszeitstempel
 timestamp EventTimestamp

Das Datum und die Uhrzeit des Ereignisses im ISO 8601-Format.
Ereignistyp
 type EventType

Typ des Ereignisses
Umschlag-ID
 data.envelope_id EventEnvelopeId

Die ID des Umschlags, auf den dieses Ereignis verweist.
Empfänger-ID
 data.object_id EventRecipientId

Die ID des Empfängers, auf den dieses Ereignis verweist.
Empfängertyp
 data.recipient_type EventRecipientType

Der Empfängertyp dieses Ereignisses.
Empfängerschlüssel
 data.recipient_key EventRecipientKey

Der Schlüssel des Empfängers, auf den dieses Ereignis verweist.
Neue Empfänger-ID
 data.new_recipient_id string

Die ID des neuen Empfängers.

NotificationForRecipientResent

Name Pfad Typ Beschreibung
Ereignis-ID
 id EventId

Die ID des Ereignisses.
Ereigniszeitstempel
 timestamp EventTimestamp

Das Datum und die Uhrzeit des Ereignisses im ISO 8601-Format.
Ereignistyp
 type EventType

Typ des Ereignisses
Umschlag-ID
 data.envelope_id EventEnvelopeId

Die ID des Umschlags, auf den dieses Ereignis verweist.
Empfänger-ID
 data.object_id EventRecipientId

Die ID des Empfängers, auf den dieses Ereignis verweist.
Empfängertyp
 data.recipient_type EventRecipientType

Der Empfängertyp dieses Ereignisses.
Empfängerschlüssel
 data.recipient_key EventRecipientKey

Der Schlüssel des Empfängers, auf den dieses Ereignis verweist.

NotificationForDeliverableGenerated

Name Pfad Typ Beschreibung
Ereignis-ID
 id EventId

Die ID des Ereignisses.
Ereigniszeitstempel
 timestamp EventTimestamp

Das Datum und die Uhrzeit des Ereignisses im ISO 8601-Format.
Ereignistyp
 type EventType

Typ des Ereignisses
Umschlag-ID
 data.envelope_id EventEnvelopeId

Die ID des Umschlags, auf den dieses Ereignis verweist.
Lieferumfangs-ID
 data.object_id EventDeliverableId

Die ID des Lieferumfangs dieses Ereignisses bezieht sich auf.

NotificationForDeliverableFailed

Name Pfad Typ Beschreibung
Ereignis-ID
 id EventId

Die ID des Ereignisses.
Ereigniszeitstempel
 timestamp EventTimestamp

Das Datum und die Uhrzeit des Ereignisses im ISO 8601-Format.
Ereignistyp
 type EventType

Typ des Ereignisses
Umschlag-ID
 data.envelope_id EventEnvelopeId

Die ID des Umschlags, auf den dieses Ereignis verweist.
Lieferumfangs-ID
 data.object_id EventDeliverableId

Die ID des Lieferumfangs dieses Ereignisses bezieht sich auf.
Einzelheit
 data.detail string

Informationen zum Fehler.

EventId

Die ID des Ereignisses.

Die ID des Ereignisses.

Ereignis-ID
string

Ereigniszeitstempel

Das Datum und die Uhrzeit des Ereignisses im ISO 8601-Format.

Das Datum und die Uhrzeit des Ereignisses im ISO 8601-Format.

Ereigniszeitstempel
date-time

Eventtyp

Typ des Ereignisses

Typ des Ereignisses

Ereignistyp
string

EventEnvelopeId

Die ID des Umschlags, auf den dieses Ereignis verweist.

Die ID des Umschlags, auf den dieses Ereignis verweist.

Umschlag-ID
string

EventRecipientId

Die ID des Empfängers, auf den dieses Ereignis verweist.

Die ID des Empfängers, auf den dieses Ereignis verweist.

Empfänger-ID
string

EventRecipientType

Der Empfängertyp dieses Ereignisses.

Der Empfängertyp dieses Ereignisses.

Empfängertyp
string

EventRecipientKey

Der Schlüssel des Empfängers, auf den dieses Ereignis verweist.

Der Schlüssel des Empfängers, auf den dieses Ereignis verweist.

Empfängerschlüssel
string

EventDeliverableId

Die ID des Lieferumfangs dieses Ereignisses bezieht sich auf.

Die ID des Lieferumfangs dieses Ereignisses bezieht sich auf.

Lieferumfangs-ID
string

Objekt

Dies ist der Typ 'object'.