Encodian - Signieren

Der Konnektor "Encodian - Sign" bietet eine umfangreiche Sammlung von Aktionen, die die Erstellung und Verwaltung elektronischer Signaturprozesse erleichtern. Mit dem Connector können Organisationen Signaturanforderungen automatisieren, Dokumentsignierungsworkflows optimieren und elektronische Signaturfunktionen in vorhandene Geschäftsprozesse und Anwendungen integrieren.

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

Dienstleistung Class Regions
Copilot Studio Norm Alle Power Automate Regionen mit Ausnahme der folgenden:
     - 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 China-Regionen
     - US Department of Defense (DoD)
Power Apps Norm Alle Power Apps Regionen mit Ausnahme der folgenden:
     - US Government (GCC High)
     - China Cloud betrieben von 21Vianet
     - US Department of Defense (DoD)
Power Automate Norm Alle Power Automate Regionen mit Ausnahme der folgenden:
     - US Government (GCC High)
     - China Cloud betrieben von 21Vianet
     - US Department of Defense (DoD)
Kontakt
Name Encodian Support
URL https://support.encodian.com
Email support@encodian.com
Connectormetadaten
Herausgeber Encodian
Webseite https://www.encodian.com
Datenschutzrichtlinie https://support.encodian.com/hc/en-gb/articles/360010885513-Privacy-Policy
Kategorien Inhalt und Dateien; Zusammenarbeit

Encodian Sign for Power Automate

Der Connector "Encodian Sign" bietet einen umfassenden Satz von Power Automate Aktionen, die die Erstellung elektronischer Signaturlösungen oder die Erweiterung vorhandener Power Platform-Lösungen mit elektronischen Signaturfunktionen ermöglichen.

Der Encodian Sign Connector wird von Power Automate, Azure Logic Apps und Power Apps unterstützt.

Konto registrieren

Für die Verwendung des Encodian Sign-Connectors ist ein Encodian Sign-Abonnement erforderlich.

Füllen Sie das Registrierungsformular aus, um sich für eine 30-tägige Testversion zu registrieren und einen API-Schlüssel zu erhalten.

Support

Wenden Sie sich an den Encodian-Support , um Unterstützung anzufordern.

Encodian Sign-Dokumentation finden Sie hier

Erstellen einer Verbindung

Der Connector unterstützt die folgenden Authentifizierungstypen:
Vorgabe Parameter zum Erstellen einer Verbindung. Alle Regionen Freigabefähig

Vorgabe

Anwendbar: Alle Regionen

Parameter zum Erstellen einer Verbindung.

Dies ist eine freigabefähige Verbindung. Wenn die Power-App für einen anderen Benutzer freigegeben wird, wird auch die Verbindung freigegeben. Weitere Informationen finden Sie in der Übersicht über Connectors für Canvas-Apps – Power Apps | Microsoft-Dokumentation

Name Typ Description Erforderlich
API-Schlüssel securestring Abrufen eines API-Schlüssels – https://www.encodian.com/apikey/ Richtig
Region Schnur Richtig

Drosselungsgrenzwerte

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

Aktionen

Empfänger - Abrufen

Ruft einen einzelnen Empfänger ab – https://support.encodian.com/hc/en-gb/articles/25877649787036
Empfänger - Löschen

Löscht einen vorhandenen Empfänger - https://support.encodian.com/hc/en-gb/articles/25698260987292
Empfänger – Alle auflisten

Listet alle Empfänger aus dem aktuellen Arbeitsbereich auf – https://support.encodian.com/hc/en-gb/articles/26005981080732
Empfänger – Hinzufügen

Fügt einen neuen Empfänger hinzu – https://support.encodian.com/hc/en-gb/articles/25625138389660
Empfänger – Mehrere hinzufügen

Fügt ein Array von Empfängern hinzu – https://support.encodian.com/hc/en-gb/articles/25793665577500
Lieferumfang - Download Audit Trail

Laden Sie das Audit Trail-Dokument und JSON für einen Umschlag herunter – https://support.encodian.com/hc/en-gb/articles/30727796963484
Lieferumfang - Signierte Dokumente herunterladen

Herunterladen der signierten Dokumente für einen Umschlag - https://support.encodian.com/hc/en-gb/articles/30727465578396
Umschlag - Einmalige Datei signieren

