Freigeben über

SignNow EU (Vorschau)

SignNow ermöglicht sichere, kompatible und auditfähige eSignature-Workflows für Unternehmen, Legal, HR, Healthcare und Finance Teams. Senden und Nachverfolgen von Signaturanforderungen in rollenbasierter Reihenfolge, Vorfüllen von Dokumentfeldern und Verwalten von Dokumentgruppen mithilfe des SignNow-Connectors.

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 Hilfecenter
URL https://support.signnow.com/
Email integrations@pdffiller.com
Connectormetadaten
Herausgeber DaDaDocs
Webseite https://signnow.com
Datenschutzrichtlinie https://www.signnow.com/privacy_policy
Kategorien Produktivität; Personalabteilung

SignNow EU Connector

SignNow ermöglicht sichere, kompatible und auditfähige eSignature-Workflows für Unternehmen, Legal, HR, Healthcare und Finance Teams. Senden und Nachverfolgen von Signaturanforderungen in rollenbasierter Reihenfolge, Vorfüllen von Dokumentfeldern und Verwalten von Dokumentgruppen mithilfe des SignNow-Connectors.

Voraussetzungen

Sie benötigen ein SignNow EU-Konto (wählen Sie auf dem Anmeldebildschirm "EU-Server" aus) und das SignNow-API-Abonnement, um fortzufahren.

Bereitstellen des Beispiels

Aktualisieren Sie zuerst den ClientId-Wert in der apiProperties.json mit Ihrem eigenen.

Führen Sie die folgenden Befehle aus, und folgen Sie den Eingabeaufforderungen:

paconn create --api-def apiDefinition.swagger.json --api-prop apiProperties.json --secret <client_secret>

Unterstützte Aktionen und Trigger

Weitere Informationen finden Sie in der Dokumentation .

Drosselungsgrenzwerte

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

Aktionen

Abrufen des Dokumentschemas [VERALTET]

Diese Aktion ist veraltet. Verwenden Sie stattdessen das Get-Dokumentschema .

OpenAPI-Dokumentschema abrufen
Abrufen von Dokumentfeldern [VERALTET]

Diese Aktion ist veraltet. Verwenden Sie stattdessen "Dokumentfelder abrufen ".

Dient zum Abrufen von Dokumentfeldwerten.
Abrufen von Dokumentinformationen

Abrufen von Dokumenteigenschaften wie Name, ID, Erstellungs-/Aktualisierungsdaten usw.
Dokument aus Vorlage erstellen

Generieren eines Dokuments aus einer ausgewählten Vorlage
Dokument herunterladen

Herunterladen eines Dokuments von SignNow
Dokument hochladen

Hochladen eines Dokuments in SignNow
Dokument löschen

Löschen eines Dokuments aus SignNow
Dokumentfelder abrufen (Vorschau)

Abrufen von Werten aus den ausfüllbaren Feldern im Dokument
Dokumentgruppe abrufen

Abrufen einer Liste der Dokumentgruppen des Benutzers
Dokumentgruppe aus mehreren Dateien erstellen

Erstellen einer Dokumentgruppe durch Hochladen mehrerer Dateien als base64-codierte Zeichenfolgen
Dokumentgruppen abrufen

Abrufen einer Liste der Dokumentgruppen des Benutzers
Dokumentgruppen-Einladungsstatus abrufen

Diese Aktion ruft Informationen zu einer Dokumentgruppen-Einladung ab, einschließlich des Status der einzelnen Schritte und Aktionen.
Dokumentliste abrufen

Abrufen einer Liste der Benutzerdokumente
Dokumentzuladungsstatus abrufen

Diese Aktion ruft Informationen zu einer Dokumentseinladung ab, einschließlich des Status der einzelnen Schritte und Aktionen.
Eingebettete Einladung des Dokuments löschen

Diese Aktion löscht eine eingebettete Einladung für ein Dokument.
Eingebettete Einladung zum Erstellen eines Dokuments

Diese Aktion erstellt eine eingebettete Signatur-Einladung für ein Dokument. Nachdem die Einladung erstellt wurde, generieren Sie einen eingebetteten Signaturlink.
Eingebettete Einladung zur Dokumentgruppe erstellen

Diese Aktion erstellt eine eingebettete Signatur-Einladung für eine Dokumentgruppe. Nachdem die Einladung erstellt wurde, generieren Sie einen eingebetteten Signaturlink.
Eingebettete Einladung zur Dokumentgruppe löschen

Diese Aktion löscht eine eingebettete Einladung für eine bestimmte Dokumentgruppe.
Einladung abbrechen

Kündigung der Signaturseinladung
Empfänger in Dokumentgruppen-Einladung ersetzen

Diese Aktion ersetzt Empfänger in einer Dokumentgruppen-Einladung durch die Einladungs-ID. Sie können auch einen Einladungsablauf, Erinnerungen, Berechtigungen neu zuweisen und Optionen für jedes Dokument ablehnen
Ersetzen von Empfängern in Dokumentseinladung

Diese Aktion ersetzt Empfänger in der Dokumentseinladung basierend auf ihren Rollen. Es ermöglicht außerdem das Aktualisieren von Einladungseinstellungen wie Authentifizierungstyp, Ablauftage und anderen erweiterten Parametern für jede Rolle.
Erstellen einer Dokumentgruppe aus der Gruppenvorlage

Erstellen der Dokumentgruppe aus einer ausgewählten Gruppenvorlage
Feldwerte für dokumentgruppenvorfüllen

Automatisches Auffüllen von ausfüllbaren Feldern in den Dokumenten mit bestimmten Werten
Link "Eingebettete Einladung für Dokument generieren"

Diese Aktion generiert einen Link für die eingebettete Einladung des Dokuments.
Link "Eingebettete Einladung für Dokumentgruppe generieren"

Diese Aktion generiert einen Link für die eingebettete Einladung für die Dokumentgruppe.
Link "Eingebettetes Senden von Dokumenten erstellen"

Diese Aktion generiert einen eingebetteten Sendelink für ein bestimmtes Dokument, sodass Benutzer von Drittanbietern das Dokument für die Signatur vorbereiten und senden können.
Link zum Eingebetteten Senden einer Dokumentgruppe erstellen

Diese Aktion generiert einen eingebetteten Sendelink für eine bestimmte Dokumentgruppe, sodass Benutzer von Drittanbietern die Dokumentgruppe für die Signatur vorbereiten und senden können.
Signierlink erstellen

Generieren eines Links zum Dokument und Freigeben des Dokuments, damit das Dokument signiert ist
Veraltet – Einladung zum Signieren der Dokumentgruppe

Die Aktion ist veraltet. Einladen anderer Personen zum Ausfüllen und Abmelden der Dokumentgruppe
Veraltet – Erweiterte Dokumenteinladung

Die Aktion ist veraltet. Einladungsanforderung mit manuell definierten Schemas. Es ermöglicht das Einrichten von Einladungen für ein Dokument, das in Zukunft generiert wird.
Veraltet – Zum Signieren einladen

Die Aktion ist veraltet. Einladen anderer Personen zum Ausfüllen und Abmelden des Dokuments
Vorfüllen intelligenter Feldwerte

Vorfüllen von Smart Field-Werten für das angegebene Dokument
Vorfüllen von Dokumentfeldwerten (Vorschau)

Automatisches Auffüllen von ausfüllbaren Feldern im Dokument mit bestimmten Werten
Vorfüllen von Dokumentfeldwerten [VERALTET]

Diese Aktion ist veraltet. Verwenden Sie stattdessen die Werte für das Vorfüllen des Dokumentfelds .

Vorfüllen von Feldwerten und Eigenschaften.
Vorfüllen von Intelligenten Feldwerten für die Dokumentgruppe

Automatisches Auffüllen von intelligenten Feldern in den Dokumenten mit bestimmten Werten
Zum Signieren der Dokumentgruppe einladen

Diese Aktion erstellt eine Einladung zum Signieren einer Dokumentgruppe. Sie können einen mehrstufigen Workflow konfigurieren, bei dem unterschiedliche Empfänger in verschiedenen Phasen auf die Dokumentgruppe reagieren.
Zum Signieren des Dokuments einladen

Diese Aktion erstellt und sendet eine Feldseinladung für ein zu signiertes Dokument.

Abrufen des Dokumentschemas [VERALTET]

Vorgangs-ID:
GetDocSchema

Diese Aktion ist veraltet. Verwenden Sie stattdessen das Get-Dokumentschema .

OpenAPI-Dokumentschema abrufen

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Dokument-ID
 doc_id string

Angeben einer eindeutigen Dokument-ID
Feldtypfilter
 select string

Trennen Sie mit einem Komma, welche Feldtypen Sie abrufen möchten.

Gibt zurück

Name Pfad Typ Beschreibung
Eigenschaften
 properties object

Abrufen von Dokumentfeldern [VERALTET]

Vorgangs-ID:
GetDocFields

Diese Aktion ist veraltet. Verwenden Sie stattdessen "Dokumentfelder abrufen ".

Dient zum Abrufen von Dokumentfeldwerten.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Template
 template_id True string

Angeben einer Dokumentvorlage zum Abrufen von Feldern aus
Dokument-ID
 doc_id True string