Erstellen eines Umschlags für eine einzelne Datei mit einer einzelnen Stufe - https://support.encodian.com/hc/en-gb/articles/26845003436828
Umschlag - Signieren einer einzelnen Datei mit Phasen

Erstellen eines Umschlags für eine einzelne Datei mit einem mehrstufigen Genehmigungs-/Signierungsprozess - https://support.encodian.com/hc/en-gb/articles/27543439385500
Umschlag - Signieren mehrerer Dateien

Erstellen eines Umschlags für eine Sammlung von Dateien mit einer einzelnen Stufe - https://support.encodian.com/hc/en-gb/articles/30727010403868
Umschlag – Signieren mehrerer Dateien mit Phasen

Erstellen eines Umschlags für eine Sammlung von Dateien mit einem mehrstufigen Genehmigungs-/Signierungsprozess - https://support.encodian.com/hc/en-gb/articles/30727071061532
Umschlag – Status abrufen

Abrufen des Status eines Umschlags

Empfänger - Abrufen

Vorgangs-ID:
Sign_RecipientGetSingle

Ruft einen einzelnen Empfänger ab – https://support.encodian.com/hc/en-gb/articles/25877649787036

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
E‑Mail-Adresse
 emailAddress string

Geben Sie die E-Mail-Adresse des Empfängers an.
Empfänger-ID
 recipientId string

Geben Sie den eindeutigen Bezeichner des Empfängers an.

Gibt zurück

Körper
DtoResponseRecipientGetSingle

Empfänger - Löschen

Vorgangs-ID:
Sign_RecipientDeleteSingle

Löscht einen vorhandenen Empfänger - https://support.encodian.com/hc/en-gb/articles/25698260987292

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
E‑Mail-Adresse
 emailAddress string

Geben Sie die E-Mail-Adresse des Empfängers an.
Empfänger-ID
 recipientId string

Geben Sie den eindeutigen Bezeichner des Empfängers an.

Gibt zurück

Körper
DtoResponseRecipientDeleteSingle

Empfänger – Alle auflisten

Vorgangs-ID:
Sign_RecipientListAll

Listet alle Empfänger aus dem aktuellen Arbeitsbereich auf – https://support.encodian.com/hc/en-gb/articles/26005981080732

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Limit
 limit integer

Beschränkt die Anzahl der zurückgegebenen Empfänger auf den angegebenen Wert. Standardwert ist 1000

Gibt zurück

Körper
DtoResponseRecipientListAll

Empfänger – Hinzufügen

Vorgangs-ID:
Sign_RecipientCreateSingle

Fügt einen neuen Empfänger hinzu – https://support.encodian.com/hc/en-gb/articles/25625138389660

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
E‑Mail-Adresse
 emailAddress True string

Festlegen der E-Mail-Adresse des Empfängers
Vorname
 firstName string

Festlegen des Vornamens des Empfängers
Nachname
 lastName string

Festlegen des Nachnamens des Empfängers
Firma
 company string

Festlegen des Unternehmens des Empfängers
Position
 jobTitle string

Festlegen der Position des Empfängers
Telefonnummer
 phoneNumber string

Festlegen der Telefonnummer des Empfängers

Gibt zurück

Körper
DtoResponseRecipientCreateSingle

Empfänger – Mehrere hinzufügen

Vorgangs-ID:
Sign_RecipientCreateMultiple

Fügt ein Array von Empfängern hinzu – https://support.encodian.com/hc/en-gb/articles/25793665577500

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
E‑Mail-Adresse
 emailAddress True string

Festlegen der E-Mail-Adresse des Empfängers
Vorname
 firstName string

Festlegen des Vornamens des Empfängers
Nachname
 lastName string

Festlegen des Nachnamens des Empfängers
Firma
 company string

Festlegen des Unternehmens des Empfängers
Position
 jobTitle string

Festlegen der Position des Empfängers
Telefonnummer
 phoneNumber string

Festlegen der Telefonnummer des Empfängers

Gibt zurück

Körper
DtoResponseRecipientCreateMultiple

Lieferumfang - Download Audit Trail

Vorgangs-ID:
Sign_EnvelopeDownloadAuditTrail

Laden Sie das Audit Trail-Dokument und JSON für einen Umschlag herunter – https://support.encodian.com/hc/en-gb/articles/30727796963484