Angeben einer eindeutigen Dokument-ID

Gibt zurück

Die Ausgaben dieses Vorgangs sind dynamisch.

Abrufen von Dokumentinformationen

Vorgangs-ID:
GetDoc

Abrufen von Dokumenteigenschaften wie Name, ID, Erstellungs-/Aktualisierungsdaten usw.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Template
 template True boolean

Angeben, ob Dokumente oder Vorlagen abgerufen werden sollen
Dokument-ID
 doc_id True string

Angeben einer eindeutigen Dokument-ID oder Auswählen eines Dokuments aus der Liste

Gibt zurück

Body
DocumentProperties

Dokument aus Vorlage erstellen

Vorgangs-ID:
CreateFromTemplate

Generieren eines Dokuments aus einer ausgewählten Vorlage

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Dokumentvorlage
 doc_id True string

Auswählen einer Vorlage aus der Liste
Dokumentname
 document_name string

Neuen Dateinamen für das Dokument eingeben

Gibt zurück

Name Pfad Typ Beschreibung
Dokument-ID
 id DocumentId

Eindeutige Dokument-ID

Dokument herunterladen

Vorgangs-ID:
DownloadDocument

Herunterladen eines Dokuments von SignNow

Parameter

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

Angeben einer eindeutigen Dokument-ID oder Auswählen eines Dokuments aus der Liste
Format
 mode string

Auswählen eines Dokumentformats zum Herunterladen

Gibt zurück

response
binary

Dokument hochladen

Vorgangs-ID:
UploadDocument

Hochladen eines Dokuments in SignNow

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Datei
 file True file

Datei, die hochgeladen werden soll

Gibt zurück

Name Pfad Typ Beschreibung
Dokument-ID
 id DocumentId

Eindeutige Dokument-ID

Dokument löschen

Vorgangs-ID:
DeleteDoc

Löschen eines Dokuments aus SignNow

Parameter

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

Angeben einer eindeutigen Dokument-ID

Gibt zurück

Name Pfad Typ Beschreibung
Der Status
 status string

Dokumententfernungsstatus

Dokumentfelder abrufen (Vorschau)

Vorgangs-ID:
GetDocFields_V2

Abrufen von Werten aus den ausfüllbaren Feldern im Dokument

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Template
 template_id True string

Angeben einer Dokumentvorlage zum Abrufen von Feldern aus
Dokument-ID
 doc_id True string

Angeben einer eindeutigen Dokument-ID

Gibt zurück

Die Ausgaben dieses Vorgangs sind dynamisch.

Dokumentgruppe abrufen

Vorgangs-ID:
GetDocumentGroup

Abrufen einer Liste der Dokumentgruppen des Benutzers

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Gruppenvorlage
 doc_group_id True string

Auswählen der Gruppenvorlage aus der Liste
Template
 template True boolean

Angeben, ob Dokumentgruppe oder Gruppenvorlage abgerufen werden soll

Gibt zurück

Body
DocumentGroupProperties

Dokumentgruppe aus mehreren Dateien erstellen

Vorgangs-ID:
CreateDocGroupFromFiles

Erstellen einer Dokumentgruppe durch Hochladen mehrerer Dateien als base64-codierte Zeichenfolgen

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Dokumentgruppenname
 group_name True string

Geben Sie einen Namen für die Dokumentgruppe ein.
Dokumentname
 name True string

Dokumentname mit Erweiterung: Report.pdf, Letter.docx usw.
Inhalt der Datei
 content True string

Base64-codierte Zeichenfolge, die Den Inhalt des Dokuments darstellt

Gibt zurück

Body
CreateDocumentGroupFromFilesResponse

Dokumentgruppen abrufen

Vorgangs-ID:
GetListDocGroups

Abrufen einer Liste der Dokumentgruppen des Benutzers

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Template
 template True boolean

Geben Sie an, ob Dokumentgruppen oder Gruppenvorlagen abgerufen werden sollen.
Limit
 limit integer

Gesamtzahl der zurückgegebenen Elemente (zwischen 1 und 50)
Offset
 offset integer

Der (nullbasierte) Offset des ersten Elements in der Auflistung, das zurückgegeben werden soll

Gibt zurück

Body
DocumentGroupsResponse

Dokumentgruppen-Einladungsstatus abrufen

Vorgangs-ID:
GetDocumentGroupInviteStatus

Diese Aktion ruft Informationen zu einer Dokumentgruppen-Einladung ab, einschließlich des Status der einzelnen Schritte und Aktionen.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Dokumentgruppen-ID
 id True string

Dokumentgruppen-ID

Gibt zurück

Name Pfad Typ Beschreibung
Dokumentgruppen-Einladungs-ID
 document_group_invite_id string

Einladungs-ID der Dokumentgruppe
Dokumentgruppenstatus
 status string

Dokumentgruppensignaturstatus. Mögliche Werte: 'created', 'pending', 'fulfilled', 'canceled'
Besitzer-E-Mail
 owner_email string

E-Mail-Adresse des Dokumentgruppenbesitzers
Dokumentgruppe abgelehnt
 is_document_declined boolean

Gibt "true" zurück, wenn ein Dokument in der Gruppe von einem Signierer oder genehmigenden Benutzer abgelehnt wird; andernfalls wird "false" zurückgegeben.
steps
 steps array of object

Steps
Schritt-ID
 steps.step_id string

Schritt-ID aus der Dokumentgruppen-Einladung
Signierreihenfolge
 steps.signing_order integer

Reihenfolge der Signierung
Dokument-ID
 steps.document_id string

Dokument-ID
Dokumentname
 steps.document_name string

Dokumentname
Signierer-E-Mail
 steps.signer_email string

E-Mail-Adresse des Empfängers
Rollenname
 steps.role_name string

Name der Empfängerrolle
Aktionstyp
 steps.action_type string

Die aktion, die vom Empfänger im Dokument benötigt wird. Mögliche Werte: "Sign", "View", "Approve" oder "FreeFormSign"
Schritt-Einladungs-ID
 steps.invite_id string

ID des Einladungsschritts
Der Status
 steps.status string

Der Signaturstatus des Schritts
Declined
 steps.declined boolean

True, wenn der Empfänger in diesem Schritt das Dokument abgelehnt hat
Grund ablehnen
 steps.decline_reason string

Nachricht, die vom Empfänger beim Ablehnen des Dokuments bereitgestellt wird
Erstellt
 steps.created integer

Datum, an dem der Schritt erstellt wurde
Updated
 steps.updated integer

Datum, an dem der Schrittstatus zuletzt aktualisiert wurde

Dokumentliste abrufen

Vorgangs-ID:
GetListDoc

Abrufen einer Liste der Benutzerdokumente

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Template
 template boolean

Angeben, ob Dokumente oder Vorlagen abgerufen werden sollen
Standardvorlage einschließen
 includeDefaultTemplate boolean

Geben Sie an, ob die Standardvorlage der Vorlagenliste hinzugefügt werden soll.

Gibt zurück

response
array of DocumentProperties

Dokumentzuladungsstatus abrufen

Vorgangs-ID:
GetInviteStatus

Diese Aktion ruft Informationen zu einer Dokumentseinladung ab, einschließlich des Status der einzelnen Schritte und Aktionen.

Parameter

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

Dokument-ID

Gibt zurück

Name Pfad Typ Beschreibung
Dokument abgelehnt
 is_document_declined boolean

True, wenn das Dokument vom Signierer oder Genehmiger abgelehnt wurde, andernfalls "false".
steps
 steps array of object

Steps
Signierreihenfolge
 steps.signing_order integer

Reihenfolge der Signierung
Empfänger-E-Mail
 steps.signer_email string

E-Mail-Adresse des Empfängers
Rollenname
 steps.role_name string

Name der Empfängerrolle
Aktionstyp
 steps.action_type string

Die aktion, die vom Empfänger im Dokument benötigt wird. Mögliche Werte: "Sign", "View", "Approve" oder "FreeFormSign"
Einladungs-ID
 steps.invite_id string

Einladungs-ID
Der Status
 steps.status string

Signaturstatus. Mögliche Werte: 'created', 'pending', 'fulfilled', 'canceled', 'skipped'
Declined
 steps.declined boolean

Gibt 'true' zurück, wenn der Empfänger dieses Schritts das Dokument abgelehnt hat.
Grund ablehnen
 steps.decline_reason string

Nachricht, die vom Empfänger beim Ablehnen des Dokuments bereitgestellt wird
Erstellt
 steps.created integer

Datum, an dem der Schritt erstellt wurde
Updated
 steps.updated integer

Datum, an dem der Schrittstatus zuletzt aktualisiert wurde

Eingebettete Einladung des Dokuments löschen

Vorgangs-ID:
DeleteEmbeddedInvites

Diese Aktion löscht eine eingebettete Einladung für ein Dokument.

Parameter

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

Dokument-ID

Eingebettete Einladung zum Erstellen eines Dokuments

Vorgangs-ID:
CreateEmbeddedInvites

Diese Aktion erstellt eine eingebettete Signatur-Einladung für ein Dokument. Nachdem die Einladung erstellt wurde, generieren Sie einen eingebetteten Signaturlink.