Parameter

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

Der eindeutige Umschlagbezeichner

Gibt zurück

Körper
DtoResponseDownloadAuditTrail

Lieferumfang - Signierte Dokumente herunterladen

Vorgangs-ID:
Sign_EnvelopeDownloadSignedDocuments

Herunterladen der signierten Dokumente für einen Umschlag - https://support.encodian.com/hc/en-gb/articles/30727465578396

Parameter

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

Der eindeutige Bezeichner der Umschläge

Gibt zurück

Körper
DtoResponseEnvelopeDownloadSignedDocuments

Umschlag - Einmalige Datei signieren

Vorgangs-ID:
Sign_EnvelopeCreateSingle

Erstellen eines Umschlags für eine einzelne Datei mit einer einzelnen Stufe - https://support.encodian.com/hc/en-gb/articles/26845003436828

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Title
 title True string

Festlegen des Titels des Umschlags
Meldung
 message string

Festlegen einer Nachricht, die für die Empfänger freigegeben werden soll
Absender
 sender True string

Die E-Mail-Adresse des "Absenders", der ein lizenziertes Mitglied des Arbeitsbereichs sein muss
Dateiname
 fileName string

Optional – Der Dateiname der Datei
Datei
 file True byte

Die Datei (Dateiinhalt), die zur Signatur übermittelt werden soll
Übermittlungsmodus
 deliveryMode string

Legen Sie fest, ob die Datei sequenziell oder parallel an Empfänger gesendet werden soll.
Anforderungsmodus
 requirementMode string

Legen Sie fest, ob ein oder alle Empfänger zum Signieren des Dokuments erforderlich sind. Gilt nur, wenn der Übermittlungsmodus = "Parallel"
Typ
 type True string

Festlegen des Empfängertyps (Signierer oder Bearbeiter)
Vorname
 firstName string

Festlegen des Vornamens des Empfängers
Nachname
 lastName string

Festlegen des Nachnamens des Empfängers
E‑Mail-Adresse
 emailAddress True string

Festlegen der E-Mail-Adresse der Empfänger
Order
 order integer

Legen Sie die Reihenfolge fest, in der dieser Empfänger das Dokument erhält, wenn der Übermittlungsmodus sequenziell ist, wenn leer oder 0, die Bestellung automatisch der nächsten verfügbaren Nummer zugewiesen wird.
Language
 language string

Festlegen der Empfängersprache
Typ
 fieldType True string

Festlegen des Feldtyps (Signatur, Text, E-Mail usw.)
Feldname
 fieldName string

Festlegen des Namens des Zielfelds innerhalb des Dokuments
Platzhaltertext
 placeholderText string

Legen Sie den Wert des Platzhaltertexts im Dokument fest, der durch das angegebene Feld ersetzt werden soll.
Standardwert
 defaultValue string

Festlegen des Standardwerts für das Feld
Erforderlich
 isRequired boolean

Festlegen, ob das Feld erforderlich ist
Nur Leseberechtigung
 isReadOnly boolean

Festlegen, ob das Feld schreibgeschützt ist
Läuft ab (Tage)
 expiresIn True integer

Festlegen der Ablaufzeit für den Umschlag in Tagen
Herunterladen als
 downloadAs True string

Legen Sie fest, ob das Lieferumfang (signierte Dokumente) + Abschlusszertifikat als einzelne PDF- oder separate Dateien bereitgestellt wird.

Gibt zurück

Körper
DtoResponseEnvelopeCreateSingle

Umschlag - Signieren einer einzelnen Datei mit Phasen

Vorgangs-ID:
Sign_EnvelopeCreateSingleWithStages

Erstellen eines Umschlags für eine einzelne Datei mit einem mehrstufigen Genehmigungs-/Signierungsprozess - https://support.encodian.com/hc/en-gb/articles/27543439385500

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Title
 title True string

Festlegen des Titels des Umschlags
Meldung
 message string

Festlegen einer Nachricht, die für die Empfänger freigegeben werden soll
Absender
 sender True string

Die E-Mail-Adresse des "Absenders", der ein lizenziertes Mitglied des Arbeitsbereichs sein muss
Dateiname
 fileName string

Optional – Der Dateiname der Datei
Datei
 file True byte

Die Datei (Dateiinhalt), die zur Signatur übermittelt werden soll
Übermittlungsmodus
 deliveryMode string