Parameter

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

Dokument-ID
Signierer-E-Mail
 email True email

E-Mail-Adresse des Empfängers
Rolle
 role True string

Name der Empfängerrolle z. B. "Signierer 1" (Viewerrollen werden nicht unterstützt)
Bestellung
 order True integer

Die Reihenfolge der Signierung
Namensformel
 name_formula string

Eine Formel zum Generieren eines vollständigen Dokumentnamens mithilfe eines Präfixes (beliebiger Text) und ausfüllbarer Felddaten. Beispiel: "Vertrag|signer_name|signed_date", wobei "Vertrag" das Präfix ist, und "signer_name" und "signed_date" namen ausfüllbaren Feldern sind
Rolle
 role True string

Name der Empfängerrolle z. B. "Signierer 1" (Viewerrollen werden nicht unterstützt)
Language
 language string

Gibt die Sprache der Signatursitzung und Benachrichtigungs-E-Mails für den Signierer an. Mögliche Werte: En für Englisch, Es für Spanisch und Fr für Französisch. Wenn nicht festgelegt, wird die Sprache durch die Sprache Ihres SignNow-Kontos bestimmt.
Vorname
 first_name string

Vorname des Empfängers
Nachname
 last_name string

Nachname des Empfängers
Erforderlicher voreingestellter Signaturname
 required_preset_signature_name string

Vorgefüllter Text für das Signaturfeld, gesperrt für die Bearbeitung durch den Empfänger. Kann nicht mit "prefill_signature_name" oder "force_new_signature" verwendet werden.
Vorfüllen des Signaturnamens
 prefill_signature_name string

Eine Zeichenfolge mit einem Signaturnamen, der angezeigt wird, wenn ein Signierer auf ein Signaturfeld klickt. Der Signierer kann die Signatur bearbeiten.
Neue Signatur anfordern
 force_new_signature boolean

Definiert, ob der Signierer seine gespeicherte Signatur verwenden kann oder nicht. Wenn dieser Wert auf "true" festgelegt ist, muss der Signierer eine neue Signatur hinzufügen. Wenn dieser Wert auf "false" festgelegt ist, kann der Signierer die gespeicherte Signatur verwenden.
Umleitungs-URI
 redirect_uri string

Der Link, der nach Abschluss der Signatursitzung geöffnet wird
Umleitungs-URI ablehnen
 decline_redirect_uri string

Der Link, der geöffnet wird, nachdem der Empfänger abgelehnt hat, das Dokument zu signieren
Umleitungs-URI schließen
 close_redirect_uri string

Der Link, der geöffnet wird, wenn der Empfänger während einer Signiersitzung auf "Fortschritt speichern" und "Später beenden" klickt oder im Ansichtsmodus schließen
Umleitungsziel
 redirect_target string

Bestimmt, ob der Umleitungs-URI in einer neuen Registerkarte im Browser oder auf derselben Registerkarte nach der Signierungssitzung geöffnet werden soll. Mögliche Werte: "Auf der neuen Registerkarte" – öffnet den Link auf einer neuen Registerkarte "In derselben Registerkarte" – öffnet den Link auf derselben Registerkarte.
Authentifizierungstyp
 authentication_type string

Authentifizierungstyp, der während der Signatursitzung für die Empfängerauthentifizierung verwendet wird. Zulässige Werte: "Kennwort", "Telefonanruf" und "Sms"
Authentifizierungskennwort
 authentication_password string

Kennwortsatz für die Signiererauthentifizierung. Erforderlich für den Authentifizierungstyp "Kennwort"
Authentifizierungstelefon
 authentication_phone string

Zum Authentifizieren des Signierers verwendete Telefonnummer. Erforderlich für den Authentifizierungstyp "Telefonanruf" und "Sms". Beispiel: +1XXXXXXXXXXX
Sms-Nachricht für die Authentifizierung
 authentication_sms_message string

Benutzerdefinierte SMS-Nachricht, die an den Signierer gesendet wird, der den Platzhalter "{password}" enthält. Wird mit dem Authentifizierungstyp "SMS" verwendet. Ohne diesen Parameter empfängt der Signierer eine Standard-SMS mit einem automatisch generierten Kennwort (Entsperrcode) - "SignNow Document Invite unlock code: 123456" Beispiel: Geben Sie das Kennwort {password} ein, um Ihr Dokument zu entsperren.
Übermittlungstyp
 delivery_type string

Definiert, wie die Einladung gesendet wird.
Ablauf des Links
 link_expiration integer

In wie vielen Minuten die E-Mail-Einladung abläuft. Kann nur verwendet werden, wenn "Übermittlungstyp=E-Mail" verwendet wird. Gültiger Bereich: 15–43200 Minuten
Sitzungsablauf
 session_expiration integer

In wie vielen Minuten die Signatursitzung abläuft. Wenn für diese Einladung ein Link generiert wird, wird der Sitzungsablauf zurückgesetzt. Gilt nur, wenn "Delivery type=email" und für "Sign"-Aktionen. Gültiger Bereich: 15–1440 Minuten
QES-Signatur
 signature string

Typ von QES. Mögliche Werte: 'Eideasy', 'Nom151'. Wird verwendet, um QES-Signaturen von Signierern anzufordern. Alle Signierer in der Einladung müssen denselben Signaturtyp verwenden. Um eine Einladung mit QES zu erstellen, muss der Benutzer zu einer Organisation gehören, für die QES aktiviert ist.

Gibt zurück

Name Pfad Typ Beschreibung
Daten
 data array of object

Daten
Id
 data.id string

ID der erstellten eingebetteten Einladung
Email
 data.email string

E-Mail-Adresse des Empfängers
Rollen-ID
 data.role_id string

Empfängerrollen-ID
Bestellung
 data.order integer

Empfängerreihenfolge der Signierung
Der Status
 data.status string

Eingebetteter Einladungsstatus

Eingebettete Einladung zur Dokumentgruppe erstellen

Vorgangs-ID:
CreateDocGroupEmbeddedInvites

Diese Aktion erstellt eine eingebettete Signatur-Einladung für eine Dokumentgruppe. Nachdem die Einladung erstellt wurde, generieren Sie einen eingebetteten Signaturlink.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Dokumentgruppen-ID
 id True string

Dokumentgruppen-ID
Bestellung
 order True integer

Schritt der Signierungsreihenfolge. Alle Signierer, die einem bestimmten order Schritt (z. B. ) zugewiesen sind, order: 1empfangen gleichzeitig die Einladungs-E-Mail. E-Mails für den nächsten Bestellschritt (z. B. ) werden erst gesendet, order: 2nachdem alle Aktionen im vorherigen Bestellschritt abgeschlossen wurden.
Email
 email True string

E-Mail-Adresse des Empfängers
Dokument-ID
 id True string

ID des Dokuments
Rolle
 role string

Empfängerrolle im Dokument. Rollen sollten für die Aktion 'Ansicht' nicht angegeben werden.
Maßnahme
 action True string

Die aktion, die vom Empfänger im Dokument benötigt wird. Zulässige Werte: 'Sign', 'view'
Bestellung
 order True string

Schritt der Signierungsreihenfolge
Email
 email True string

E-Mail-Adresse des Empfängers
Language
 language string

Gibt die Sprache der Signatursitzung und Benachrichtigungs-E-Mails für den Signierer an. Mögliche Werte: En für Englisch, Es für Spanisch und Fr für Französisch. Wenn nicht festgelegt, wird die Sprache durch die Sprache Ihres SignNow-Kontos bestimmt.
Vorname
 first_name string

Vorname des Empfängers
Nachname
 last_name string

Nachname des Empfängers
Erforderlicher voreingestellter Signaturname
 required_preset_signature_name string

Vorgefüllter Text für das Signaturfeld, gesperrt für die Bearbeitung durch den Empfänger
Umleitungs-URI
 redirect_uri string

Der Link, der nach Abschluss der Signatursitzung geöffnet wird
Umleitungs-URI ablehnen
 decline_redirect_uri string

Der Link, der geöffnet wird, nachdem der Empfänger abgelehnt hat, das Dokument zu signieren
Umleitungs-URI schließen
 close_redirect_uri string

Der Link, der geöffnet wird, wenn der Empfänger während einer Signiersitzung auf "Fortschritt speichern" und "Später beenden" klickt oder im Ansichtsmodus schließen
Umleitungsziel
 redirect_target string

Bestimmt, ob der Umleitungs-URI in einer neuen Registerkarte im Browser oder auf derselben Registerkarte nach der Signierungssitzung geöffnet werden soll. Mögliche Werte: "Auf der neuen Registerkarte" – öffnet den Link auf einer neuen Registerkarte "In derselben Registerkarte" – öffnet den Link auf derselben Registerkarte.
Übermittlungstyp
 delivery_type string

Definiert, wie die Einladung gesendet wird.
Ablauf des Links
 link_expiration integer

In wie vielen Minuten die E-Mail-Einladung abläuft. Kann nur verwendet werden, wenn "Übermittlungstyp=E-Mail" verwendet wird. Gültiger Bereich: 15–43200 Minuten
Sitzungsablauf
 session_expiration integer