Legen Sie fest, ob die Datei sequenziell oder parallel an Empfänger gesendet werden soll.
Anforderungsmodus
 requirementMode string

Legen Sie fest, ob ein oder alle Empfänger zum Signieren des Dokuments erforderlich sind. Gilt nur, wenn der Übermittlungsmodus = "Parallel"
Typ
 type True string

Festlegen des Empfängertyps (Signierer oder Bearbeiter)
Vorname
 firstName string

Festlegen des Vornamens des Empfängers
Nachname
 lastName string

Festlegen des Nachnamens des Empfängers
E‑Mail-Adresse
 emailAddress True string

Festlegen der E-Mail-Adresse der Empfänger
Order
 order integer

Legen Sie die Reihenfolge fest, in der dieser Empfänger das Dokument erhält, wenn der Übermittlungsmodus sequenziell ist, wenn leer oder 0, die Bestellung automatisch der nächsten verfügbaren Nummer zugewiesen wird.
Language
 language string

Festlegen der Empfängersprache
Typ
 fieldType True string

Festlegen des Feldtyps (Signatur, Text, E-Mail usw.)
Feldname
 fieldName string

Festlegen des Namens des Zielfelds innerhalb des Dokuments
Platzhaltertext
 placeholderText string

Legen Sie den Wert des Platzhaltertexts im Dokument fest, der durch das angegebene Feld ersetzt werden soll.
Standardwert
 defaultValue string

Festlegen des Standardwerts für das Feld
Erforderlich
 isRequired boolean

Festlegen, ob das Feld erforderlich ist
Nur Leseberechtigung
 isReadOnly boolean

Festlegen, ob das Feld schreibgeschützt ist
Läuft ab (Tage)
 expiresIn True integer

Festlegen der Ablaufzeit für den Umschlag in Tagen
Herunterladen als
 downloadAs True string

Legen Sie fest, ob das Lieferumfang (signierte Dokumente) + Abschlusszertifikat als einzelne PDF- oder separate Dateien bereitgestellt wird.

Gibt zurück

Körper
DtoResponseEnvelopeCreateSingleWithStages

Umschlag - Signieren mehrerer Dateien

Vorgangs-ID:
Sign_EnvelopeCreateMultiple

Erstellen eines Umschlags für eine Sammlung von Dateien mit einer einzelnen Stufe - https://support.encodian.com/hc/en-gb/articles/30727010403868

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Title
 title True string

Festlegen des Namens des Umschlags
Meldung
 message string

Festlegen einer Nachricht, die für die Empfänger freigegeben werden soll
Absender
 sender True string

Die E-Mail-Adresse des "Absenders", der ein lizenziertes Mitglied des Arbeitsbereichs sein muss
ID
 inputFileId True string

Ein eindeutiger Bezeichner für diese hochgeladene Datei, der zum Zuordnen von Feldern zur richtigen Datei verwendet wird
Dateiname
 fileName True string

Der Dateiname der Datei
Datei
 file True byte

Der Dateiinhalt der Datei
Übermittlungsmodus
 deliveryMode string

Legen Sie fest, ob die Datei sequenziell oder parallel an Empfänger gesendet werden soll.
Anforderungsmodus
 requirementMode string

Legen Sie fest, ob ein oder alle Empfänger zum Signieren des Dokuments erforderlich sind. Gilt nur, wenn der Übermittlungsmodus = "Parallel"
Typ
 type True string

Festlegen des Empfängertyps (Signierer oder Bearbeiter)
Vorname
 firstName string

Festlegen des Vornamens des Empfängers
Nachname
 lastName string

Festlegen des Nachnamens des Empfängers
E‑Mail-Adresse
 emailAddress True string

Festlegen der E-Mail-Adresse der Empfänger
Order
 order integer

Legen Sie die Reihenfolge fest, in der dieser Empfänger das Dokument erhält, wenn der Übermittlungsmodus sequenziell ist, wenn leer oder 0, die Bestellung automatisch der nächsten verfügbaren Nummer zugewiesen wird.
Language
 language string

Festlegen der Empfängersprache
Typ
 fieldType True string

Festlegen des Feldtyps (Signatur, Text, E-Mail usw.)
Feldname
 fieldName string