In wie vielen Minuten die Signatursitzung abläuft. Wenn für diese Einladung ein Link generiert wird, wird der Sitzungsablauf zurückgesetzt. Gilt nur, wenn "Delivery type=email" und für "Sign"-Aktionen. Gültiger Bereich: 15–1440 Minuten
Authentifizierungstyp
 authentication_type string

Authentifizierungstyp, der während der Signatursitzung für die Empfängerauthentifizierung verwendet wird. Zulässige Werte: "Kennwort", "Telefonanruf" und "Sms"
Authentifizierungskennwort
 authentication_password string

Kennwortsatz für die Authentifizierung des Signierers. Erforderlich für den Authentifizierungstyp "Kennwort"
Authentifizierungstelefon
 authentication_phone string

Zum Authentifizieren des Signierers verwendete Telefonnummer. Erforderlich für den Authentifizierungstyp "Telefonanruf" und "Sms". Beispiel: +1XXXXXXXXXXX
Sms-Nachricht für die Authentifizierung
 authentication_sms_message string

Benutzerdefinierte SMS-Nachricht, die an den Signierer gesendet wird, der den Platzhalter "{password}" enthält. Wird mit dem Authentifizierungstyp "SMS" verwendet. Ohne diesen Parameter empfängt der Signierer eine Standard-SMS mit einem automatisch generierten Kennwort (Entsperrcode) – "SignNow-Dokumenteinladungssperrcode: 123456". Beispiel: Geben Sie das Kennwort "{password}" ein, um Ihr Dokument zu entsperren.
QES-Signatur
 signature string

Typ von QES. Mögliche Werte: 'Eideasy', 'Nom151'. Wird verwendet, um QES-Signaturen von Signierern anzufordern. Alle Signierer in der Einladung müssen denselben Signaturtyp verwenden. Um eine Einladung mit QES zu erstellen, muss der Benutzer zu einer Organisation gehören, für die QES aktiviert ist.

Gibt zurück

Name Pfad Typ Beschreibung
Einladungs-ID
 id string

ID der erstellten eingebetteten Einladung

Eingebettete Einladung zur Dokumentgruppe löschen

Vorgangs-ID:
DeleteDocGroupEmbeddedInvites

Diese Aktion löscht eine eingebettete Einladung für eine bestimmte Dokumentgruppe.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Dokumentgruppen-ID
 id True string

Dokumentgruppen-ID

Einladung abbrechen

Vorgangs-ID:
CancelInvite

Kündigung der Signaturseinladung

Parameter

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

Angeben der Dokument-ID für den Abbruch der Signaturseinladung

Gibt zurück

response
object

Empfänger in Dokumentgruppen-Einladung ersetzen

Vorgangs-ID:
ReplaceRecipientsInDocumentGroupInvite

Diese Aktion ersetzt Empfänger in einer Dokumentgruppen-Einladung durch die Einladungs-ID. Sie können auch einen Einladungsablauf, Erinnerungen, Berechtigungen neu zuweisen und Optionen für jedes Dokument ablehnen

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Dokumentgruppen-ID
 id True string

Dokumentgruppen-ID
Einladungs-ID
 invite_id True string

Dokumentgruppen-Einladungs-ID
Schritt-ID
 step_id string

ID des Einladungsschritts aus der Dokumentgruppen-Einladung
Zu ersetzende Empfänger
 recipient_to_update string

E-Mail des zu ersetzenden Empfängers
Neuer Empfänger
 new_recipient string

E-Mail des neuen Empfängers
Ablauftage
 expiration_days integer

In wie vielen Tagen die Einladung abläuft; Max. 30 Tage
Erinnerung
 reminder integer

In wie vielen Tagen eine Erinnerung an den Signierer gesendet werden soll; Max. 30 Tage
Dokument-ID
 document_id True string

Dokument-ID aus Dokumentgruppe
Weiterleitung zulassen
 allow_forwarding boolean

Gibt an, ob Empfänger diese Einladung einer anderen E-Mail-Adresse zuweisen dürfen. Mögliche Werte: False - nicht zulässig. True - zulässig.
Ablehnen nach Signatur zulassen
 decline_by_signature boolean

Definiert, ob die Option "Zum Signieren ablehnen" in Signaturfeldern angezeigt werden soll. True: Die Option "Ablehnen" anzeigen; False: Ausblenden der Option "Ablehnen"

Gibt zurück

Name Pfad Typ Beschreibung
Der Status
 status string

Status des Empfängeraustauschs

Ersetzen von Empfängern in Dokumentseinladung

Vorgangs-ID:
ReplaceRecipientsInDocumentInvite

Diese Aktion ersetzt Empfänger in der Dokumentseinladung basierend auf ihren Rollen. Es ermöglicht außerdem das Aktualisieren von Einladungseinstellungen wie Authentifizierungstyp, Ablauftage und anderen erweiterten Parametern für jede Rolle.

Parameter

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

Dokument-ID
Rolle
 role True string

Rollenname des zu ersetzenden Empfängers
Neue E-Mail
 email True string

Neue Empfänger-E-Mail
Rolle
 role True string

Rollenname, der zusätzliche Einladungsparameter erfordert
Ablauftage
 expiration_days integer

In wie vielen Tagen die Einladung abläuft. Max. 30 Tage
Ablehnen nach Signatur zulassen
 decline_by_signature boolean

Definiert, ob die Option "Zum Signieren ablehnen" in Signaturfeldern angezeigt werden soll. True: Die Option "Ablehnen" anzeigen; False: Ausblenden der Option "Ablehnen"
Erinnerung
 reminder integer

In wie vielen Tagen eine Erinnerung an den Empfänger gesendet werden soll. Max. 30 Tage
Authentifizierungstyp
 authentication_type string

Authentifizierungstyp, der während der Signatursitzung für die Empfängerauthentifizierung verwendet wird. Zulässige Werte: "Kennwort", "Telefonanruf" und "Sms"
Authentifizierungskennwort
 authentication_password string

Kennwortsatz für die Signiererauthentifizierung. Erforderlich für den Authentifizierungstyp "Kennwort"
Authentifizierungstelefon
 authentication_phone string

Zum Authentifizieren des Signierers verwendete Telefonnummer. Erforderlich für den Authentifizierungstyp "Telefonanruf" und "Sms". Beispiel: +1XXXXXXXXXXX
Sms-Nachricht für die Authentifizierung
 authentication_sms_message string

Benutzerdefinierte SMS-Nachricht, die an den Signierer gesendet wird, der den Platzhalter "{password}" enthält. Wird mit dem Authentifizierungstyp "SMS" verwendet. Ohne diesen Parameter empfängt der Signierer eine Standard-SMS mit einem automatisch generierten Kennwort (Entsperrcode) – "SignNow-Dokumenteinladungssperrcode: 123456". Beispiel: Geben Sie das Kennwort "{password}" ein, um Ihr Dokument zu entsperren.

Gibt zurück

Name Pfad Typ Beschreibung
Ersatz
 replacements array of object

Details der neuen Empfänger
Neue Einladungs-ID
 replacements.new_invite_id string

Die neue Feld-Einladungs-ID
Rolle
 replacements.role string

Rollenname des Empfängers, der ersetzt wurde
Neue E-Mail
 replacements.new_email string

Neue Empfänger-E-Mail

Erstellen einer Dokumentgruppe aus der Gruppenvorlage

Vorgangs-ID:
CreateFromTemplateGroup

Erstellen der Dokumentgruppe aus einer ausgewählten Gruppenvorlage

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Gruppenvorlage
 doc_group_id True string

Auswählen der Gruppenvorlage aus der Liste
Dokumentgruppenname
 group_name string

Neuen Namen für die Dokumentgruppe eingeben

Gibt zurück

Name Pfad Typ Beschreibung
Dokumentgruppen-ID
 id DocumentGroupId

Eindeutige Dokumentgruppen-ID

Feldwerte für dokumentgruppenvorfüllen

Vorgangs-ID:
UpdateGroupFieldValues

Automatisches Auffüllen von ausfüllbaren Feldern in den Dokumenten mit bestimmten Werten

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Template
 template_group_id True string

Angeben einer Dokumentgruppenvorlage zum Abrufen von Feldern aus
Dokumentgruppen-ID
 doc_group_id True string

Angeben einer eindeutigen Dokumentgruppen-ID
fields
 fields dynamic

Gibt zurück

Name Pfad Typ Beschreibung
Dokumentgruppen-ID
 id DocumentGroupId

Eindeutige Dokumentgruppen-ID
Vorgangs-ID:
GenerateEmbeddedInviteLink

Diese Aktion generiert einen Link für die eingebettete Einladung des Dokuments.

Parameter

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

Dokument-ID
Feld-Einladungs-ID
 field_invite_id True string

Eingebettete Einladungs-ID aus der Aktion "Eingebettete Einladung für Dokument erstellen"
Ablauf des Links
 link_expiration integer

Gibt an, wie viele Minuten der Link aktiv bleibt. Gültiger Bereich:15-45 Minuten
Sitzungsablauf
 session_expiration integer

Gibt an, wie viele Minuten die Signiersitzung aktiv bleibt. Gültiger Bereich:15-1440 Minuten

Gibt zurück

Name Pfad Typ Beschreibung
Link
 data.link string

Generierter eingebetteter Einladungslink für das Dokument
Vorgangs-ID:
GenerateDocGroupEmbeddedInviteLink

Diese Aktion generiert einen Link für die eingebettete Einladung für die Dokumentgruppe.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Dokumentgruppen-ID
 id True string

Dokumentgruppen-ID
Eingebettete Einladungs-ID der Dokumentgruppe
 invite_id True string

ID der eingebetteten Einladung der Dokumentgruppe aus der Aktion "Eingebettete Einladung für Dokumentgruppe erstellen"
Email
 email True email

E-Mail-Adresse des Empfängers
Ablauf des Links
 link_expiration integer

Gibt an, wie viele Minuten der Link aktiv bleibt. Gültiger Bereich:15-45 Minuten
Sitzungsablauf
 session_expiration integer

Gibt an, wie viele Minuten die Signiersitzung aktiv bleibt. Gültiger Bereich:15-1440 Minuten

Gibt zurück

Name Pfad Typ Beschreibung
Eingebetteter Einladungslink
 link string

Der Link für eingebettete Einladungen für Dokumentgruppen
Vorgangs-ID:
CreateEmbeddedInviteSettingsLink

Diese Aktion generiert einen eingebetteten Sendelink für ein bestimmtes Dokument, sodass Benutzer von Drittanbietern das Dokument für die Signatur vorbereiten und senden können.

Parameter

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

Dokument-ID
Typ
 type string

Gibt den Sendeschritt an, an dem der Link geöffnet werden soll. Mögliche Werte: "Einladung": öffnet die Seite "Einladung senden" für das Dokument, auf der der Benutzer Signierer-E-Mails, Betreff, Nachricht usw. hinzufügen kann: Öffnet das Dokument im Editor, um ausfüllbare Felder hinzuzufügen, und öffnet dann die Seite "Einladung senden"
Umleitungs-URI
 redirect_uri string

Die Seite, die geöffnet wird, nachdem das eingebettete Senden eingerichtet wurde. Erforderlich, wenn "Umleitungsziel" hinzugefügt wird
Ablauf des Links
 link_expiration integer

Gibt an, wie viele Minuten der Link aktiv bleibt. Der zulässige Bereich: 15 bis 45 Minuten. Benutzer auf Administratorebene können die Dauer bis zu maximal 43200 Minuten festlegen.
Umleitungsziel
 redirect_target string

Bestimmt, ob der Umleitungs-URI in einer neuen Registerkarte im Browser oder auf derselben Registerkarte nach der Signierungssitzung geöffnet werden soll. Mögliche Werte: "Auf der neuen Registerkarte" – öffnet den Link auf einer neuen Registerkarte "In derselben Registerkarte" – öffnet den Link auf derselben Registerkarte.

Gibt zurück

Name Pfad Typ Beschreibung
URL
 url string

Der Link zum sendenden eingebetteten Dokument
Vorgangs-ID:
CreateDocGroupEmbeddedInviteSettingsLink

Diese Aktion generiert einen eingebetteten Sendelink für eine bestimmte Dokumentgruppe, sodass Benutzer von Drittanbietern die Dokumentgruppe für die Signatur vorbereiten und senden können.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Dokumentgruppen-ID
 id True string

Dokumentgruppen-ID
Typ
 type string

Gibt den Sendeschritt an, an dem der eingebettete Link geöffnet werden soll: "verwalten" – öffnet den Link auf der Seite "Dokumente zur Dokumentgruppe hinzufügen". "bearbeiten": öffnet den Link im Editor; "send-invite": Öffnet den Link auf der Seite "Einladung senden"
Umleitungs-URI
 redirect_uri string

Die Seite, die geöffnet wird, nachdem das eingebettete Senden eingerichtet wurde. Erforderlich, wenn "Umleitungsziel" hinzugefügt wird
Ablauf des Links
 link_expiration integer

Gibt an, wie viele Minuten der Link aktiv bleibt. Der zulässige Bereich: 15 bis 45 Minuten. Benutzer auf Administratorebene können die Dauer bis zu maximal 43200 Minuten festlegen.
Umleitungsziel
 redirect_target string

Bestimmt, ob der Umleitungs-URI in einer neuen Registerkarte im Browser oder auf derselben Registerkarte nach der Signierungssitzung geöffnet werden soll. Mögliche Werte: "Auf der neuen Registerkarte" – öffnet den Link auf einer neuen Registerkarte "In derselben Registerkarte" – öffnet den Link auf derselben Registerkarte.

Gibt zurück

Name Pfad Typ Beschreibung
URL
 url string

Der Link zur gesendeten eingebetteten Dokumentgruppe
Vorgangs-ID:
CreateSigningLink

Generieren eines Links zum Dokument und Freigeben des Dokuments, damit das Dokument signiert ist

Parameter

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

Angeben einer eindeutigen Dokument-ID oder Auswählen eines Dokuments aus der Liste
fields
 fields dynamic

Gibt zurück

Name Pfad Typ Beschreibung
URL
 url_no_signup string

Signierungslink

Veraltet – Einladung zum Signieren der Dokumentgruppe

Vorgangs-ID:
SendGroupInvite

Die Aktion ist veraltet. Einladen anderer Personen zum Ausfüllen und Abmelden der Dokumentgruppe

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Template
 template True boolean

Geben Sie an, ob Dokumentgruppen oder Gruppenvorlagen abgerufen werden sollen.
Dokumentgruppe
 template_group_id True string

Auswählen der Dokumentgruppe aus der Liste
body
 body True dynamic

Gibt zurück

response
object

Veraltet – Erweiterte Dokumenteinladung

Vorgangs-ID:
SendUserDefinedInvite

Die Aktion ist veraltet. Einladungsanforderung mit manuell definierten Schemas. Es ermöglicht das Einrichten von Einladungen für ein Dokument, das in Zukunft generiert wird.

Parameter

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

Bereitstellen einer Dokument-ID
Name
 role string

Rollenname des Signierers
E-Mail
 email email

Angeben von E-Mail für den Signierer
Telefonnummer (Per SMS einladen)
 phone_invite string

Geben Sie die Telefonnummer des Empfängers +XXXXXXXXXX an. Erforderlich für Einladung per SMS.
Bestellung
 order integer

Festlegen der Reihenfolge der Signierung für mehrere Signierer
Personalisiertes Thema
 subject string

Hinzufügen eines personalisierten Betreffs für den Signierer
Personalisierte Nachricht
 message string

Hinzufügen einer personalisierten Nachricht für den Signierer
Authentifizierungsart
 authentication_type string

Überprüfen der Benutzeridentität über Kennwort, SMS oder Telefonanruf
Kennwort
 password string

Festlegen des Kennworts für das Kennwort für den Authentifizierungstyp "Kennwort"
Telefonnummer
 phone string

Geben Sie die +XXXXXXXXXXXX-Telefonnummer für den Authentifizierungstyp "Telefon" oder "SMS" an.
Tage bis Ablauf
 expiration_days integer

Abrufen der Benachrichtigung über die Anzahl der Tage, an der die Einladung abläuft
Erinnerung senden in
 reminder integer

Die Anzahl der Tage nach dem Senden der Einladung zur automatischen Nachverfolgung mit einer E-Mail-Erinnerung
Erinnerung alle X Tage senden
 remind_repeat integer

Der Empfänger erhält jede festgelegte Anzahl von Tagen eine Erinnerungs-E-Mail.
Weiterleitung zulassen
 reassign boolean

Zulassen, dass der Signierer die Signatur an eine andere Person delegieren kann
Ablehnen bei Signatur anzeigen
 decline_by_signature boolean

Stempeln eines Signaturfelds als "Ablehnen zum Signieren", wenn der Empfänger die Signatur des Dokuments abgelehnt hat
CC
 cc string

Eine durch Trennzeichen getrennte E-Mails, die in der Einladung kopiert werden
Betreff
 subject string

Geben Sie Ihren Betreff ein.
Nachricht
 message string

Geben Sie Ihre Nachricht ein.
E-Mail an alle Parteien nach Abschluss
 on_complete string

Alle Parteien erhalten eine Benachrichtigungs-E-Mail, wenn das Dokument signiert ist.

Gibt zurück

response
object

Veraltet – Zum Signieren einladen

Vorgangs-ID:
SendInvite

Die Aktion ist veraltet. Einladen anderer Personen zum Ausfüllen und Abmelden des Dokuments

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Template
 template True boolean

Angeben, ob Dokumente oder Vorlagen abgerufen werden sollen
Dokument
 template_id True string

Auswählen einer Vorlage aus der Liste
body
 body True dynamic

Gibt zurück

response
object

Vorfüllen intelligenter Feldwerte

Vorgangs-ID:
PrefillSmartFields

Vorfüllen von Smart Field-Werten für das angegebene Dokument

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Template
 template_id True string

Angeben einer Dokumentvorlage zum Abrufen von Feldern aus
Dokument-ID
 doc_id True string

Angeben einer eindeutigen Dokument-ID
fields
 fields dynamic

Vorfüllen von Dokumentfeldwerten (Vorschau)

Vorgangs-ID:
UpdateFieldValues_V2