Festlegen des Namens des Zielfelds innerhalb des Dokuments
Platzhaltertext
 placeholderText string

Legen Sie den Wert des Platzhaltertexts im Dokument fest, der durch das angegebene Feld ersetzt werden soll.
Standardwert
 defaultValue string

Festlegen des Standardwerts für das Feld
Erforderlich
 isRequired boolean

Festlegen, ob das Feld erforderlich ist
Nur Leseberechtigung
 isReadOnly boolean

Festlegen, ob das Feld schreibgeschützt ist
Datei-ID
 inputFileId True string

Der eindeutige Dateibezeichner, der zum Zuordnen dieses Felds zu einer der hochgeladenen Dateien verwendet wird
Läuft ab (Tage)
 expiresIn True integer

Festlegen der Ablaufzeit für den Umschlag in Tagen
Herunterladen als
 downloadAs True string

Legen Sie fest, ob das Lieferumfang (signierte Dokumente) + Abschlusszertifikat als einzelne PDF- oder separate Dateien bereitgestellt wird.

Gibt zurück

Körper
DtoResponseEnvelopeCreateMultiple

Umschlag – Signieren mehrerer Dateien mit Phasen

Vorgangs-ID:
Sign_EnvelopeCreateMultipleWithStages

Erstellen eines Umschlags für eine Sammlung von Dateien mit einem mehrstufigen Genehmigungs-/Signierungsprozess - https://support.encodian.com/hc/en-gb/articles/30727071061532

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Title
 title True string

Festlegen des Namens des Umschlags
Meldung
 message string

Festlegen einer Nachricht, die für die Empfänger freigegeben werden soll
Absender
 sender True string

Die E-Mail-Adresse des "Absenders", der ein lizenziertes Mitglied des Arbeitsbereichs sein muss
ID
 inputFileId True string

Ein eindeutiger Bezeichner für diese hochgeladene Datei, der zum Zuordnen von Feldern zur richtigen Datei verwendet wird
Dateiname
 fileName True string

Der Dateiname der Datei
Datei
 file True byte

Der Dateiinhalt der Datei
Übermittlungsmodus
 deliveryMode string

Legen Sie fest, ob die Datei sequenziell oder parallel an Empfänger gesendet werden soll.
Anforderungsmodus
 requirementMode string

Legen Sie fest, ob ein oder alle Empfänger zum Signieren des Dokuments erforderlich sind. Gilt nur, wenn der Übermittlungsmodus = "Parallel"
Typ
 type True string

Festlegen des Empfängertyps (Signierer oder Bearbeiter)
Vorname
 firstName string

Festlegen des Vornamens des Empfängers
Nachname
 lastName string

Festlegen des Nachnamens des Empfängers
E‑Mail-Adresse
 emailAddress True string

Festlegen der E-Mail-Adresse der Empfänger
Order
 order integer

Legen Sie die Reihenfolge fest, in der dieser Empfänger das Dokument erhält, wenn der Übermittlungsmodus sequenziell ist, wenn leer oder 0, die Bestellung automatisch der nächsten verfügbaren Nummer zugewiesen wird.
Language
 language string

Festlegen der Empfängersprache
Typ
 fieldType True string

Festlegen des Feldtyps (Signatur, Text, E-Mail usw.)
Feldname
 fieldName string

Festlegen des Namens des Zielfelds innerhalb des Dokuments
Platzhaltertext
 placeholderText string

Legen Sie den Wert des Platzhaltertexts im Dokument fest, der durch das angegebene Feld ersetzt werden soll.
Standardwert
 defaultValue string

Festlegen des Standardwerts für das Feld
Erforderlich
 isRequired boolean

Festlegen, ob das Feld erforderlich ist
Nur Leseberechtigung
 isReadOnly boolean

Festlegen, ob das Feld schreibgeschützt ist
Datei-ID
 inputFileId True string

Der eindeutige Dateibezeichner, der zum Zuordnen dieses Felds zu einer der hochgeladenen Dateien verwendet wird
Läuft ab (Tage)
 expiresIn True integer

Festlegen der Ablaufzeit für den Umschlag in Tagen
Herunterladen als
 downloadAs True string

Legen Sie fest, ob das Lieferumfang (signierte Dokumente) + Abschlusszertifikat als einzelne PDF- oder separate Dateien bereitgestellt wird.