Automatisches Auffüllen von ausfüllbaren Feldern im Dokument mit bestimmten Werten

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Template
 template_id True string

Angeben einer Dokumentvorlage zum Abrufen von Feldern aus
Dokument-ID
 doc_id True string

Angeben einer eindeutigen Dokument-ID
fields
 fields dynamic

Gibt zurück

Name Pfad Typ Beschreibung
Dokument-ID
 id DocumentId

Eindeutige Dokument-ID

Vorfüllen von Dokumentfeldwerten [VERALTET]

Vorgangs-ID:
UpdateFieldValues

Diese Aktion ist veraltet. Verwenden Sie stattdessen die Werte für das Vorfüllen des Dokumentfelds .

Vorfüllen von Feldwerten und Eigenschaften.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Template
 template_id True string

Angeben einer Dokumentvorlage zum Abrufen von Feldern aus
Dokument-ID
 doc_id True string

Angeben einer eindeutigen Dokument-ID
fields
 fields dynamic

Gibt zurück

Name Pfad Typ Beschreibung
Dokument-ID
 id DocumentId

Eindeutige Dokument-ID

Vorfüllen von Intelligenten Feldwerten für die Dokumentgruppe

Vorgangs-ID:
UpdateGroupSmartFieldValues

Automatisches Auffüllen von intelligenten Feldern in den Dokumenten mit bestimmten Werten

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Template
 template_group_id True string

Angeben einer Dokumentgruppenvorlage zum Abrufen von Feldern aus
Dokumentgruppen-ID
 doc_group_id True string

Angeben einer eindeutigen Dokumentgruppen-ID
fields
 fields dynamic

Gibt zurück

Name Pfad Typ Beschreibung
Dokumentgruppen-ID
 id DocumentGroupId

Eindeutige Dokumentgruppen-ID

Zum Signieren der Dokumentgruppe einladen

Vorgangs-ID:
InviteToSignDocGroupAllOptions

Diese Aktion erstellt eine Einladung zum Signieren einer Dokumentgruppe. Sie können einen mehrstufigen Workflow konfigurieren, bei dem unterschiedliche Empfänger in verschiedenen Phasen auf die Dokumentgruppe reagieren.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Dokumentgruppen-ID
 id True string

Dokumentgruppen-ID
Bestellung
 order True integer

Reihenfolge des Signierschritts: 1 – Der Empfänger signiert zuerst die Dokumentgruppe, dann wird die Dokumentgruppe an 2,3 usw. gesendet. Mehrere Empfänger können dieselbe Reihenfolge der Signatur enthalten
Email
 email string

E-Mail-Adresse des Empfängers
E-Mail-Gruppe
 email_group string

Eine Kontaktgruppe von Empfängern
Rollenname
 role_name True string

Name der Empfängerrolle im Dokument (kann verwendet werden, um Felder im Dokument zu identifizieren, die diesem bestimmten Empfänger zugewiesen sind)
Maßnahme
 action True string

Zulässige Aktion mit einem Dokument. Mögliche Werte: Anzeigen, Signieren, Genehmigen
Dokument-ID
 document_id True string

ID des Dokuments, für das Aktionen von diesem Empfänger erforderlich sind
Erforderlicher voreingestellter Signaturname
 required_preset_signature_name string

Vorgefüllter Text für das Signaturfeld, gesperrt für die Bearbeitung durch den Empfänger
Weiterleitung zulassen
 allow_reassign boolean

Definiert, ob der Empfänger die Einladung an eine andere E-Mail-Adresse weiterleiten kann. "true": Der Empfänger kann die Einladung weiterleiten; 'false': Der Empfänger kann die Einladung nicht weiterleiten.
Ablehnen nach Signatur zulassen
 decline_by_signature boolean

Definiert, ob die Option "Zum Signieren ablehnen" in Signaturfeldern angezeigt werden soll. True: Die Option "Ablehnen" anzeigen; False: Ausblenden der Option "Ablehnen"
Authentifizierungstyp
 type string

Authentifizierungstyp, der während der Signatursitzung für die Empfängerauthentifizierung verwendet wird. Zulässige Werte: "Kennwort", "Telefonanruf" und "Sms"
Kennwort
 value string

Kennwortsatz für die Signiererauthentifizierung. Erforderlich für den Authentifizierungstyp "Kennwort"
Telefonnummer
 phone string

Zum Authentifizieren des Signierers verwendete Telefonnummer. Erforderlich für den Authentifizierungstyp "Telefonanruf" und "Sms". Beispiel: +1XXXXXXXXXXX
Nachricht
 message string

Benutzerdefinierte SMS-Nachricht, die an den Signierer gesendet wird, der den Platzhalter "{password}" enthält. Wird mit dem Authentifizierungstyp "SMS" verwendet. Ohne diesen Parameter empfängt der Signierer eine Standard-SMS mit einem automatisch generierten Kennwort (Entsperrcode) – "SignNow-Dokumenteinladung entsperrungscode: 123456"
MerchantId
 merchant_id string

Die ID des Händlerkontos, das Ihrer Organisation hinzugefügt wurde
Währung
 currency string

Die angeforderte Zahlungswährung
Betrag
 amount string

Der angeforderte Zahlungsbetrag
Uri
 redirect_uri string

Wenn alle angeforderten Felder abgeschlossen und signiert sind, wird der Signierer an diesen URI umgeleitet.
Umleitungsziel
 redirect_target string

Bestimmt, ob der Umleitungs-URI in einer neuen Registerkarte im Browser oder auf derselben Registerkarte nach der Signierungssitzung geöffnet werden soll. Mögliche Werte: "Auf der neuen Registerkarte" – öffnet den Link auf einer neuen Registerkarte "In derselben Registerkarte" – öffnet den Link auf derselben Registerkarte.
Umleitungs-URI ablehnen
 decline_redirect_uri string

Der Link, der geöffnet wird, nachdem das Dokument vom Empfänger abgelehnt wurde
Umleitungs-URI schließen
 close_redirect_uri string

Der Link, der geöffnet wird, wenn ein Signierer während einer Signierungssitzung auf "Fortschritt speichern" und "Später beenden" klickt oder im Ansichtsmodus schließen
Is Finish Redirect Canceled
 is_finish_redirect_canceled boolean

Gibt an, ob die Einstellung für die Vervollständigungsumleitung für die Organisation abgebrochen wird. True – die Umleitung wird abgebrochen; False – die Umleitung bleibt aktiv
Die Umleitung wird geschlossen.
 is_close_redirect_canceled boolean

Gibt an, ob die Einstellung für die Speicherstatusumleitung für die Organisation abgebrochen wird. True – die Umleitung wird abgebrochen; False – die Umleitung bleibt aktiv
Abgelehnte Umleitung abgebrochen
 is_decline_redirect_canceled boolean

Gibt an, ob die Einstellung für die Ablehnungsumleitung für die Organisation abgebrochen wird. True – die Umleitung wird abgebrochen; False – die Umleitung bleibt aktiv
Language
 language string

Gibt die Sprache der Signatursitzung und Benachrichtigungs-E-Mails für den Signierer an. Mögliche Werte: En für Englisch, Es für Spanisch und Fr für Französisch. Wenn nicht festgelegt, wird die Sprache durch die Sprache Ihres SignNow-Kontos bestimmt.
Bestellung
 order True integer

Reihenfolge des Signierschritts: 1 – Der Empfänger signiert zuerst die Dokumentgruppe, dann wird die Dokumentgruppe an 2,3 usw. gesendet. Mehrere Empfänger können dieselbe Reihenfolge der Signatur enthalten
Email
 email True string

E-Mail-Adresse des Empfängers
E-Mail-Gruppe
 email_group string

Eine Kontaktgruppe von Empfängern
Betreff
 subject string

Benutzerdefinierter E-Mail-Betreff für den Empfänger
Nachricht
 message string

Benutzerdefinierte E-Mail-Nachricht für den Empfänger
Tage bis Ablauf
 expiration_days integer

In x Tagen läuft die Einladung ab (von 3 bis 180 Tagen)
Erinnerung in X Tagen senden
 remind_after integer

X Tage nach der Einladung erhält ein Reepient eine Erinnerungs-E-Mail (von 1 bis 179 Tagen). Muss kleiner als Ablauftage sein
Erinnerung in X Tagen vor Ablauf senden
 remind_before integer

X Tage vor Ablauf erhält ein Recepient eine Erinnerungs-E-Mail (von 1 bis 179 Tagen). Muss kleiner als Ablauftage sein
Erinnerung alle X Tage senden
 remind_repeat integer

Ein Reepient erhält jede x Tage nach dem Senden der Einladung eine Erinnerungs-E-Mail (von 1 bis 7 Tagen)
Id
 id string

ID einer E-Mail-Gruppe. Ein eindeutiger 40-stellige Bezeichner, der vorher erstellt werden muss
Name
 name string

Ein Name der Gruppe. Verwenden Sie sie in der E-Mail-Gruppe "Einladungsschritte > "
Email
 email string

E-Mail-Adresse, die eine Einladung erhalten soll
Email
 email string

E-Mail-Adresse des Empfängers, der die Abschluss-E-Mail erhält
Dokumentanlage deaktivieren
 disable_document_attachment boolean

Gibt an, ob das Senden von Dokumentanlagen mit der Abschluss-E-Mail deaktiviert werden soll. Mögliche Werte: False - Dokumentanlage aktivieren, True - Dokumentanlage deaktivieren
Betreff
 subject string

Benutzerdefinierter Betreff für die Abschluss-E-Mail
Nachricht
 message string

Benutzerdefinierte Nachricht für die Abschluss-E-Mail
Sign As Merged
 sign_as_merged boolean

Wenn wahr, ermöglicht api-Benutzer das Senden einer Einladung, die als zusammengeführte Dokumentgruppe in einem einzelnen Dokument geöffnet wird
Clientzeitstempel
 client_timestamp integer

Der Zeitstempel der Dokumentgruppen-Einladung
Email
 email string

E-Mail-Adresse, die eine Einladung erhalten soll
QES-Signatur
 signature string

Typ von QES. Mögliche Werte: 'Eideasy', 'Nom151'. Wird verwendet, um QES-Signaturen von Signierern anzufordern. Alle Signierer in der Einladung müssen denselben Signaturtyp verwenden. Um eine Einladung mit QES zu erstellen, muss der Benutzer zu einer Organisation gehören, für die QES aktiviert ist.

Gibt zurück

Name Pfad Typ Beschreibung
Id
 id string

Dokumentgruppen-Einladungs-ID
Ausstehender Einladungslink
 pending_invite_link string

Ausstehender Einladungslink

Zum Signieren des Dokuments einladen

Vorgangs-ID:
InviteToSignAllOptions

Diese Aktion erstellt und sendet eine Feldseinladung für ein zu signiertes Dokument.

Parameter

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

Dokument-ID
Email
 email string

E-Mail-Adresse des Empfängers
E-Mail-Gruppe
 email_group string

Eine Gruppe von Benutzern, die die Einladung erhalten sollen. Wenn einer der Benutzer das Dokument signiert, wird es als abgeschlossen betrachtet. Muss mit dem erweiterten Parameter "E-Mail-Gruppen" verwendet werden. Erforderlich, wenn "E-Mail" oder "Telefon-Einladung" nicht hinzugefügt wird, aber nicht gleichzeitig mit einem dieser Parameter verwendet werden kann
Telefon einladen
 phone_invite string

Telefonnummer des Empfängers. Erforderlich für Einladung per SMS
Rolle
 role True string

Name der Empfängerrolle. z. B. Signierer 1, Signierer 2
Bestellung
 order True integer

Reihenfolge der Signierung. Die Signierreihenfolge definiert die Reihenfolge, in der Empfänger ein Dokument signieren oder ausfüllen müssen. Sobald alle Empfänger in einem Bestellschritt die Signierung abgeschlossen haben, fährt das Dokument mit dem nächsten Bestellschritt fort (z. B. 2, 3). Mehrere Empfänger können dieselbe Signierreihenfolge gemeinsam nutzen.
Rolle
 role True string

Name der Empfängerrolle, der für die Zuordnung erweiterter Parameter verwendet wird
Vorfüllen des Signaturnamens
 prefill_signature_name string

Vorab ausgefüllter Text im Signaturfeld, verfügbar für die Bearbeitung durch den Signierer
Erforderlicher voreingestellter Signaturname
 required_preset_signature_name string

Vorgefüllter Text für das Signaturfeld, gesperrt für die Bearbeitung durch den Empfänger. Kann nicht mit dem Namen der Vorausfüllsignatur oder 'Neue Signatur erforderlich' verwendet werden.
Neue Signatur anfordern
 force_new_signature boolean

Definiert, ob der Signierer eine gespeicherte Signatur verwenden kann. False – Signierer kann eine gespeicherte Signatur verwenden; True – Signierer muss eine neue Signatur erstellen
Weiterleitung zulassen
 reassign boolean

Definiert, ob der Empfänger die Einladung an eine andere E-Mail-Adresse weiterleiten kann. "true": Der Empfänger kann die Einladung weiterleiten; 'false': Der Empfänger kann die Einladung nicht weiterleiten.
Ablehnen nach Signatur zulassen
 decline_by_signature boolean

Definiert, ob die Option "Zum Signieren ablehnen" in Signaturfeldern angezeigt werden soll. True – Zeigt die Option "Ablehnen" an; false – Ausblenden der Option "Ablehnen"
Erinnerung in X Tagen senden
 remind_after integer

X Tage nach der Einladung erhält ein Reepient eine Erinnerungs-E-Mail (von 1 bis 179 Tagen). Muss kleiner als "Tage bis zum Ablauf" sein.
Erinnerung in X Tagen vor Ablauf senden
 remind_before integer

X Tage vor Ablauf erhält ein Recepient eine Erinnerungs-E-Mail (von 1 bis 179 Tagen). Muss kleiner als "Tage bis zum Ablauf" sein.
Erinnerung alle x Tage senden
 remind_repeat integer

Ein Reepient erhält jede x Tage nach dem Senden der Einladung eine Erinnerungs-E-Mail (von 1 bis 7 Tagen)
Tage bis Ablauf
 expiration_days integer

In X Tagen läuft die Einladung ab (von 3 bis 180 Tagen)
Authentifizierungstyp
 authentication_type string

Authentifizierungstyp, der während der Signatursitzung für die Empfängerauthentifizierung verwendet wird. Zulässige Werte: "Kennwort", "Telefonanruf" und "Sms"
Authentifizierungskennwort
 password string

Kennwortsatz für die Signiererauthentifizierung. Erforderlich für den Authentifizierungstyp "Kennwort"
Authentifizierungstelefon
 phone string

Zum Authentifizieren des Signierers verwendete Telefonnummer. Erforderlich für den Authentifizierungstyp "Telefonanruf" und "Sms". Beispiel: +1XXXXXXXXXXX
Sms-Nachricht für die Authentifizierung
 authentication_sms_message string

Benutzerdefinierte SMS-Nachricht, die an den Signierer gesendet wird, der den Platzhalter "{password}" enthält. Wird mit dem Authentifizierungstyp "SMS" verwendet. Ohne diesen Parameter empfängt der Signierer eine Standard-SMS mit einem automatisch generierten Kennwort (Entsperrcode) – "SignNow-Dokumenteinladungssperrcode: 123456". Beispiel: Geben Sie das Kennwort "{password}" ein, um Ihr Dokument zu entsperren.
Betreff
 subject string

Benutzerdefinierter E-Mail-Betreff für den Empfänger
Nachricht
 message string

Benutzerdefinierte E-Mail-Nachricht für den Empfänger
Umleitungs-URI
 redirect_uri string

Wenn alle angeforderten Felder abgeschlossen und signiert sind, wird der Signierer an diesen URI umgeleitet.
Umleitungsziel
 redirect_target string

Bestimmt, ob der Umleitungs-URI in einer neuen Registerkarte im Browser oder auf derselben Registerkarte nach der Signierungssitzung geöffnet werden soll. Mögliche Werte: "Auf der neuen Registerkarte" – öffnet den Link auf einer neuen Registerkarte "In derselben Registerkarte" – öffnet den Link auf derselben Registerkarte.
Umleitungs-URI ablehnen
 decline_redirect_uri string

Der Link, der geöffnet wird, nachdem das Dokument vom Empfänger abgelehnt wurde
Umleitungs-URI schließen
 close_redirect_uri string

Der Link, der geöffnet wird, wenn der Empfänger während einer Signiersitzung auf "Fortschritt speichern" und "Später beenden" klickt oder im Ansichtsmodus schließen
Is Finish Redirect Canceled
 is_finish_redirect_canceled boolean

Gibt an, ob die Einstellung für die Vervollständigungsumleitung für die Organisation abgebrochen wird. True – die Umleitung wird abgebrochen; False – die Umleitung bleibt aktiv
Die Umleitung wird geschlossen.
 is_close_redirect_canceled boolean

Gibt an, ob die Einstellung für die Speicherstatusumleitung für die Organisation abgebrochen wird. True – die Umleitung wird abgebrochen; False – die Umleitung bleibt aktiv
Abgelehnte Umleitung abgebrochen
 is_decline_redirect_canceled boolean

Gibt an, ob die Einstellung für die Ablehnungsumleitung für die Organisation abgebrochen wird. True – die Umleitung wird abgebrochen; False – die Umleitung bleibt aktiv
Language
 language string

Gibt die Sprache der Signatursitzung und Benachrichtigungs-E-Mails für den Signierer an. Mögliche Werte: En für Englisch, Es für Spanisch und Fr für Französisch. Wenn nicht festgelegt, wird die Sprache durch die Sprache Ihres SignNow-Kontos bestimmt.
Email
 email True string

E-Mail-Adresse des Viewers
Rolle
 role True string

Anzeigerollenname
Bestellung
 order True integer

Ganze Zahl: die Reihenfolge des Sendens ab 1
Rolle
 role True string

Name der Viewerrolle. Wird für die Zuordnung erweiterter Parameter verwendet
Betreff
 subject string

Benutzerdefinierter E-Mail-Betreff für den Viewer
Nachricht
 message string

Benutzerdefinierte E-Mail-Nachricht für den Viewer
Email
 email True string