Gibt zurück

Körper
DtoResponseEnvelopeCreateMultipleWithStages

Umschlag – Status abrufen

Vorgangs-ID:
Sign_EnvelopeGetStatus

Abrufen des Status eines Umschlags

Parameter

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

Der eindeutige Bezeichner der Umschläge

Gibt zurück

Körper
DtoResponseGetEnvelopeStatus

Trigger

Briefumschlag - On Event

Benachrichtigt, wenn ein Umschlagereignis auftritt

Briefumschlag - On Event

Vorgangs-ID:
Sign_SignManageWebHookAsync

Benachrichtigt, wenn ein Umschlagereignis auftritt

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Event
 event True string

Das Ereignis, das den WebHook auslöst

Gibt zurück

Name Pfad Typ Beschreibung
Umschlag-ID
 envelopeUid string

Die Umschlag-ID
Umschlagtitel
 envelopeTitle string

Der Umschlagtitel
Umschlagstatus
 envelopeStatus string

Der Umschlagstatus
Ereignistyp
 eventType string

Der Ereignistyp
Absendername
 senderName string

Den Namen des Absenders
Absender-E-Mail-Adresse
 senderEmail string

Die E-Mail-Adresse des Absenders

Definitionen

DtoRecipient

Name Pfad Typ Beschreibung
E‑Mail-Adresse
 emailAddress string

Festlegen der E-Mail-Adresse des Empfängers
Vorname
 firstName string

Festlegen des Vornamens des Empfängers
Nachname
 lastName string

Festlegen des Nachnamens des Empfängers
Firma
 company string

Festlegen des Unternehmens des Empfängers
Position
 jobTitle string

Festlegen der Position des Empfängers
Telefonnummer
 phoneNumber string

Festlegen der Telefonnummer des Empfängers

DtoResponseDownloadAuditTrail

Name Pfad Typ Beschreibung
Dateiname
 fileName string

Der Dateiname der Datei
Datei
 file byte

Der Dateiinhalt der Datei
Überwachungsdaten
 auditData string

Eine JSON-Darstellung des Überwachungspfads
HTTP-Statuscode
 httpStatusCode integer

Der HTTP-Statuscode für die Antwort
HTTP-Statusmeldung
 httpStatusMessage string

Die HTTP-Statusmeldung für die Antwort
Vorgangs-ID
 operationId string

Die eindeutige ID, die diesem Vorgang zugewiesen ist
Fehler
 errors array of string

Ein Array von Fehlermeldungen sollte ein Fehler auftreten
Vorgangsstatus
 operationStatus string

Gibt an, ob der Vorgang abgeschlossen wurde, in die Warteschlange eingereiht wurde oder fehlgeschlagen ist.

DtoResponseEnvelopeCreateMultiple

Name Pfad Typ Beschreibung
HTTP-Statuscode
 httpStatusCode integer

Der HTTP-Statuscode für die Antwort
HTTP-Statusmeldung
 httpStatusMessage string

Die HTTP-Statusmeldung für die Antwort
Vorgangs-ID
 operationId string

Die eindeutige ID, die diesem Vorgang zugewiesen ist
Fehler
 errors array of string

Ein Array von Fehlermeldungen sollte ein Fehler auftreten
Vorgangsstatus
 operationStatus string

Gibt an, ob der Vorgang abgeschlossen wurde, in die Warteschlange eingereiht wurde oder fehlgeschlagen ist.
Umschlag-ID
 envelopeId string

Der eindeutige Bezeichner der Umschläge
Erstellt
 created date-time

Datum und Uhrzeit der Erstellung des Evelope
Status
 status string

Der Umschlagstatus

DtoResponseEnvelopeCreateMultipleWithStages

Name Pfad Typ Beschreibung
HTTP-Statuscode
 httpStatusCode integer

Der HTTP-Statuscode für die Antwort
HTTP-Statusmeldung
 httpStatusMessage string

Die HTTP-Statusmeldung für die Antwort
Vorgangs-ID
 operationId string

Die eindeutige ID, die diesem Vorgang zugewiesen ist
Fehler
 errors array of string

Ein Array von Fehlermeldungen sollte ein Fehler auftreten
Vorgangsstatus
 operationStatus string

Gibt an, ob der Vorgang abgeschlossen wurde, in die Warteschlange eingereiht wurde oder fehlgeschlagen ist.
Umschlag-ID
 envelopeId string