E-Mail-Adresse der Genehmigende Person
Rolle
 role True string

Rollenname der Genehmigende Person
Bestellung
 order True integer

Der Auftrag, die Genehmigungsanforderung zu erhalten
Rolle
 role True string

Rollenname der Genehmigende Person. Wird für die Zuordnung erweiterter Parameter verwendet
Ablauftage
 expiration_days integer

Anzahl der Tage vor Ablauf der Einladung
Nachricht
 message string

Benutzerdefinierte E-Mail-Nachricht für die genehmigende Person
Betreff
 subject string

Benutzerdefinierter E-Mail-Betreff für die genehmigende Person
Authentifizierungstyp
 authentication_type string

Authentifizierungstyp, der während der Signatursitzung für die Empfängerauthentifizierung verwendet wird. Zulässige Werte: "Kennwort", "Telefonanruf" und "Sms"
Kennwort
 password string

Kennwortsatz für die Signiererauthentifizierung. Erforderlich für den Authentifizierungstyp "Kennwort"
Telefonnummer
 phone string

Zum Authentifizieren des Signierers verwendete Telefonnummer. Erforderlich für den Authentifizierungstyp "Telefonanruf" und "Sms". Beispiel: +1XXXXXXXXXXX
Sms-Nachricht für die Authentifizierung
 authentication_sms_message string

Benutzerdefinierte SMS-Nachricht, die an den Signierer gesendet wird, der den Platzhalter "{password}" enthält. Wird mit dem Authentifizierungstyp "SMS" verwendet. Ohne diesen Parameter empfängt der Signierer eine Standard-SMS mit einem automatisch generierten Kennwort (Entsperrcode) – "SignNow-Dokumenteinladungssperrcode: 123456". Beispiel: Geben Sie das Kennwort "{password}" ein, um Ihr Dokument zu entsperren.
Umleitungs-URI
 redirect_uri string

Die URL, die geöffnet wird, nachdem der Genehmigende das Dokument genehmigt hat
Umleitungsziel
 redirect_target string

Bestimmt, ob der Umleitungs-URI in einer neuen Registerkarte im Browser oder auf derselben Registerkarte nach der Signierungssitzung geöffnet werden soll. Mögliche Werte: "Auf der neuen Registerkarte" – öffnet den Link auf einer neuen Registerkarte "In derselben Registerkarte" – öffnet den Link auf derselben Registerkarte.
Von
 from string

E-Mail-Adresse des Absenders. Es kann nur die E-Mail verwendet werden, die Ihrem SignNow-Konto (Anmelde-E-Mail) zugeordnet ist. Wenn sie leer gelassen wird, wird sie automatisch festgelegt.
ID
 id string

ID einer E-Mail-Gruppe. Ein eindeutiger 40-stellige Bezeichner, der vorher erstellt werden muss
Name
 name string

Ein Name der Gruppe. Verwenden sie im Feld "E-Mail-Gruppe signieren > "
Email
 email string

E-Mail-Adresse, die eine Einladung erhalten soll
Email
 email string

E-Mail-Adresse, die eine Einladung erhalten soll
Name
 name string

Name des Schritts
Email
 email string

CC-Empfänger-E-Mail-Adresse
Schritt
 step integer

Die Reihenfolge des Versands ab 1
Betreff
 subject string

E-Mail-Betreff für alle Empfänger
Nachricht
 message string

E-Mail-Nachricht für alle Empfänger
CC-Betreff
 cc_subject string

CC-E-Mail-Betreff für alle CC-Empfänger
CC-Nachricht
 cc_message string

CC-E-Mail-Nachricht für alle CC-Empfänger
QES-Signatur
 signature string

Typ von QES. Mögliche Werte: 'Eideasy', 'Nom151'. Wird verwendet, um QES-Signaturen von Signierern anzufordern. Alle Signierer in der Einladung müssen denselben Signaturtyp verwenden. Um eine Einladung mit QES zu erstellen, muss der Benutzer zu einer Organisation gehören, für die QES aktiviert ist.

Gibt zurück

Name Pfad Typ Beschreibung
Der Status
 status string

Der Status

Auslöser

Startfluss für Dokumentereignis (Vorschau)

Wählen Sie das Ereignis aus, das ausgelöst werden soll: die neue oder aktualisierte Signaturseinladung; wenn jemand ein Dokument erstellt, aktualisiert, abgeschlossen oder löscht
Startfluss für Dokumentereignis [DEPRECATED]

Diese Aktion ist veraltet. Verwenden Sie stattdessen den Startablauf für das Dokumentereignis .

Sie können einen Trigger für eins dieses Ereignis erstellen: Dokumenterstellung, Dokumentaktualisierung, Dokumentlöschung, Dokumentlöschung, Dokumentvervollständigen, Einladungserstellung, Einladungsaktualisierung

Startfluss für Dokumentereignis (Vorschau)

Vorgangs-ID:
Triggers_V2

Wählen Sie das Ereignis aus, das ausgelöst werden soll: die neue oder aktualisierte Signaturseinladung; wenn jemand ein Dokument erstellt, aktualisiert, abgeschlossen oder löscht

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Event
 event True string

Select-Ereignis, das den Flow auslösen soll

Gibt zurück

Name Pfad Typ Beschreibung
Event
 meta.event string

Dokumentereignis, das den Trigger verursacht hat.
Dokument-ID
 content.document_id string

Eindeutige ID des Zieldokuments, das das Ereignis verursacht hat.
Dokumentname
 content.document_name string

Name der Zieldokumentdatei ohne Erweiterung

Startfluss für Dokumentereignis [DEPRECATED]

Vorgangs-ID:
Triggers

Diese Aktion ist veraltet. Verwenden Sie stattdessen den Startablauf für das Dokumentereignis .

Sie können einen Trigger für eins dieses Ereignis erstellen: Dokumenterstellung, Dokumentaktualisierung, Dokumentlöschung, Dokumentlöschung, Dokumentvervollständigen, Einladungserstellung, Einladungsaktualisierung

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Event
 event True string

Wählen Sie ein Ereignis aus, das den Flow auslösen soll.

Gibt zurück

Name Pfad Typ Beschreibung
Zeitstempel
 meta.timestamp integer

Datum und Uhrzeit des Auftretens des Ereignisses (Unix-Zeitstempelformat).
Event
 meta.event string

Dokumentereignis, das den Trigger verursacht hat.
Dokument-ID
 content.document_id string

Eindeutige ID des Zieldokuments, das das Ereignis verursacht hat.
Dokumentname
 content.document_name string

Name der Zieldokumentdatei ohne Erweiterung

Definitionen

DocumentProperties

Name Pfad Typ Beschreibung
Dokument-ID
 id DocumentId

Eindeutige Dokument-ID
Dokumentname
 document_name string

Dokumentdateiname ohne Erweiterung
Seitenanzahl
 page_count integer

Anzahl der Seiten im Dokument
Erstellt
 created integer

Datum und Uhrzeit der Erstellung des Dokuments im Unix-Timestamp-Format
Updated
 updated integer

Datum und Uhrzeit der Aktualisierung des Dokuments im Unix-Zeitstempelformat
Vorlagenname
 original_filename string

Vorlagendateiname mit Erweiterung (falls vorhanden)
Vorlagen-ID
 origin_document_id string

Vorlagendokument-ID (falls vorhanden)
Ist Vorlage
 template boolean

"true", wenn das Dokument eine Vorlage ist.
Dokumentstatus
 status string

Dokumentstatus

DocumentGroupsResponse

Name Pfad Typ Beschreibung
document_groups
 document_groups array of DocumentGroupProperties
Gesamtanzahl der Dokumentgruppen
 document_group_total_count integer

Die Gesamtzahl der Dokumentgruppen im SignNow-Konto

DocumentGroupProperties

Name Pfad Typ Beschreibung
Dokumentgruppen-ID
 group_id DocumentGroupId

Eindeutige Dokumentgruppen-ID
Dokumentgruppenname
 group_name string

Dokumentgruppenname
Dokumente
 documents array of DocumentGroupDocumentProperties

Dokumente

DocumentGroupDocumentProperties

Name Pfad Typ Beschreibung
Dokument-ID
 id DocumentId

Eindeutige Dokument-ID
Dokumentname
 document_name string

Dokumentdateiname ohne Erweiterung
Vorlagen-ID
 origin_document_id string

Vorlagendokument-ID (falls vorhanden)

CreateDocumentGroupFromFilesResponse

Name Pfad Typ Beschreibung
Dokumentgruppenname
 group_name string

Dokumentgruppenname
Dokumentgruppen-ID
 group_id string

Dokumentgruppen-ID
Urkunden
 documents array of object
Dokument-ID
 documents.id DocumentId

Eindeutige Dokument-ID
Dokumentname
 documents.name string

Dokumentname

DokumentID

Eindeutige Dokument-ID

Eindeutige Dokument-ID

Dokument-ID
string

DocumentGroupId

Eindeutige Dokumentgruppen-ID

Eindeutige Dokumentgruppen-ID

Dokumentgruppen-ID
string

Objekt

Dies ist der Typ 'object'.

binär

Dies ist der grundlegende Datentyp "binary".