Der eindeutige Bezeichner der Umschläge
Erstellt
 created date-time

Datum und Uhrzeit der Erstellung des Evelope
Status
 status string

Der Umschlagstatus

DtoResponseEnvelopeCreateSingle

Name Pfad Typ Beschreibung
Umschlag-ID
 envelopeId string

Der eindeutige Bezeichner der Umschläge
Erstellt
 created date-time

Datum und Uhrzeit der Erstellung des Umschlags
Status
 status string

Der Umschlagstatus
HTTP-Statuscode
 httpStatusCode integer

Der HTTP-Statuscode für die Antwort
HTTP-Statusmeldung
 httpStatusMessage string

Die HTTP-Statusmeldung für die Antwort
Vorgangs-ID
 operationId string

Die eindeutige ID, die diesem Vorgang zugewiesen ist
Fehler
 errors array of string

Ein Array von Fehlermeldungen sollte ein Fehler auftreten
Vorgangsstatus
 operationStatus string

Gibt an, ob der Vorgang abgeschlossen wurde, in die Warteschlange eingereiht wurde oder fehlgeschlagen ist.

DtoResponseEnvelopeCreateSingleWithStages

Name Pfad Typ Beschreibung
Umschlag-ID
 envelopeId string

Der eindeutige Bezeichner der Umschläge
Erstellt
 created date-time

Datum und Uhrzeit der Erstellung des Umschlags
Status
 status string

Der Umschlagstatus
HTTP-Statuscode
 httpStatusCode integer

Der HTTP-Statuscode für die Antwort
HTTP-Statusmeldung
 httpStatusMessage string

Die HTTP-Statusmeldung für die Antwort
Vorgangs-ID
 operationId string

Die eindeutige ID, die diesem Vorgang zugewiesen ist
Fehler
 errors array of string

Ein Array von Fehlermeldungen sollte ein Fehler auftreten
Vorgangsstatus
 operationStatus string

Gibt an, ob der Vorgang abgeschlossen wurde, in die Warteschlange eingereiht wurde oder fehlgeschlagen ist.

DtoResponseEnvelopeDownloadSignedDocuments

Name Pfad Typ Beschreibung
Dokumente
 documents array of SignDocumentArray

Die signierten Dateien
HTTP-Statuscode
 httpStatusCode integer

Der HTTP-Statuscode für die Antwort
HTTP-Statusmeldung
 httpStatusMessage string

Die HTTP-Statusmeldung für die Antwort
Vorgangs-ID
 operationId string

Die eindeutige ID, die diesem Vorgang zugewiesen ist
Fehler
 errors array of string

Ein Array von Fehlermeldungen sollte ein Fehler auftreten
Vorgangsstatus
 operationStatus string

Gibt an, ob der Vorgang abgeschlossen wurde, in die Warteschlange eingereiht wurde oder fehlgeschlagen ist.

DtoResponseGetEnvelopeStatus

Name Pfad Typ Beschreibung
Status
 status string

Der Umschlagstatus
HTTP-Statuscode
 httpStatusCode integer

Der HTTP-Statuscode für die Antwort
HTTP-Statusmeldung
 httpStatusMessage string

Die HTTP-Statusmeldung für die Antwort
Vorgangs-ID
 operationId string

Die eindeutige ID, die diesem Vorgang zugewiesen ist
Fehler
 errors array of string

Ein Array von Fehlermeldungen sollte ein Fehler auftreten
Vorgangsstatus
 operationStatus string

Gibt an, ob der Vorgang abgeschlossen wurde, in die Warteschlange eingereiht wurde oder fehlgeschlagen ist.

DtoResponseRecipientCreateMultiple

Name Pfad Typ Beschreibung
Verarbeitet
 processed array of string

Eine Liste der Empfänger, die dem Arbeitsbereich hinzugefügt wurden
Nicht verarbeitet
 unprocessed object

Eine Liste der Empfänger, einschließlich der zugeordneten Fehlermeldung für alle Empfänger, die nicht hinzugefügt werden konnten
HTTP-Statuscode
 httpStatusCode integer

Der HTTP-Statuscode für die Antwort
HTTP-Statusmeldung
 httpStatusMessage string

Die HTTP-Statusmeldung für die Antwort
Vorgangs-ID
 operationId string

Die eindeutige ID, die diesem Vorgang zugewiesen ist
Fehler
 errors array of string

Ein Array von Fehlermeldungen sollte ein Fehler auftreten
Vorgangsstatus
 operationStatus string

Gibt an, ob der Vorgang abgeschlossen wurde, in die Warteschlange eingereiht wurde oder fehlgeschlagen ist.

DtoResponseRecipientCreateSingle

Name Pfad Typ Beschreibung
Empfänger-ID
 recipientId string

Eindeutiger Bezeichner des Empfängers
Erstellt
 created date-time

Datum und Uhrzeit der Erstellung des Empfängers
HTTP-Statuscode
 httpStatusCode integer

Der HTTP-Statuscode für die Antwort
HTTP-Statusmeldung
 httpStatusMessage string

Die HTTP-Statusmeldung für die Antwort
Vorgangs-ID
 operationId string

Die eindeutige ID, die diesem Vorgang zugewiesen ist
Fehler
 errors array of string

Ein Array von Fehlermeldungen sollte ein Fehler auftreten
Vorgangsstatus
 operationStatus string

Gibt an, ob der Vorgang abgeschlossen wurde, in die Warteschlange eingereiht wurde oder fehlgeschlagen ist.

DtoResponseRecipientDeleteSingle

Name Pfad Typ Beschreibung
Gelöscht
 deleted date-time

Datum und Uhrzeit, zu der der Empfänger gelöscht wurde
HTTP-Statuscode
 httpStatusCode integer

Der HTTP-Statuscode für die Antwort
HTTP-Statusmeldung
 httpStatusMessage string

Die HTTP-Statusmeldung für die Antwort
Vorgangs-ID
 operationId string

Die eindeutige ID, die diesem Vorgang zugewiesen ist
Fehler
 errors array of string

Ein Array von Fehlermeldungen sollte ein Fehler auftreten
Vorgangsstatus
 operationStatus string

Gibt an, ob der Vorgang abgeschlossen wurde, in die Warteschlange eingereiht wurde oder fehlgeschlagen ist.

DtoResponseRecipientGetSingle

Name Pfad Typ Beschreibung
Empfänger-ID
 recipientId string

Eindeutiger Bezeichner des Empfängers
E‑Mail-Adresse
 emailAddress string

Die E-Mail-Adresse des Empfängers
Vorname
 firstName string

Vorname des Empfängers
Nachname
 lastName string

Nachname des Empfängers
Firma
 company string

Das Unternehmen des Empfängers
Position
 jobTitle string

Position des Empfängers
Telefonnummer
 phoneNumber string

Die Telefonnummer des Empfängers
HTTP-Statuscode
 httpStatusCode integer

Der HTTP-Statuscode für die Antwort
HTTP-Statusmeldung
 httpStatusMessage string

Die HTTP-Statusmeldung für die Antwort
Vorgangs-ID
 operationId string

Die eindeutige ID, die diesem Vorgang zugewiesen ist
Fehler
 errors array of string

Ein Array von Fehlermeldungen sollte ein Fehler auftreten
Vorgangsstatus
 operationStatus string

Gibt an, ob der Vorgang abgeschlossen wurde, in die Warteschlange eingereiht wurde oder fehlgeschlagen ist.

DtoResponseRecipientListAll

Name Pfad Typ Beschreibung
Empfänger
 recipients array of DtoRecipient

Die Sammlung der Empfänger innerhalb des Arbeitsbereichs
HTTP-Statuscode
 httpStatusCode integer

Der HTTP-Statuscode für die Antwort
HTTP-Statusmeldung
 httpStatusMessage string

Die HTTP-Statusmeldung für die Antwort
Vorgangs-ID
 operationId string

Die eindeutige ID, die diesem Vorgang zugewiesen ist
Fehler
 errors array of string

Ein Array von Fehlermeldungen sollte ein Fehler auftreten
Vorgangsstatus
 operationStatus string

Gibt an, ob der Vorgang abgeschlossen wurde, in die Warteschlange eingereiht wurde oder fehlgeschlagen ist.

SignDocumentArray

Name Pfad Typ Beschreibung
Dateiname
 fileName string

Der Dateiname der Datei
Datei
 File byte

Der Dateiinhalt der Datei