SigningHub (Vorschau)

SigningHub von Ascertia bietet eine umfassende Suite für besonders vertrauenswürdige digitale Signaturen und Die Automatisierung von Dokumentenworkflows. Mit diesem Connector können Unternehmen Benutzer sicher authentifizieren, Dokumentsignaturanforderungen initiieren und End-to-End-Genehmigungszyklen verwalten. Um strenge globale Sicherheitsstandards zu erfüllen, stellt sie sicher, dass Ihre automatisierten Workflows rechtlich durchsetzbar, transparent und hochgradig sicher in Ihrer gesamten Organisation bleiben.

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: - 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: - US Government (GCC) - US Government (GCC High) - China Cloud betrieben von 21Vianet - US Department of Defense (DoD)

Kontakt
Name	Support
URL	https://www.signinghub.com/contact-us/
Email	support@ascertia.com

Connectormetadaten
Publisher	Ascertia Limited.
Publisher	Ascertia
StackOwner	SigningHub
BrandColor	#1C1C1C
IconBrandColor	#1C1C1C
Webseite	https://signinghub.com
Datenschutzrichtlinie	https://www.signinghub.com/privacy-policy
Kategorien	Inhalt und Dateien; Produktivität

SigningHub Connector

SigningHub bietet eine umfassende REST-API, mit der Organisationen digitale Dokumentsignierungsworkflows automatisieren und verwalten können. Mithilfe dieses Connectors können Sie SigningHub in Power Automate integrieren, um Dokumentgenehmigungsprozesse zu optimieren und Signieraktionen in benutzerdefinierten Workflows zu automatisieren.

Dieser Connector ermöglicht die Automatisierung von Dokumentsignierungs- und anderen SignHub-Aktionen direkt in Power Automate Flüssen und hilft Organisationen dabei, effiziente und sichere Dokumentworkflows zu erstellen.

Publisher: Ascertia

Voraussetzungen

Um diesen Connector zu verwenden, müssen Sie folgendes haben:

Ein aktives SigningHub-Konto (https://www.signinghub.com).
Eine gültige Integration , die in SigningHub definiert ist.

So erhalten Sie Anmeldeinformationen

Füllen Sie die Felder "Anmeldeformular" mit den folgenden Werten aus:

E-Mail: Die SigningHub-Konto-E-Mail.
Kennwort: Das SignaturHub-Kontokennwort.
API-Client-ID: Ascertia oder Ihr Unternehmensadministrator stellt die API-Client-ID bereit, um den Connector zu verwenden.
API-Geheimer Clientschlüssel: Ascertia oder Ihr Unternehmensadministrator stellt den API-Geheimschlüssel bereit, um den Connector zu verwenden.
API-URL: Die SigningHub-API-URL standardmäßig https://api.signinghub.com

Unterstützte Vorgänge

Dieser Connector bietet eine gewisse Abdeckung der SigningHub-REST-API. Eine Liste der unterstützten Aktionen und deren Parameter finden Sie im SigningHub-API-Handbuch.

Support & Links

Drosselungsgrenzwerte

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

Aktionen

Abrufen der Workflowbenutzerauthentifizierung (Dokumentöffnung) des Enterprise-Pakets	Geschäftsanwendungen können diese Dienst-API verwenden, um die für das Paket aktivierten Zugriffssicherheitseinstellungen abzurufen. Empfänger, für die die Sicherheit konfiguriert ist, werden durch die Reihenfolge in der URL identifiziert. Die Paket-ID wird auch in der Anforderungs-URL identifiziert. Empfänger können nicht außerhalb dieses Zeitraums auf das Dokumentpaket zugreifen, wenn die Zugriffssicherheit aktiviert ist. Der Dokumentbesitzer kann auch die authentifizierungsbasierte Sicherheit des Pakets für einen Empfänger konfigurieren.
Abrufen von Dokumentdetails	Geschäftsanwendungen können diese Dienst-API verwenden, um die Dokumentdetails abzurufen. Die Dokument-ID wird in der URL als "{document_id}" angegeben.
Abrufen von Workflowbenutzerberechtigungen	Geschäftsanwendungen können diese Dienst-API verwenden, um Dokumentberechtigungen für einen Empfänger abzurufen. Der Empfänger wird durch die Reihenfolge im Workflow identifiziert. Die ID des Pakets wird in der Ressourcen-URL angegeben.
Abrufen von Workflowbenutzern	Geschäftsanwendungen können diese Dienst-API verwenden, um Workflowdetails für das Paket abzurufen.
Add-In-Person-Feld	Geschäftsanwendungen können diese Dienst-API für ein Persönliches Signaturfeld zu einem Dokument in einem Paket verwenden. Mindestens ein Benutzer muss in einem Workflow vorhanden sein, bevor Felder(Eingabe und Signatur) auf diese Weise dem Dokument hinzugefügt werden können. Die Bestellnummer entspricht dem Empfänger im Workflow. Daher muss diese Zahl gleich oder kleiner als die Gesamtanzahl der Benutzer im Workflow sein. Im folgenden Beispiel wird dieses neue Signaturfeld der ersten Person im Workflow zugewiesen. Weitere Informationen finden Sie unter "Hinzufügen von Benutzern zum Workflow ". Wenn Sie ein Dokument mit einer Vorlage angewendet haben oder ein Dokument mit den APIs angewendet haben, enthält der Workflow bereits Benutzer. Um eine persönliche Besprechung zu hosten, muss ein SigningHub-Benutzer Teil des Workflows sein. Sie müssen entweder mit rolle "INPERSON_HOST" oder "SIGNER" hinzugefügt werden. Für die Hostoption ist kein Signatur- oder Eingabefeld für das Dokument erforderlich, und das persönliche Signaturfeld kann vom nicht signierten Benutzer signiert werden. Beachten Sie, dass dies ein spezielles Workflowszenario ist, in dem erwartet wird, dass sich der SignHub-Benutzer und -Empfänger an demselben Speicherort befinden. Dieser Signaturtyp ist nicht für die Verwendung vorgesehen, bei der ein Dokument mit Empfängern über einen E-Mail-Link in der normalen losen Integrationsmethode geteilt wird.
Aktualisieren der Workflowbenutzerauthentifizierung (Dokumentöffnung) des Enterprise-Pakets	Geschäftsanwendungen können diese Dienst-API verwenden, um die Paketauthentifizierungen und die Zugriffsdauer für die Empfänger zu aktualisieren. Diese API kann auch vom Unternehmensadministrator oder vom Unternehmensbenutzer verwendet werden, wenn die Variable "Scope" in der Authentifizierungsanforderung verwendet wurde.
Aktualisieren der Zertifizierungsrichtlinie für ein Dokument	Geschäftsanwendungen können diese Dienst-API verwenden, um Die Signatureinstellungen für ein Dokument in einem Paket zu aktualisieren.
Aktualisieren des Platzhalters	Geschäftsanwendungen können diese Dienst-API verwenden, um einen Platzhalter im Workflow zu aktualisieren. Normalerweise ist dieser Aufruf nützlich, nachdem eine Vorlage auf ein Dokument angewendet wurde und Geschäftsanwendungen die Details eines bestimmten Platzhalters innerhalb des Workflows überschreiben möchten. Die ID des Workflowdokuments wird in der Ressourcen-URL angegeben, und der Workflowplatzhalter wird durch die Reihenfolge identifiziert, in der sie dem Workflow hinzugefügt wird. Während die XML-Typdokumentvorbereitung, sind nur unterstützte Rollentypen "SIGNER", "REVIEWER" und "CARBON_COPY"
Anfangsfeld aktualisieren	Geschäftsanwendungen können diese Dienst-API verwenden, um ein Initialenfeld eines Dokuments in einem Paket zu aktualisieren. Beachten Sie, dass alle Eingabeparameter geändert werden können. Wenn Sie die aktuelle Einstellung beibehalten möchten, wird sie im Anruf unverändert übermittelt. Sie können daher dieselben Parameter verwenden wie beim Hinzufügen des Eingabefelds oder der Informationen, die von "Dokumentfelder abrufen" zurückgegeben werden. Letzteres kann verwendet werden, wenn eine Vorlage angewendet oder das Dokument mithilfe der GUI-Schnittstelle erstellt wurde.
Anfangsfeld hinzufügen	Geschäftsanwendungen können diese Dienst-API verwenden, um einem Dokument in einem Paket ein Initialenfeld hinzuzufügen. Mindestens ein Benutzer muss in einem Workflow vorhanden sein, bevor Felder(Eingabe und Signatur) auf diese Weise dem Dokument hinzugefügt werden können. Die Bestellnummer entspricht dem Empfänger im Workflow. Daher muss diese Zahl gleich oder kleiner als die Gesamtanzahl der Benutzer im Workflow sein. Im folgenden Beispiel wird dieses neue Signaturfeld der ersten Person im Workflow zugewiesen. Weitere Informationen finden Sie unter "Hinzufügen von Benutzern zum Workflow ". Wenn Sie ein Dokument mit einer Vorlage angewendet haben oder ein Dokument mit den APIs angewendet haben, enthält der Workflow bereits Benutzer.
Anhang hochladen	Geschäftsanwendungen können diese Dienst-API verwenden, um eine Anlage in ein Dokument hochzuladen.
Anhänge abrufen	Geschäftsanwendungen können diese Dienst-API verwenden, um die Anlagen eines Dokuments abzurufen.
Anlage herunterladen	Geschäftsanwendungen können diese Dienst-API verwenden, um die Anlage eines Dokuments herunterzuladen.
Anlage löschen	Geschäftsanwendungen können diese Dienst-API verwenden, um die Anlage eines Dokuments zu löschen.
Ausfüllen von Formularfeldern	Geschäftsanwendungen können diese Dienst-API verwenden, um ein oder mehrere Formularfelder in einem Dokument von einem bestimmten Benutzer in der Reihenfolge auszufüllen.
AutoPlace-Felder	Geschäftsanwendungen können diese API aufrufen, um einem Dokument basierend auf dem angegebenen Suchkriterium Signatur- oder benutzerdefinierte Formularfelder hinzuzufügen. Die Platzierungsoptionen sind: links, rechts, oben und unten. Das Dokument wird durchsucht, und alle Instanzen der erfüllten Suchkriterien werden verarbeitet. Auf diese Weise können Sie mehrere Felder mit einem Aufruf hinzufügen. Laden Sie z. B. ein Dokument hoch, und platzieren Sie automatisch ein Signaturfeld rechts neben allen Instanzen des Worts "Hier signieren:". Dies spart Zeit und stellt sicher, dass vom Workflow keine Signaturen verpasst werden. Der API-Aufruf unterstützt alle Arten von Feldern; d. h. elektronisch, digital, persönlich, Initialen und Textfeld usw. Darüber hinaus unterstützt der API-Aufruf die Variable "order". Dies bedeutet, dass Sie einem einzelnen Benutzer automatisch eine Reihe von Signaturfeldern zuweisen können. Daher kann der Aufruf wiederholt werden, um Signaturfelder mehreren Benutzern im Workflow zuzuweisen. Mindestens ein Benutzer muss in einem Workflow vorhanden sein, bevor signaturfelder auf diese Weise dem Dokument hinzugefügt werden können. Die Bestellnummer entspricht dem Empfänger im Workflow. Daher muss diese Zahl gleich oder kleiner als die Gesamtanzahl der Benutzer im Workflow sein. Im folgenden Beispiel wird dieses neue Signaturfeld der ersten Person im Workflow zugewiesen. Dieser API-Aufruf kann mehrmals im selben Dokument verwendet werden. Der Grund dafür besteht darin, mehrere Unterzeichner in einem Dokument zu erfüllen. Der Empfänger oder Signatory wird durch die im Aufruf übergebene Variable "order" identifiziert. Weitere Informationen finden Sie unter "Hinzufügen von Benutzern zum Workflow ". Wenn Sie ein Dokument mit einer Vorlage angewendet haben oder ein Dokument mit den APIs angewendet haben, enthält der Workflow bereits Benutzer.
CheckBox-Feld aktualisieren	Geschäftsanwendungen können diese Dienst-API verwenden, um ein Kontrollkästchenfeld eines Dokuments in einem Paket zu aktualisieren. Beachten Sie, dass alle Eingabeparameter geändert werden können. Wenn Sie die aktuelle Einstellung beibehalten möchten, wird sie im Anruf unverändert übermittelt. Sie können daher dieselben Parameter verwenden wie beim Hinzufügen des Eingabefelds oder der Informationen, die von "Dokumentfelder abrufen" zurückgegeben werden. Letzteres kann verwendet werden, wenn eine Vorlage angewendet oder das Dokument mithilfe der GUI-Schnittstelle erstellt wurde. Breite und Höhe können nicht aktualisiert werden. Sie bleiben gleich, als sie hinzugefügt wurden.
CheckBox-Feld hinzufügen	Geschäftsanwendungen können diese Dienst-API verwenden, um einem Dokument in einem Paket ein Kontrollkästchen hinzuzufügen. Mindestens ein Benutzer muss in einem Workflow vorhanden sein, bevor Felder(Eingabe und Signatur) auf diese Weise dem Dokument hinzugefügt werden können. Die Bestellnummer entspricht dem Empfänger im Workflow. Daher muss diese Zahl gleich oder kleiner als die Gesamtanzahl der Benutzer im Workflow sein. Im folgenden Beispiel wird dieses neue Signaturfeld der ersten Person im Workflow zugewiesen. Weitere Informationen finden Sie unter "Hinzufügen von Benutzern zum Workflow ". Wenn Sie ein Dokument mit einer Vorlage angewendet haben oder ein Dokument mit den APIs angewendet haben, enthält der Workflow bereits Benutzer. Wenn keine Parameter für Breite und Höhe angegeben werden, wird eine Standardgröße von 10 x 10 zugewiesen. Wenn entweder Breite oder Höhe (oder beide) bereitgestellt wird, vergleicht das System diese bereitgestellten Werte miteinander. Der größere Wert zwischen Breite und Höhe wird beiden Dimensionen zugewiesen.
Digitale Signaturfeld aktualisieren	Geschäftsanwendungen können diese Dienst-API verwenden, um ein digitales Signaturfeld eines Dokuments in einem Paket zu aktualisieren. Beachten Sie, dass alle Eingabeparameter geändert werden können. Wenn Sie die aktuelle Einstellung beibehalten möchten, wird sie im Anruf unverändert übermittelt. Sie können daher dieselben Parameter verwenden wie beim Hinzufügen des Eingabefelds oder der Informationen, die von "Dokumentfelder abrufen" zurückgegeben werden. Letzteres kann verwendet werden, wenn eine Vorlage angewendet oder das Dokument mithilfe der GUI-Schnittstelle erstellt wurde.
Dokument ablehnen	Geschäftsanwendungen können diese Dienst-API verwenden, um ein Dokument von einem bestimmten Benutzer in der Reihenfolge abzulehnen.
Dokument aus Bibliothek hinzufügen oder aktualisieren	Geschäftsanwendungen können diese Dienst-API verwenden, um ein Dokument aus der Bibliothek des Benutzers zu einem Paket hinzuzufügen. Die Paket-ID wird in der URL angegeben, die ID des Dokuments sollte auch als "document_id" in der Ressourcen-URL angegeben werden, um das zu kopierende Bibliotheksdokument zu identifizieren. Beachten Sie, dass bereits ein Paket vorhanden sein muss, bevor Sie mithilfe dieses Aufrufs ein Dokument hinzufügen können.
Dokument genehmigen	Geschäftsanwendungen können diese Dienst-API verwenden, um ein Dokument von einem bestimmten Benutzer in der Reihenfolge zu genehmigen.
Dokument löschen	Geschäftsanwendungen können diese Dienst-API verwenden, um ein Dokument in einem Paket zu löschen.
Dokument signieren	Geschäftsanwendungen können diese Dienst-API verwenden, um ein Dokument (sowohl elektronisch als auch digital) zu signieren, ohne das Dokument mithilfe von SigningHub für den Endbenutzer anzuzeigen. Beispielsweise kann eine Geschäftsanwendung eine andere Methode zum Anzeigen des Dokuments für den Benutzer haben, und nur die Signaturfunktionalität von SigningHub ist erforderlich, oder für Massenvorgänge kann es gerechtfertigt sein, sich zu signieren, ohne dass der Benutzer jedes Dokument einzeln anzeigen und genehmigen muss. Wenn vor dem Signieren Änderungen im Dokument gespeichert werden sollen, sollte die Api für Füllformularfelder aufgerufen werden, bevor die Signierdokument-API aufgerufen wird. Beachten Sie, dass alle obligatorischen Eingabefelder für ein Dokument abgeschlossen werden müssen, bevor diese API erfolgreich abgeschlossen wird. Das Signatory wird durch das zugriffstoken identifiziert, das im Aufruf angezeigt wird. Daher ist vor dem Aufruf eine Authentifizierung des Signatorys erforderlich. Sie können sich nicht als Unternehmensadministrator mit der Bereichsvariable authentifizieren und ein Dokument im Namen eines Benutzers signieren. Das Zugriffstoken muss aufgrund der direkten Authentifizierung an das Signatory ausgestellt werden. Wenn dieser Aufruf abgeschlossen ist, ist es wichtig, dass, wenn der Signator der letzte Signierer für ein Dokument war, das der Aufruf der Finish Document API aufgerufen wird. Der Grund dafür ist, dass das Dokument ohne Aufrufen dieser API im Status "In Bearbeitung" für den Dokumentbesitzer verbleibt. Nachdem die API aufgerufen wurde, wird der Status für den Dokumentbesitzer in "Abgeschlossen" geändert. Nachdem das Dokument signiert wurde, kann die Überprüfungsantwort über die API "Dokumentüberprüfung abrufen " angezeigt werden. First- oder Second Factor OTP-Verwendung für die Authentifizierung Wenn die OTP-Authentifizierung für den serverseitigen Signaturvorgang aktiviert ist, müssen Clientanwendungen mithilfe des OTP-API-Aufrufs einen OTP für die Mobiltelefonnummer generieren. Die entsprechenden Geschäftsanwendungen müssen das OTP aus der Verwendung abrufen und übermitteln, wenn der API-Aufruf ausgeführt wird. Dies erfolgt mithilfe des "x-otp"-Headers in der Anforderung.
Dokument umbenennen	Geschäftsanwendungen können diese Dienst-API verwenden, um ein Dokument in einem Paket umzubenennen.
Dokument zurückrufen	Geschäftsanwendungen können diese Dienst-API verwenden, um einen laufenden Workflow zu beenden. Die Dokument-ID wird in der Ressourcen-URL angegeben. Nach dem Rückruf wird der Dokumentstatus automatisch in "ENTWURF" geändert.
Dokument übermitteln	Eine der SigningHub-Rollen wird als "Editor" bezeichnet. Dadurch kann ein Empfänger Eingabefelder in einem Dokument bearbeiten, erfordert jedoch keine Signatur. Nach Abschluss des Vorgangs übermittelt der Empfänger seine Änderungen. Die in der GUI verwendete Schaltfläche heißt "Submit". Dies ist der entsprechende Vorgang für einen Editor, um ihre Änderungen über einen API-Aufruf zu übermitteln. Klicken Sie auf "SigningHub-Rollen ", um eine Beschreibung aller verfügbaren Workflowempfängerrollen anzuzeigen.
Dokumentfeld löschen	Geschäftsanwendungen können diese Dienst-API verwenden, um ein Dokumentfeld in einem Paket zu löschen.
Dokumentfeld zuweisen	Geschäftsanwendungen können diese Dienst-API verwenden, um Benutzern Eingabefelder, z. B. Signaturfelder, zuzuweisen und somit die Signierreihenfolge zu definieren. Die Felder müssen bereits im Dokument vorhanden sein, und die Benutzer müssen im Workflow vorhanden sein. Die ID des Workflowdokuments wird zusammen mit dem Paketbezeichner in der Ressourcen-URL angegeben. Wenn sich Die Empfänger in einem Workflow befinden, werden sie nummeriert, beginnend bei einem Workflow und nach oben für jedes zusätzliche. Wenn also drei Benutzer in einem Workflow vorhanden sind, werden sie "1", "2" und "3" respektvoll nummeriert. Mit diesem API-Aufruf können Sie einem Eingabefeld im Dokument einen Benutzer anhand seiner Workflowreihenfolgenummer zuweisen.
Dokumentfelder abrufen	Geschäftsanwendungen können diese Dienst-API verwenden, um Dokumentfelder abzurufen, z. B. Initialen, Personen, Signaturfelder oder Formularfelder.
Dokumentpaket freigeben	Geschäftsanwendungen können diese Dienst-API verwenden, um ein Dokumentpaket mit den Signierern zu teilen und einen neuen Workflow zu starten. Das Dokument sollte bereits vorbereitet worden sein, indem eine Vorlage angewendet und optional die in der Vorlage definierten Benutzer und Aktionen aktualisiert werden. Die freigegebene Paket-ID wird in der Ressourcen-URL angegeben.
Enterprise-Vorlagen abrufen	Geschäftsanwendungen können diese Dienst-API verwenden, um eine Liste der Unternehmensvorlagen des aktuellen Benutzers abzurufen. Dies bedeutet, dass der Unternehmensadministrator oder der Unternehmensbenutzer, wenn die Variable "Scope" in der Authentifizierungsanforderung verwendet wurde. Es ist möglich, basierend auf dem Kriterium zu suchen, das unter der Kopfzeile "x-search-text" angegeben ist.
Feld "Digitale Signatur hinzufügen"	Geschäftsanwendungen können diese Dienst-API verwenden, um einem Dokument in einem Paket ein digitales Signaturfeld hinzuzufügen. Mindestens ein Benutzer muss in einem Workflow vorhanden sein, bevor Felder(Eingabe und Signatur) auf diese Weise dem Dokument hinzugefügt werden können. Die Bestellnummer entspricht dem Empfänger im Workflow. Daher muss diese Zahl gleich oder kleiner als die Gesamtanzahl der Benutzer im Workflow sein. Im folgenden Beispiel wird dieses neue Signaturfeld der ersten Person im Workflow zugewiesen. Weitere Informationen finden Sie unter "Hinzufügen von Benutzern zum Workflow ". Wenn Sie ein Dokument mit einer Vorlage angewendet haben oder ein Dokument mit den APIs angewendet haben, enthält der Workflow bereits Benutzer.
Freigegebenen Speicherplatz abrufen	Geschäftsanwendungen können diese Dienst-API verwenden, um einen bestimmten freigegebenen Speicherplatz abzurufen. Diese API gibt Informationen zum freigegebenen Raum, zum Besitzer und zum Mitarbeiter zurück.
Freigegebenen Speicherplatz aktualisieren	Geschäftsanwendungen können diese Dienst-API verwenden, um freigegebenen Speicherplatz zu aktualisieren. Die Verfügbarkeit der Aktualisierung freigegebener Räume unterliegt der zugewiesenen Unternehmensbenutzerrolle. Um diese Bereitstellung zuzulassen, aktiviert der Unternehmensadministrator die Option "Freigegebenen Speicherplatz verwalten" in den Rollendokumenteinstellungen>.
Freigegebenen Speicherplatz löschen	Geschäftsanwendungen können diese Dienst-API verwenden, um freigegebenen Speicherplatz zu löschen. Die Verfügbarkeit des Löschens freigegebener Leerzeichen unterliegt der zugewiesenen Unternehmensbenutzerrolle. Um diese Bereitstellung zuzulassen, aktiviert der Unternehmensadministrator die Option "Freigegebenen Speicherplatz verwalten" in den Rollendokumenteinstellungen>.
Gatekeeper-Ablehnungsdokument	Geschäftsanwendungen können diese Dienst-API verwenden, um ein Dokument von einem bestimmten Benutzer in der Reihenfolge abzulehnen.
Gatekeeper-Dokument genehmigen	Geschäftsanwendungen können diese Dienst-API verwenden, um ein Dokument von einem bestimmten Benutzer in der Reihenfolge zu genehmigen.
Herunterladen eines Dokuments	Geschäftsanwendungen können diese Dienst-API verwenden, um die Dokumentbytes herunterzuladen. Die Paket-ID und die Dokument-ID werden in der Ressourcen-URL angegeben.
Hinzufügen von Benutzern zum Workflow	Geschäftsanwendungen können diese Dienst-API verwenden, um Einem Workflow Empfänger hinzuzufügen. Dieser Aufruf fügt dem Workflow nur einen Empfänger hinzu. Das heißt, es werden keine Felder, die sich derzeit im Dokument befinden, automatisch den neuen Empfängern zugewiesen, und es werden keine neuen Felder erstellt. Beachten Sie, dass die Empfänger als letzte Person im Workflow hinzugefügt werden. Daher können weitere Arbeiten erforderlich sein, um einen aktuellen Empfänger zu entfernen, der bereits im Workflow vorhanden ist. Mindestens ein Benutzer muss in einem Workflow vorhanden sein, bevor dem Dokument Felder (Eingabe und Signatur) hinzugefügt werden können. Beachten Sie, dass die Eingabe einen oder mehrere Benutzer in einem einzigen Anruf akzeptiert. In diesem speziellen Anruf ist der Benutzer eine bekannte natürliche Person. Die gleichen Regeln gelten jedoch für Gruppen und Platzhalter. In einem dieser Fälle wird der Empfänger zu einer Benutzergruppe, in der jedes Mitglied der Gruppe das Dokument signieren kann, oder ein Platzhalter. Der letztere Fall wird verwendet, wenn Sie die Identität des beabsichtigten Unterzeichners nicht kennen. Note SigningHub workflow signing order starts at "1". Daher beginnt das Hinzufügen eines Benutzers zum Workflow ohne aktuelle Empfänger eine neue Anzahl von Signierreihenfolgen. Der Parameter "signing_order" ist obligatorisch, wenn der Workflowtyp "custom" ist. Wichtig: Die Verwendung dieses API-Aufrufs wirkt sich möglicherweise auf den Workflowtyp aus. Wenn sich aktuelle Empfänger in einem sequenziellen Workflow befinden und eine neue mit der gleichen Signierreihenfolge wie ein aktueller Empfänger hinzugefügt wird, ändert sich dieser Teil des Workflows automatisch von sequenziell zu parallel. Daher ist der Workflow insgesamt vom Typ "Benutzerdefiniert" im Gegensatz zu rein sequenziellem Typ. Das Hinzufügen eines Empfängers mit derselben Signierreihenfolge wie zwei oder parallele Empfänger ändert den Workflow nicht. Es gibt lediglich drei oder mehr Empfänger an diesem bestimmten Punkt des Workflows; alle in paralleler Reihenfolge. Beachten Sie, dass während die Dokumentvorbereitung des XML-Typs nur unterstützte Rollentypen "SIGNER", "REVIEWER" und "CARBON_COPY" sind.
Hinzufügen von Gruppen zum Workflow	Geschäftsanwendungen können diese Dienst-API verwenden, um Gruppen als Empfänger zu einem Workflow hinzuzufügen. Eine SigningHub-Gruppe bedeutet, dass jedes Mitglied der Gruppe die Aktion ausführen kann, d. h. im Namen aller Mitglieder der Gruppe. Beachten Sie, dass die Gruppe als letzter Benutzer/gruppe im Workflow hinzugefügt wird. Daher können weitere Arbeiten erforderlich sein, um einen aktuellen Benutzer/eine aktuelle Gruppe zu entfernen, die bereits im Workflow vorhanden ist. Während die XML-Typdokumentvorbereitung, sind nur unterstützte Rollentypen "SIGNER", "REVIEWER" und "CARBON_COPY"
Hochladen eines Dokuments	Geschäftsanwendungen können diese Dienst-API verwenden, um einem Dokumentpaket ein Dokument hinzuzufügen, das mit dem Konto eines Unternehmensbenutzers verknüpft ist. Die Dokumentinformationen werden im HTTP-Anforderungsheader gesendet, und Dokumentbytes werden im HTTP-Anforderungstext gesendet. Note SigningHub will convert supported document formats to PDF if the header "x-convert-document" is set to a value of "true". Der einzige unterstützte Fall, bei dem dieser Wert auf "false" festgelegt ist, besteht darin, Word Format- und XML-Dokumente beizubehalten. SigningHub unterstützt eine Vielzahl von Dokumentformaten, von denen jedes beim Hochladen in das PDF-Format konvertiert werden kann. Klicken Sie hier, um die vollständige Liste anzuzeigen. Hinweis PDF-Dokumente werden beim Hochladen in das System nicht geändert. Beachten Sie, dass bereits ein Paket vorhanden sein muss, bevor Sie mithilfe dieses Aufrufs ein Dokument hinzufügen können.
Initialen ausfüllen	Geschäftsanwendungen können diese Dienst-API verwenden, um ein Initialenfeld in einem Dokument von einem bestimmten Benutzer in der Reihenfolge auszufüllen.
Kontakte abrufen	Geschäftsanwendungen können diese Dienst-API verwenden, um Kontakte von persönlichen und Unternehmenskontakten für den aktuellen Benutzer zurück zu setzen. Es ist möglich, basierend auf dem Kriterium zu suchen, das unter der Kopfzeile "x-search-text" angegeben ist. Darüber hinaus ist es möglich, die spezifischen Kontakte eines Benutzers oder die des Unternehmens zu durchsuchen, zu dem der Benutzer gehört. Die Suchantwortinformationen enthalten die E-Mail-Adresse des Benutzers und den entsprechenden Benutzernamen.
Massen signieren Von Paketen	Geschäftsanwendungen können diese API verwenden, um mehrere Dokumente (sowohl elektronisch als auch digital) zu signieren/freizugeben und freizugeben, ohne die Dokumente dem Endbenutzer anzuzeigen. Diese API benötigt Informationen aus der Geschäftsanwendung zu Dokumentpaketen und details zu Signaturen, persönlich und initialen Feldern. Nach erfolgreichem Abschluss der Massensignierungstransaktion gibt die API die Status und Transaktions-IDs der Dokumentpakete zurück. Im Gegensatz zur Signierdokument-API signiert diese API nicht nur ein Dokumentpaket, sondern kennzeichnet es auch als genehmigt und überprüft, basierend darauf, ob der Empfänger ein Signierer, Editor oder Prüfer ist. Jedes Dokumentpaket, für das der Status als ABGESCHLOSSEN zurückgegeben wird, wurde von dieser API signiert, genehmigt oder überprüft. Die Massensignierung funktioniert mit allen Signaturzeitauthentifizierungsmethoden. Wenn SIGN als bulk_action übergeben wird und sich das Paket im Entwurfszustand befindet, wird sign and Share automatisch ausgeführt. Sie müssen diese API nach der API für vorab signierte Dokumente aufrufen. Falls Sie vor dem Signieren Änderungen an einem dokument vornehmen müssen, sollte die Api für Füllformularfelder aufgerufen werden, bevor Sie die Api für das Vorabsignieren von Dokumenten aufrufen. Denken Sie daran, dass alle obligatorischen Eingabefelder für ein Dokument abgeschlossen werden müssen, bevor diese API erfolgreich abgeschlossen wird. in der Erwägung, dass die automatisch ausgefüllten Felder (z. B. Name, E-Mail, Datum, Position usw.) automatisch ausgefüllt werden. Das Signatory wird durch das zugriffstoken identifiziert, das im Aufruf angezeigt wird. Daher ist vor dem Aufruf eine Authentifizierung des Signatorys erforderlich. Sie können sich nicht als Unternehmensadministrator mit der Bereichsvariable authentifizieren und ein Dokument im Namen eines Benutzers signieren. Das Zugriffstoken muss aufgrund der direkten Authentifizierung an das Signatory ausgestellt werden. Nachdem das Dokument signiert wurde, kann die Überprüfungsantwort über die Api für die Massensignierungsstatus angezeigt werden. First- oder Second Factor OTP-Verwendung für die Authentifizierung Falls die OTP-Authentifizierung für den serverseitigen Signaturvorgang aktiviert ist, müssen die Clientanwendungen mithilfe des OTP-API-Aufrufs einen OTP für die Mobiltelefonnummer generieren. Die entsprechenden Geschäftsanwendungen müssen das OTP aus der Verwendung abrufen und übermitteln, wenn der API-Aufruf ausgeführt wird. Dies erfolgt mithilfe des "x-otp"-Headers in der Anforderung.
Massensignierungsstatus	Geschäftsanwendungen können diese API verwenden, um den Status einer bestimmten Massensignierungstransaktion zusammen mit den Details von Dokumentpaketen abzurufen, die von der Massensignaturpaket-API verarbeitet wurden. Sie müssen diese API nach der API für massensignierende Pakete aufrufen. Das Signatory wird durch das zugriffstoken identifiziert, das im Aufruf angezeigt wird. Daher ist vor dem Aufruf eine Authentifizierung des Signatorys erforderlich. Sie können sich nicht als Unternehmensadministrator mit der Bereichsvariable authentifizieren und ein Dokument im Namen eines Benutzers signieren. Das Zugriffstoken muss aufgrund der direkten Authentifizierung an das Signatory ausgestellt werden. Bei der RAS-Signatur wird die ACTION-Eigenschaft REMOTE_AUTHORIZATION_REQURIED, und die STATUS-Eigenschaft steht ausstehend und gibt an, dass die Anforderung mithilfe des mobilen Geräts autorisiert werden muss. Wenn der Signiervorgang in einem Dokument aufgrund verschiedener Zusicherungsebenen fehlschlägt und der Benutzer den Signaturvorgang erneut initiieren möchte, um den Signierungsprozess für fehlgeschlagene Dokumente abzuschließen, wird die ACTION-Eigenschaft REINITIATE_SIGNING_PROCESS, und die STATUS-Eigenschaft ist ausstehend.
Nachbearbeitung aktualisieren	Geschäftsanwendungen können diese Dienst-API verwenden, um einem Workflow ein Dokument in einem Paket Platzhalter hinzuzufügen.
Paket herunterladen	Geschäftsanwendungen können diese Dienst-API verwenden, um das Dokumentpaket im Binärformat herunterzuladen. Die Paket-ID wird in der Ressourcen-URL angegeben. Wenn das Paket nur ein Dokument enthält, ist der Download das binäre PDF-Dokument. Wenn das Paket über mehrere Dokumente verfügt, ist der Download die binär zip-Datei aller Dokumente. Die x-Password- und x-otp-Header sind optional. Sie sind erforderlich, wenn der Dokumentbesitzer sie während der Workflowerstellungsphase festlegt.
Paket hinzufügen	Diese Dienst-API wird verwendet, um ein Dokumentpaket hinzuzufügen/zu erstellen, um ein oder mehrere Dokumente zu speichern. Dieses Paket kann dann verwendet werden, um Dokumente und Empfänger hinzuzufügen, um einen neuen Workflow zu starten. Wie bereits erwähnt, ist dieser Aufruf obligatorisch, wenn Sie mit Dokumenten arbeiten möchten. Ein Paket muss vorhanden sein, bevor Sie Dokumente in SigningHub hochladen oder hinzufügen können. Selbst ein einzelnes Dokument ist Teil eines Pakets: ein Paket, das ein Dokument enthält. Hinweis: Ein Paket kann bei Bedarf umbenannt werden, sobald es erstellt wurde.
Paket löschen	Geschäftsanwendungen können diese Dienst-API verwenden, um ein Dokument aus dem Posteingang des Benutzers zu löschen. Die Paket-ID wird in der Ressourcen-URL als "{package_id}" angegeben. Wenn der Dokumentstatus ausstehend ist, wird es automatisch als Ergebnis des Löschvorgangs abgelehnt. Wenn der Dokumentstatus FREIGEGEBEN ist, wird das Dokument automatisch zurückgerufen, und der Workflow wird beendet, bevor das Dokument gelöscht wird.
Paket umbenennen	Diese Dienst-API wird verwendet, um ein Dokumentpaket umzubenennen. Das Dokumentpaket wird anhand seines eindeutigen Bezeichners in der URL des Aufrufs identifiziert.
Paketdetails abrufen	Geschäftsanwendungen können diese Dienst-API verwenden, um die Details eines Pakets abzurufen. Diese API kann auch von der Geschäftsanwendung verwendet werden, um Aktionen im Auftrag des Unternehmensbenutzers über "Bereichsauthentifizierung" auszuführen.
Pakete abrufen	Geschäftsanwendungen können diese Dienst-API verwenden, um eine Liste von Dokumenten abzurufen, die nach verschiedenen Status gefiltert wurden. Benutzer können die Datensätze auf Seiten aufteilen, indem sie eine Anzahl von Datensätzen pro Seite angeben.
Persönliches Feld aktualisieren	Geschäftsanwendungen können diese Dienst-API verwenden, um ein persönliches Signaturfeld eines Dokuments in einem Paket zu aktualisieren. Beachten Sie, dass alle Eingabeparameter geändert werden können. Wenn Sie die aktuelle Einstellung beibehalten möchten, wird sie im Anruf unverändert übermittelt. Sie können daher dieselben Parameter verwenden wie beim Hinzufügen des Eingabefelds oder der Informationen, die von "Dokumentfelder abrufen" zurückgegeben werden. Letzteres kann verwendet werden, wenn eine Vorlage angewendet oder das Dokument mithilfe der GUI-Schnittstelle erstellt wurde.
Platzhalter zum Workflow hinzufügen	Geschäftsanwendungen können diese Dienst-API verwenden, um einem Workflow in einem Paket Platzhalter hinzuzufügen. Ein Platzhalter ist erforderlich, wenn Sie die Identität des vorgesehenen Empfängers in einem Workflow nicht kennen. Beachten Sie, dass der Platzhalter als letzter Benutzer im Workflow hinzugefügt wird. Daher können weitere Arbeiten erforderlich sein, um einen aktuellen Benutzer/eine aktuelle Gruppe zu entfernen, die bereits im Workflow vorhanden ist. Durch das Hinzufügen eines Platzhalters können Sie signatur- und/oder eingabefelder zum Dokument hinzufügen, die dann später einzelnen Benutzern zugewiesen werden können. Während die XML-Typdokumentvorbereitung, sind nur unterstützte Rollentypen "SIGNER", "REVIEWER" und "CARBON_COPY"
Prozessnachweisbericht abrufen	Geschäftsanwendungen können diese Dienst-API verwenden, um den Workflowprozessnachweisbericht eines Dokuments herunterzuladen.
QR-Code aktualisieren	Geschäftsanwendungen können diese Dienst-API verwenden, um einen QR-Code eines Dokuments in einem Paket zu aktualisieren.
QR-Code hinzufügen	Geschäftsanwendungen können diese Dienst-API verwenden, um einem Dokument in einem Paket einen QR-Code hinzuzufügen.
RadioBox-Feld aktualisieren	Geschäftsanwendungen können diese Dienst-API verwenden, um ein Optionsfeld eines Dokuments in einem Paket zu aktualisieren. Beachten Sie, dass alle Eingabeparameter geändert werden können. Wenn Sie die aktuelle Einstellung beibehalten möchten, wird sie im Anruf unverändert übermittelt. Sie können daher dieselben Parameter verwenden wie beim Hinzufügen des Eingabefelds oder der Informationen, die von "Dokumentfelder abrufen" zurückgegeben werden. Letzteres kann verwendet werden, wenn eine Vorlage angewendet oder das Dokument mithilfe der GUI-Schnittstelle erstellt wurde. Breite und Höhe können nicht aktualisiert werden. Sie bleiben gleich, als sie hinzugefügt wurden.
RadioBox-Feld hinzufügen	Geschäftsanwendungen können diese Dienst-API verwenden, um einem Dokument in einem Paket ein Kontrollkästchen hinzuzufügen. Mindestens ein Benutzer muss in einem Workflow vorhanden sein, bevor Felder(Eingabe und Signatur) auf diese Weise dem Dokument hinzugefügt werden können. Die Bestellnummer entspricht dem Empfänger im Workflow. Daher muss diese Zahl gleich oder kleiner als die Gesamtanzahl der Benutzer im Workflow sein. Im folgenden Beispiel wird dieses neue Signaturfeld der ersten Person im Workflow zugewiesen. Weitere Informationen finden Sie unter "Hinzufügen von Benutzern zum Workflow ". Wenn Sie ein Dokument mit einer Vorlage angewendet haben oder ein Dokument mit den APIs angewendet haben, enthält der Workflow bereits Benutzer. Wenn keine Parameter für Breite und Höhe angegeben werden, wird eine Standardgröße von 10 x 10 zugewiesen. Wenn entweder Breite oder Höhe (oder beide) bereitgestellt wird, vergleicht das System diese bereitgestellten Werte miteinander. Der größere Wert zwischen Breite und Höhe wird beiden Dimensionen zugewiesen.
Textfeld-Feld aktualisieren	Geschäftsanwendungen können diese Dienst-API verwenden, um ein Textfeld eines Dokuments in einem Paket zu aktualisieren. Beachten Sie, dass alle Eingabeparameter geändert werden können. Wenn Sie die aktuelle Einstellung beibehalten möchten, wird sie im Anruf unverändert übermittelt. Sie können daher dieselben Parameter verwenden wie beim Hinzufügen des Eingabefelds oder der Informationen, die von "Dokumentfelder abrufen" zurückgegeben werden. Letzteres kann verwendet werden, wenn eine Vorlage angewendet oder das Dokument mithilfe der GUI-Schnittstelle erstellt wurde.
Textfeld-Feld hinzufügen	Geschäftsanwendungen können diese Dienst-API verwenden, um einem Dokument in einem Paket ein Texteingabefeld hinzuzufügen. Mindestens ein Benutzer muss in einem Workflow vorhanden sein, bevor Felder(Eingabe und Signatur) auf diese Weise dem Dokument hinzugefügt werden können. Die Bestellnummer entspricht dem Empfänger im Workflow. Daher muss diese Zahl gleich oder kleiner als die Gesamtanzahl der Benutzer im Workflow sein. Im folgenden Beispiel wird dieses neue Signaturfeld der ersten Person im Workflow zugewiesen. Weitere Informationen finden Sie unter "Hinzufügen von Benutzern zum Workflow ". Wenn Sie ein Dokument mit einer Vorlage angewendet haben oder ein Dokument mit den APIs angewendet haben, enthält der Workflow bereits Benutzer.
Verarbeitung beenden	Geschäftsanwendungen können diese Dienst-API verwenden, um die Dokumentverarbeitung nach dem Signieren aller Signaturfelder abzuschließen. Diese Methode wird in erster Linie von nativen mobilen SigningHub-Apps für iOS und Android und mobilen Web-Anwendungsfällen verwendet. Allgemeine Geschäftsanwendungen, die eine enge Integration in ihr jeweiliges Portal verwenden, müssen diese Methode nicht aufrufen. Wenn Sie jedoch die Signierdokument-API verwenden (und demzufolge wird dem Benutzer keine visuelle Darstellung des Dokuments angezeigt, das sie signieren möchten), ist das Aufrufen dieser API erforderlich, um sicherzustellen, dass der jeweilige Workflow fortgesetzt oder abgeschlossen wird. Wenn beispielsweise alle Signaturen mithilfe des "blinden" Signierdokument-API-Aufrufs angewendet wurden, wird das Dokument erst dann als Status "Abgeschlossen" für den Besitzer angezeigt, wenn diese API aufgerufen wird. Der Dokumentbesitzer sieht den Status "In Bearbeitung", bis diese API aufgerufen wird. In nativen SignHub Mobile-Apps und mobilen Web-Anwendungsfällen ist dieser Aufruf erforderlich, um sicherzustellen, dass jeder Benutzer seine jeweiligen Aktionen im Hinblick auf SigningHub abgeschlossen hat. Nachdem beispielsweise ein Signatory ein Dokument in signingHub App signiert hat, wird diese Methode von der Anwendung aufgerufen, um sicherzustellen, dass der Workflow weiterhin verarbeitet wird und der nächste Signator benachrichtigt wird, und der Dokumentstatus ist über die konfigurierte Rückruf-URL verfügbar.
Verschieben des Pakets in den Ordner "Benutzerdefinierter oder freigegebener Speicherplatz"	Geschäftsanwendungen können diese Dienst-API verwenden, um das Dokumentpaket in einen freigegebenen Bereich oder einen benutzerdefinierten Ordner des Benutzers zu verschieben.
Vollständiger Workflow in der Mitte (Workflow beenden)	Geschäftsanwendungen können den Workflow sogar in der Mitte des Workflows als erledigt markieren. Verwenden Sie diese Dienst-API, um den Status des Workflows so zu ändern, dass er abgeschlossen ist. Wenn Empfänger vorhanden sind, die das Dokument noch nicht signiert haben. Ihre Signatur wird nicht mehr benötigt, und sie können das Dokument nicht weiter in ihrem Posteingang sehen. Bearertoken sollte zum Dokumentbesitzer oder Unternehmensadministrator gehören, kann Bereichsvariable verwenden, um das Zugriffstoken im Namen des Dokumentbesitzers abzurufen, um diese Aktion auszuführen.
Vorlagen abrufen	Geschäftsanwendungen können diese Dienst-API verwenden, um eine Liste der Vorlagen für den aktuellen Benutzer abzurufen. Es ist möglich, basierend auf dem Kriterium zu suchen, das unter der Kopfzeile "x-search-text" angegeben ist. Darüber hinaus ist es möglich, die persönlichen Vorlagen eines Benutzers oder die Unternehmensvorlagen nach ihrer Benutzerrolle durch den Unternehmensadministrator zu durchsuchen.
Workflowbenutzer aktualisieren	Geschäftsanwendungen können diese Dienst-API verwenden, um die Details eines Empfängers, einer Gruppe oder eines Platzhalters zu aktualisieren, der einem Workflow bereits hinzugefügt wurde. Normalerweise ist dieser Aufruf nützlich, nachdem eine Vorlage auf ein Dokument angewendet wurde und Geschäftsanwendungen die Details eines bestimmten Benutzers innerhalb des Workflows außer Kraft setzen möchten. Die ID des Workflowdokuments wird in der Ressourcen-URL angegeben, und der Workflowempfänger wird durch die Reihenfolge identifiziert, in der es dem Workflow hinzugefügt wird. Beachten Sie, dass während der XML-Typdokumentvorbereitung nur Rollentypen "SIGNER", "REVIEWER" und "CARBON_COPY" unterstützt werden.
Workflowbenutzer löschen	Geschäftsanwendungen können diese Dienst-API verwenden, um Workflowempfänger zu löschen.
Workflowbenutzerberechtigungen aktualisieren	Geschäftsanwendungen können diese Dienst-API verwenden, um die Workflowberechtigungen für einen Benutzer zu aktualisieren, der bereits einem Workflow hinzugefügt wurde. Normalerweise ist dieser Aufruf nützlich, nachdem eine Vorlage auf ein Dokument angewendet wurde und Geschäftsanwendungen die Berechtigungen im Workflow überschreiben möchten. Die ID des Dokumentpakets wird in der Ressourcen-URL angegeben, und der Workflowbenutzer wird durch die Reihenfolge identifiziert, in der es dem Workflow hinzugefügt wird.
Workflowbenutzerreihenfolge aktualisieren	Geschäftsanwendungen können diese Dienst-API verwenden, um die Reihenfolge des Empfängers im Workflow zu aktualisieren.
Workflowdetails abrufen	Geschäftsanwendungen können diese Dienst-API verwenden, um Workflowdetails für das Paket abzurufen.
Workflowdetails aktualisieren	Geschäftsanwendungen können diese Dienst-API verwenden, um die Workflowdetails zu aktualisieren. Normalerweise ist dieser Aufruf nützlich, nachdem eine Vorlage auf ein Dokument angewendet wurde, aber Geschäftsanwendungen möchten die Zertifizierungsberechtigung oder die Nachbearbeitungsdetails außer Kraft setzen. Die Paket-ID wird in der Ressourcen-URL angegeben.
Workflowerinnerung abrufen	Geschäftsanwendungen können diese Dienst-API verwenden, um die Erinnerungen für die Empfänger zu aktualisieren, die bereits einem Workflow hinzugefügt wurden. Normalerweise ist dieser Aufruf nützlich, nachdem eine Vorlage auf ein Dokument angewendet wurde und Geschäftsanwendungen die Erinnerungseinstellungen im Workflow überschreiben möchten. Die ID des Workflowdokuments wird in der Ressourcen-URL angegeben, und der Workflowempfänger wird durch die Reihenfolge identifiziert, in der es dem Workflow hinzugefügt wird.
Workflowerinnerungen aktualisieren	Geschäftsanwendungen können diese Dienst-API verwenden, um die Workflowerinnerungen für einen Empfänger zu aktualisieren, der bereits einem Workflow hinzugefügt wurde. Normalerweise ist dieser Aufruf nützlich, nachdem eine Vorlage auf ein Dokument angewendet wurde und Geschäftsanwendungen die Erinnerungseinstellungen im Workflow überschreiben möchten. Die ID des Workflowdokuments wird in der Ressourcen-URL angegeben, und der Workflowempfänger wird durch die Reihenfolge identifiziert, in der es dem Workflow hinzugefügt wird.
Workflowverlauf abrufen	Geschäftsanwendungen können diese Dienst-API verwenden, um die Liste der Aktionen abzurufen, die für ein Dokument ausgeführt werden. Die Paket-ID wird in der Ressourcen-URL angegeben. Das Suchfeld (x-search-text header) ist für E-Mail, Dokumentname, Aktion, Infoschlüssel und Infowert vorgesehen.
Workflowvorlage anwenden	Geschäftsanwendungen können diese Dienst-API verwenden, um eine Workflowvorlage auf ein Dokument anzuwenden. Die Dokument-ID, auf die die Vorlage angewendet werden muss, wird in der Ressourcen-URL angegeben. Wenn die Dokument-ID auf 0 festgelegt ist, wird die Vorlage auf alle Doucments in einem Pacakge angewendet. Beim Anwenden der Vorlage ist es wichtig, diese beiden wichtigen Punkte zu beachten: Punkt 1 : Wenn die angewendete Vorlage mit einer PDF erstellt wird, die bereits Formularfelder enthält, stellen Sie sicher, dass das Dokument, auf das diese Vorlage jetzt angewendet wird, diese Formularfelder im Voraus enthalten muss und SignHub diese Formularfelder nicht über die Vorlage erstellt, sondern nur die Formulardaten anwendet und den jeweiligen Benutzern zugewiesen wird. Punkt 2: Wenn die angewendete Vorlage erstellt wird, bei der Formularfelder manuell (daher nicht in der PDF-Datei ursprünglich vorhanden) über SigningHub hinzugefügt werden, z. B. Signaturfeld, initiale, persönliche Signatur, Kontrollkästchen, Optionsfelder, Textfelder usw. beim Anwenden einer solchen Vorlage, werden diese Formularfelder auch dann im Zieldokument erstellt, wenn diese Formularfelder bereits im Dokument vorhanden waren.
Zertifizierungsrichtlinie für ein Dokument abrufen	Geschäftsanwendungen können diese Dienst-API verwenden, um Signatureinstellungen eines Dokuments in einem Paket abzurufen.

Abrufen der Workflowbenutzerauthentifizierung (Dokumentöffnung) des Enterprise-Pakets

Vorgangs-ID:: V4_EnterpriseDocuments_GetEnterpriseWorkflowAccess

Geschäftsanwendungen können diese Dienst-API verwenden, um die für das Paket aktivierten Zugriffssicherheitseinstellungen abzurufen. Empfänger, für die die Sicherheit konfiguriert ist, werden durch die Reihenfolge in der URL identifiziert. Die Paket-ID wird auch in der Anforderungs-URL identifiziert. Empfänger können nicht außerhalb dieses Zeitraums auf das Dokumentpaket zugreifen, wenn die Zugriffssicherheit aktiviert ist. Der Dokumentbesitzer kann auch die authentifizierungsbasierte Sicherheit des Pakets für einen Empfänger konfigurieren.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Paket-ID	packageId	True	integer	Die Paket-ID, für die die Sicherheit und Authentifizierung des Workflows aktualisiert werden soll.
Empfängerauftrag	order	True	integer	Reihenfolge des Empfängers im Workflow, für den die Zugriffssicherheit und Authentifizierung aktualisiert werden soll.

Gibt zurück

Body: EnterpriseAccessResponse

Abrufen von Dokumentdetails

Vorgangs-ID:: V4_Documents_GetDocumentDetails

Geschäftsanwendungen können diese Dienst-API verwenden, um die Dokumentdetails abzurufen. Die Dokument-ID wird in der URL als "{document_id}" angegeben.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Paket-ID	packageId	True	integer	Die Paket-ID des Pakets, dem das Dokument hinzugefügt wird.
Dokument-ID	documentId	True	integer	Die Dokument-ID, für die die Dokumentdetails angefordert werden.
Dokumentkennwort	x-password		string	Das vom Dokumentbesitzer festgelegte Kennwort für den Zugriff auf das Dokument( falls vorhanden). Wenn das Kennwort nicht festgelegt wurde, muss der Wert null sein.
One-Time Kennwort (OTP)	x-otp		string	Das vom Dokumentbesitzer für den Zugriff auf das Dokument festgelegte One-Time Kennwort (OTP), falls vorhanden. Wenn der OTP nicht festgelegt wurde, muss der Wert null sein.
Ordner-ID	x-folder-id		string	Geben Sie die Ordner-ID zum Abrufen der Ordnerelemente an, wenn ein freigegebener Speicherplatzordner beteiligt ist.

Gibt zurück

Body: DocumentDetailsResponse

Abrufen von Workflowbenutzerberechtigungen

Vorgangs-ID:: V4_WorkflowPermission_GetWorkflowPermissions

Geschäftsanwendungen können diese Dienst-API verwenden, um Dokumentberechtigungen für einen Empfänger abzurufen. Der Empfänger wird durch die Reihenfolge im Workflow identifiziert. Die ID des Pakets wird in der Ressourcen-URL angegeben.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Paket-ID	packageId	True	integer	Die Dokument-ID, für die der Workflowbenutzer aktualisiert werden muss.
Bestellung	order	True	integer	Die Reihenfolge des Benutzers im Workflow, für den die Berechtigungen angefordert werden. Durch die Bereitstellung des Werts 0 in der Reihenfolge würde der Dienst die Berechtigungen der zuletzt hinzugefügten Mitarbeiter im Workflow zurückgeben.

Gibt zurück

Body: WorkflowPermissionResponse

Abrufen von Workflowbenutzern

Vorgangs-ID:: V4_Workflow_GetWorkflowUsers

Geschäftsanwendungen können diese Dienst-API verwenden, um Workflowdetails für das Paket abzurufen.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Paket-ID	packageId	True	integer	Die ID des herunterzuladenden Pakets.
Ordner-ID	x-folder-id		string	Geben Sie die Ordner-ID zum Abrufen der Ordnerelemente an, wenn ein freigegebener Speicherplatzordner beteiligt ist.

Gibt zurück

response: array of WorkflowRecipient

Add-In-Person-Feld

Vorgangs-ID:: V4_InPerson_AddInPerson

Geschäftsanwendungen können diese Dienst-API für ein Persönliches Signaturfeld zu einem Dokument in einem Paket verwenden.

Mindestens ein Benutzer muss in einem Workflow vorhanden sein, bevor Felder(Eingabe und Signatur) auf diese Weise dem Dokument hinzugefügt werden können. Die Bestellnummer entspricht dem Empfänger im Workflow. Daher muss diese Zahl gleich oder kleiner als die Gesamtanzahl der Benutzer im Workflow sein. Im folgenden Beispiel wird dieses neue Signaturfeld der ersten Person im Workflow zugewiesen.

Weitere Informationen finden Sie unter "Hinzufügen von Benutzern zum Workflow ". Wenn Sie ein Dokument mit einer Vorlage angewendet haben oder ein Dokument mit den APIs angewendet haben, enthält der Workflow bereits Benutzer.

Um eine persönliche Besprechung zu hosten, muss ein SigningHub-Benutzer Teil des Workflows sein. Sie müssen entweder mit rolle "INPERSON_HOST" oder "SIGNER" hinzugefügt werden. Für die Hostoption ist kein Signatur- oder Eingabefeld für das Dokument erforderlich, und das persönliche Signaturfeld kann vom nicht signierten Benutzer signiert werden.

Beachten Sie, dass dies ein spezielles Workflowszenario ist, in dem erwartet wird, dass sich der SignHub-Benutzer und -Empfänger an demselben Speicherort befinden. Dieser Signaturtyp ist nicht für die Verwendung vorgesehen, bei der ein Dokument mit Empfängern über einen E-Mail-Link in der normalen losen Integrationsmethode geteilt wird.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Paket-ID	packageId	True	integer	Paket-ID, zu der das Dokument hinzugefügt wird.
Dokument-ID	documentId	True	integer	Die Dokument-ID, für die die Aktion ausgeführt werden soll.
order	order	True	integer	Die Reihenfolge des Benutzers im Workflow, für den das Feld hinzugefügt wird.
page_no	page_no	True	integer	Seitenzahl, auf der das Feld erstellt werden soll.
field_name	field_name		string	Name des Felds, das hinzugefügt werden soll. Wenn nicht angegeben, weist das System dem Feld einen eindeutigen automatisch generierten Namen zu.
Platzhalter	placeholder	True	string	Zeichenfolgenbezeichner für das Identitätsfeld, es kann Kunde, Jack, CEO usw. sein.
x	x	True	double	Linke Position des Felds in Pixel.
y	y	True	double	Oberste Position des Felds in Pixel.
width	width	True	double	Breite des Felds in Pixel.
height	height	True	double	Höhe des Felds in Pixel.
Bildschirm	display		string	Sichtbarkeit des hinzuzufügenden Felds, mögliche Werte sind "VISIBLE" und "INVISIBLE"
level_of_assurance	level_of_assurance		array of string	Stufe der Zusicherung, die aktualisiert werden soll. Mögliche Werte sind "ELECTRONIC_SEAL", "ADVANCED_ELECTRONIC_SEAL", "QUALIFIED_ELECTRONIC_SEAL", "ELECTRONIC_SIGNATURE"
enabled	enabled	True	boolean	True, wenn die Authentifizierung für das Feld aktiviert ist. Andernfalls ist der Wert FALSE.
enabled	enabled	True	boolean	True, wenn die OTP-Authentifizierung per SMS/E-Mail für das Feld aktiviert ist. Andernfalls ist der Wert FALSE.
mobile_number	mobile_number		string	Mobiltelefonnummer des Empfängers, dem das Feld zugewiesen ist.
enabled	enabled	True	boolean	True, wenn die TOTP-Authentifizierung für das Feld aktiviert ist. Andernfalls ist der Wert FALSE.

Gibt zurück

Body: AddFieldResponse

Aktualisieren der Workflowbenutzerauthentifizierung (Dokumentöffnung) des Enterprise-Pakets

Vorgangs-ID:: V4_EnterpriseDocuments_UpdateEnterpriseWorkflowAccess

Geschäftsanwendungen können diese Dienst-API verwenden, um die Paketauthentifizierungen und die Zugriffsdauer für die Empfänger zu aktualisieren. Diese API kann auch vom Unternehmensadministrator oder vom Unternehmensbenutzer verwendet werden, wenn die Variable "Scope" in der Authentifizierungsanforderung verwendet wurde.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Paket-ID	packageId	True	integer	Die Paket-ID, für die die Sicherheit und Authentifizierung des Workflows aktualisiert werden soll.
Empfängerauftrag	order	True	integer	Reihenfolge des Empfängers im Workflow, für den die Zugriffssicherheit und Authentifizierung aktualisiert werden soll.
apply_to_all	apply_to_all	True	boolean	True, wenn die Zugriffssicherheit oder Authentifizierung auf alle Empfänger im Workflow angewendet werden soll.
enabled	enabled	True	boolean	True, wenn die Authentifizierung für das Paket aktiviert ist.
enabled	enabled	True	boolean	True, wenn die Kennwortauthentifizierung für das Paket aktiviert ist.
user_password	user_password		string	Kennwortzeichenfolge, wenn das Kennwortfeld aktiviert ist. Wenn bereits ein Kennwort festgelegt ist und der Besitzer es nicht ändern möchte, entfernen Sie das Feld aus der Antwort, oder senden Sie NULL.
enabled	enabled	True	boolean	True, wenn die SMS OTP-Authentifizierung für das Paket aktiviert ist.
mobile_number	mobile_number		string	Mobiltelefonnummer des Empfängers. Mobiltelefonnummer ist erforderlich, um die SMS an den Empfänger für die Authentifizierung zu senden.
enabled	enabled	True	boolean	Aktiviert
enabled	enabled	True	boolean	True, wenn die Authentifizierung für das Paket aktiviert ist.
mobile_number	mobile_number		string	Mobiltelefonnummer des Empfängers. Mobiltelefonnummer ist erforderlich, um die SMS an den Empfänger für die Authentifizierung zu senden.
enabled	enabled	True	boolean	Aktiviert
enabled	enabled	True	boolean	True, wenn die Zugriffsdauersicherheit für das Paket aktiviert ist.
enabled	enabled	True	boolean	True, wenn die Zugriffssicherheit für eine Dauer nach Datum und Uhrzeit aktiviert ist.
start_date_time	start_date_time		date-time	Datum und Uhrzeit, an dem das Paket für den Empfänger zugänglich ist.
end_date_time	end_date_time		date-time	Datum und Uhrzeit, nach der das Paket nicht für den Empfänger zugänglich ist.
enabled	enabled	True	boolean	True, wenn die Zugriffssicherheit für eine Dauer nach Anzahl von Tagen aktiviert ist.
total_days	total_days	True	integer	Die Gesamtzahl der Tage, für die das Paket nach erhalt des Pakets für den Empfänger zugänglich ist.

Gibt zurück

response: object

Aktualisieren der Zertifizierungsrichtlinie für ein Dokument

Vorgangs-ID:: V4_Documents_UpdateCertifyPolicy

Geschäftsanwendungen können diese Dienst-API verwenden, um Die Signatureinstellungen für ein Dokument in einem Paket zu aktualisieren.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Paket-ID	packageId	True	integer	Paket-ID des Pakets, dem das Dokument hinzugefügt wird.
Dokument-ID	documentId	True	integer	Die ID des Dokuments, für das die Aktion ausgeführt werden soll.
enabled	enabled	True	boolean	True, wenn die Zertifizierungseinstellungen für das Dokument aktiviert werden sollen.
Erlaubnis	permission	True	string	Zertifizieren Sie die Berechtigungsstufe, die für das Dokument festgelegt werden soll. Mögliche Werte sind "NO_CHANGES_ALLOWED", "FORM_FILLING_ALLOWED" und "FORM_FILLING_WITH_ANNOTATIONS_ALLOWED".
lock_form_fields	lock_form_fields	True	boolean	True, wenn Formularfelder nach der letzten Signatur im aktuellen Dokument gesperrt werden sollen.

Gibt zurück

response: object

Aktualisieren des Platzhalters

Vorgangs-ID:: V4_Workflow_WorkflowUpdatePlaceholder

Geschäftsanwendungen können diese Dienst-API verwenden, um einen Platzhalter im Workflow zu aktualisieren. Normalerweise ist dieser Aufruf nützlich, nachdem eine Vorlage auf ein Dokument angewendet wurde und Geschäftsanwendungen die Details eines bestimmten Platzhalters innerhalb des Workflows überschreiben möchten. Die ID des Workflowdokuments wird in der Ressourcen-URL angegeben, und der Workflowplatzhalter wird durch die Reihenfolge identifiziert, in der sie dem Workflow hinzugefügt wird. Während die XML-Typdokumentvorbereitung, sind nur unterstützte Rollentypen "SIGNER", "REVIEWER" und "CARBON_COPY"

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Paket-ID	packageId	True	integer	ID des Pakets, für das der Platzhalter hinzugefügt werden soll.
Bestellung	order	True	integer	Reihenfolge des Empfängers im Workflow.
Platzhalter	placeholder		string	Der Name des neuen Platzhalters, der im Workflow hinzugefügt werden soll. Wenn kein Wert angegeben wird, wird der alte Wert beibehalten.
email_notification	email_notification		boolean	Wenn der Wert auf "true" festgelegt wird, wird eine E-Mail-Benachrichtigung an den Benutzer gesendet, wenn die Benachrichtigung im Workflow eingetroffen ist. Wenn der Wert auf "false" festgelegt wird, wird die E-Mail-Benachrichtigung nicht an den Benutzer gesendet. Wenn kein Wert angegeben wird, wird der alte Wert beibehalten.
role	role	True	string	Rolle des Empfängers, der aktualisiert werden soll. Mögliche Werte sind "SIGNER", "REVIEWER", "EDITOR","CARBON_COPY" oder "INPERSON_HOST". Wenn kein Wert angegeben wird, wird der alte Wert beibehalten. Während die XML-Typdokumentvorbereitung jedoch nur unterstützte Rollentypen "SIGNER", "REVIEWER" und "CARBON_COPY" sind
signing_order	signing_order		integer	Reihenfolge, in der der Workflow von den Empfängern signiert wird. Diese Signierreihenfolge ist wichtig, wenn der Workflowtyp auf "CUSTOM" festgelegt ist.

Gibt zurück

response: object

Anfangsfeld aktualisieren

Vorgangs-ID:: V4_Initials_UpdateInitial

Geschäftsanwendungen können diese Dienst-API verwenden, um ein Initialenfeld eines Dokuments in einem Paket zu aktualisieren.

Beachten Sie, dass alle Eingabeparameter geändert werden können. Wenn Sie die aktuelle Einstellung beibehalten möchten, wird sie im Anruf unverändert übermittelt.

Sie können daher dieselben Parameter verwenden wie beim Hinzufügen des Eingabefelds oder der Informationen, die von "Dokumentfelder abrufen" zurückgegeben werden. Letzteres kann verwendet werden, wenn eine Vorlage angewendet oder das Dokument mithilfe der GUI-Schnittstelle erstellt wurde.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Paket-ID	packageId	True	integer	Paket-ID, zu der das Dokument hinzugefügt wird.
Dokument-ID	documentId	True	integer	Die Dokument-ID, für die die Aktion ausgeführt werden soll.
field_name	field_name	True	string	Aktueller Name des Felds, das aktualisiert werden soll.
renamed_as	renamed_as		string	Aktualisierter Name des Felds, wenn die Umbenennung vorgesehen ist.
page_no	page_no	True	integer	Seitenzahl, auf der das Feld erstellt werden soll.
x	x	True	double	Linke Position des Felds in Pixel.
y	y	True	double	Oberste Position des Felds in Pixel.
width	width	True	double	Breite des Felds in Pixel.
height	height	True	double	Höhe des Felds in Pixel.

Gibt zurück

response: object

Anfangsfeld hinzufügen

Vorgangs-ID:: V4_Initials_AddInitial

Geschäftsanwendungen können diese Dienst-API verwenden, um einem Dokument in einem Paket ein Initialenfeld hinzuzufügen.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Paket-ID	packageId	True	integer	Paket-ID, zu der das Dokument hinzugefügt wird.
Dokument-ID	documentId	True	integer	Die Dokument-ID, für die die Aktion ausgeführt werden soll.
order	order	True	integer	Die Reihenfolge des Benutzers im Workflow, für den das Feld hinzugefügt wird.
page_no	page_no	True	integer	Seitenzahl, auf der das Feld erstellt werden soll.
field_name	field_name		string	Name des Felds, das hinzugefügt werden soll. Wenn nicht angegeben, weist das System dem Feld einen eindeutigen automatisch generierten Namen zu.
x	x	True	double	Linke Position des Felds in Pixel.
y	y	True	double	Oberste Position des Felds in Pixel.
width	width	True	double	Breite des Felds in Pixel.
height	height	True	double	Höhe des Felds in Pixel.

Gibt zurück

Body: AddFieldResponse

Anhang hochladen

Vorgangs-ID:: V4_Attachment_UploadAttachment

Geschäftsanwendungen können diese Dienst-API verwenden, um eine Anlage in ein Dokument hochzuladen.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Paket-ID	packageId	True	integer	Paket-ID des Pakets, dem das Dokument hinzugefügt wird.
Dokument-ID	documentId	True	integer	ID des Dokuments, dem die Anlage hinzugefügt werden muss.
Inhalt der Anlagendatei	body	True	binary	Dies ist das Dokument im unformatierten Binärformat.
Feldname	x-field-name		string	Feldname bei Bedarf. Dies ist optional und das Feld "Anlagefeld mit Feldname" wird verarbeitet. Darüber hinaus ist der empfohlene Wert für den Feldnamenparameter im Base64-codierten Format.
Dateiname	x-file-name	True	string	Es ist der Name der Datei mit der Erweiterung.
Dokumentkennwort	x-password		string	Das vom Dokumentbesitzer festgelegte Kennwort für den Zugriff auf das Dokument( falls vorhanden). Wenn das Kennwort nicht festgelegt wurde, muss der Wert null sein.
kennwort One-Time	x-otp		string	Das vom Dokumentbesitzer für den Zugriff auf das Dokument festgelegte One-Time Kennwort (OTP), falls vorhanden. Wenn der OTP nicht festgelegt wurde, muss der Wert null sein.
Ordner-ID	x-folder-id		string	Geben Sie die Ordner-ID zum Abrufen der Ordnerelemente an, wenn ein freigegebener Speicherplatzordner beteiligt ist.

Gibt zurück

Body: AddAttachmentResponse

Anhänge abrufen

Vorgangs-ID:: V4_Attachment_GetAttachments

Geschäftsanwendungen können diese Dienst-API verwenden, um die Anlagen eines Dokuments abzurufen.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Paket-ID	packageId	True	integer	Paket-ID des Pakets, dem das Dokument hinzugefügt wird.
Dokument-ID	documentId	True	integer	ID des Dokuments, dem die Anlage hinzugefügt wird.
Ordner-ID	x-folder-id		string	Geben Sie die Ordner-ID zum Abrufen der Ordnerelemente an, wenn ein freigegebener Speicherplatzordner beteiligt ist.

Gibt zurück

response: array of GetAttachmentResponse

Anlage herunterladen

Vorgangs-ID:: V4_Attachment_DownloadAttachment

Geschäftsanwendungen können diese Dienst-API verwenden, um die Anlage eines Dokuments herunterzuladen.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Paket-ID	packageId	True	integer	Paket-ID des Pakets, dem das Dokument hinzugefügt wird.
Dokument-ID	documentId	True	integer	ID des Dokuments, dem die Anlage hinzugefügt wird.
Anlagen-ID	attachment_id	True	integer	ID der Anlage.
Ordner-ID	x-folder-id		string	Geben Sie die Ordner-ID zum Abrufen der Ordnerelemente an, wenn ein freigegebener Speicherplatzordner beteiligt ist.

Gibt zurück

response: object

Anlage löschen

Vorgangs-ID:: V4_Attachment_DeleteAttachment

Geschäftsanwendungen können diese Dienst-API verwenden, um die Anlage eines Dokuments zu löschen.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Paket-ID	packageId	True	integer	Paket-ID des Pakets, dem das Dokument hinzugefügt wird.
Dokument-ID	documentId	True	integer	ID des Dokuments, dem die Anlage hinzugefügt wird.
Anlagen-ID	attachment_id	True	integer	ID der Anlage.
Ordner-ID	x-folder-id		string	Geben Sie die Ordner-ID zum Abrufen der Ordnerelemente an, wenn ein freigegebener Speicherplatzordner beteiligt ist.

Gibt zurück

response: object

Ausfüllen von Formularfeldern

Vorgangs-ID:: V4_Fields_FillFormFields

Geschäftsanwendungen können diese Dienst-API verwenden, um ein oder mehrere Formularfelder in einem Dokument von einem bestimmten Benutzer in der Reihenfolge auszufüllen.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Paket-ID	packageId	True	integer	Paket-ID, zu der das Dokument hinzugefügt wird.
Dokument-ID	documentId	True	integer	Die ID des Dokuments.
auto_save	auto_save	True	boolean	Der Standardwert ist „false“. True, wenn die Formularfelder ohne Benutzereingriff gespeichert werden, z. B. beim Schließen des Dokuments oder Beim Drücken zurück. Für signieren, Initialen, In-Personen, Überprüfen, Absenden von Aktionen ist der Wert falsch.
field_name	field_name	True	string	Eindeutiger Bezeichner des Felds im Dokument.
value	value		string	Wert des Felds, das im Dokument gespeichert werden soll.
field_name	field_name	True	string	Eindeutiger Bezeichner des Felds im Dokument.
radio_group_name	radio_group_name		string	Gruppenname, zu dem das Optionsfeld gehört.
value	value	True	boolean	Wert des Felds, das im Dokument gespeichert werden soll.
field_name	field_name	True	string	Eindeutiger Bezeichner des Felds im Dokument.
value	value	True	boolean	Wert des Felds, das im Dokument gespeichert werden soll.
field_name	field_name	True	string	Eindeutiger Bezeichner des Felds im Dokument.
value	value		string	Wert des Felds, das im Dokument gespeichert werden soll.
field_name	field_name	True	string	Eindeutiger Bezeichner des Felds im Dokument.
value	value		string	Wert des Felds, das im Dokument gespeichert werden soll.
Dokumentkennwort	x-password		string	Das vom Dokumentbesitzer festgelegte Kennwort für den Zugriff auf das Dokument( falls vorhanden). Wenn das Kennwort nicht festgelegt wurde, muss der Wert null sein.
One-Time Kennwort (OTP)	x-otp		string	Das vom Dokumentbesitzer für den Zugriff auf das Dokument festgelegte One-Time Kennwort (OTP), falls vorhanden. Wenn der OTP nicht festgelegt wurde, muss der Wert null sein.
Ordner-ID	x-folder-id		string	Geben Sie die Ordner-ID zum Abrufen der Ordnerelemente an, wenn ein freigegebener Speicherplatzordner beteiligt ist.

Gibt zurück

response: object

AutoPlace-Felder

Vorgangs-ID:: V4_Fields_AutoPlace

Geschäftsanwendungen können diese API aufrufen, um einem Dokument basierend auf dem angegebenen Suchkriterium Signatur- oder benutzerdefinierte Formularfelder hinzuzufügen. Die Platzierungsoptionen sind: links, rechts, oben und unten. Das Dokument wird durchsucht, und alle Instanzen der erfüllten Suchkriterien werden verarbeitet. Auf diese Weise können Sie mehrere Felder mit einem Aufruf hinzufügen. Laden Sie z. B. ein Dokument hoch, und platzieren Sie automatisch ein Signaturfeld rechts neben allen Instanzen des Worts "Hier signieren:". Dies spart Zeit und stellt sicher, dass vom Workflow keine Signaturen verpasst werden.

Der API-Aufruf unterstützt alle Arten von Feldern; d. h. elektronisch, digital, persönlich, Initialen und Textfeld usw.

Darüber hinaus unterstützt der API-Aufruf die Variable "order". Dies bedeutet, dass Sie einem einzelnen Benutzer automatisch eine Reihe von Signaturfeldern zuweisen können. Daher kann der Aufruf wiederholt werden, um Signaturfelder mehreren Benutzern im Workflow zuzuweisen.

Mindestens ein Benutzer muss in einem Workflow vorhanden sein, bevor signaturfelder auf diese Weise dem Dokument hinzugefügt werden können. Die Bestellnummer entspricht dem Empfänger im Workflow. Daher muss diese Zahl gleich oder kleiner als die Gesamtanzahl der Benutzer im Workflow sein. Im folgenden Beispiel wird dieses neue Signaturfeld der ersten Person im Workflow zugewiesen.

Dieser API-Aufruf kann mehrmals im selben Dokument verwendet werden. Der Grund dafür besteht darin, mehrere Unterzeichner in einem Dokument zu erfüllen. Der Empfänger oder Signatory wird durch die im Aufruf übergebene Variable "order" identifiziert.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Paket-ID	packageId	True	integer	Die ID des Pakets, dem das Dokument hinzugefügt wird.
Dokument-ID	documentId	True	integer	Die ID des Dokuments, für das die Felder angefordert werden.
search_text	search_text		string	Word, die im Dokument durchsucht werden müssen.
order	order	True	integer	Reihenfolge des Benutzers, dem die Felder automatisch zugewiesen werden. Workflow in SigningHub sortiert Empfänger. Diese Liste beginnt mit "1" für den ersten benannten Signierer.
Platzierung	placement		string	Wenn der Text gefunden wird, müssen Felder im Dokument platziert werden. Die Platzierung des Felds kann in diesem Attribut erwähnt werden. Mögliche Werte der Platzierung eines Felds sind LEFT, RIGHT, TOP, BOTTOM. Wenn kein Wert angegeben wird, ist der Standardwert LINKS.
field_type	field_type		string	Typ des Felds, das im Dokument erstellt werden soll. Mögliche Werte sind "SIGNATURE", "IN_PERSON_SIGNATURE", "INITIALS", "TEXT", "NUMBER" ,"NAME", "EMAIL", "COMPANY", "JOBTITLE", "RADIOBOX", "CHECKBOX", "DATE", "ATTACHMENT"
level_of_assurance	level_of_assurance		array of string	Stufe der Zusicherung, die aktualisiert werden soll. Mögliche Werte sind "ELECTRONIC_SIGNATURE", "ELECTRONIC_SEAL", "ADVANCED_ELECTRONIC_SEAL", "QUALIFIED_ELECTRONIC_SEAL", "ADVANCED_ELECTRONIC_SIGNATURE", "HIGH_TRUST_ADVANCED", "QUALIFIED_ELECTRONIC_SIGNATURE"
x	x	True	double	Linke Position des Felds in Pixel.
y	y	True	double	Oberste Position des Felds in Pixel.
width	width	True	double	Breite des Felds in Pixel.
height	height	True	double	Höhe des Felds in Pixel.
Platzhalter	placeholder		string	Geben Sie im Fall einer obligatorischen Anlage eine Notiz an.
radio_group_name	radio_group_name		string	Der Gruppenname ist nur erforderlich, wenn ein Feld vom Typ "Radio Box" hinzugefügt wird, um mehrere Optionsfelder zusammen zu gruppieren.
format	format		string	Textformat des Felds. Wird nur für das Datumstypfeld verwendet. Mögliche Werte sind m/d m/d/yy m/d/jjjj mm/tt/jj mm/tt/jjjj mm/jj mm/jjjj d-mmm d-mmm-yyy d-mmm-jjjj tt-mmm-yyy tt-mmm-yyyyy yy-mm-dd yyyy-mm-dd mmm-yy mmm-jjjj mmmm-jj mmmm-jjjj mmmm d, jjjj tt/mm/jj ddmmmyyyy
value	value		string	Wert, den der Benutzer im Feld anzeigen möchte.
Maximallänge	max_length	True	integer	Maximale Länge des zulässigen Werts im Feld. Muss zwischen 1 und 9999
validation_rule	validation_rule		string	Mindestens eine Regel für die Überprüfung der Felder sind mögliche Werte "OBLIGATORISCH" oder "OPTIONAL".
required	required	True	boolean
type	type		string	Gibt den Typ der Gültigkeitsprüfungsregel an, der derzeit immer auf EQUALS für Textfeld festgelegt ist.
value	value		string	Stellt den Wert dar, der für die Überprüfung verwendet wird.
Name	name		string	Name der schriftart, die für das Textfeld ausgewählt ist. Mögliche Werte sind "COURIER", "HELVETICA".
Größe	size		string	Der Schriftgrad, der für das Textfeld ausgewählt ist. Mögliche Werte sind 8, 10, 12, 14, 16, 18, 20
embedded_size	embedded_size		string	Schriftgrad im ursprünglichen PDF-Dokument.
Mehrzeile	multiline	True	boolean	Dies gehört zum Textfeldtyp "Textbereich", und wenn dieser wert auf "true" festgelegt ist, wird das Textfeld mit der Option "Mehrzeiliges" erstellt.

Gibt zurück

response: array of AutoPlaceFieldsResponse

CheckBox-Feld aktualisieren

Vorgangs-ID:: V4_Checkbox_UpdateCheckBox

Geschäftsanwendungen können diese Dienst-API verwenden, um ein Kontrollkästchenfeld eines Dokuments in einem Paket zu aktualisieren.

Beachten Sie, dass alle Eingabeparameter geändert werden können. Wenn Sie die aktuelle Einstellung beibehalten möchten, wird sie im Anruf unverändert übermittelt. Sie können daher dieselben Parameter verwenden wie beim Hinzufügen des Eingabefelds oder der Informationen, die von "Dokumentfelder abrufen" zurückgegeben werden. Letzteres kann verwendet werden, wenn eine Vorlage angewendet oder das Dokument mithilfe der GUI-Schnittstelle erstellt wurde.

Breite und Höhe können nicht aktualisiert werden. Sie bleiben gleich, als sie hinzugefügt wurden.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Paket-ID	packageId	True	integer	Paket-ID, zu der das Dokument hinzugefügt wird.
Dokument-ID	documentId	True	integer	Die Dokument-ID, für die die Aktion ausgeführt werden soll.
field_name	field_name	True	string	Aktueller Name des Felds, das aktualisiert werden soll.
renamed_as	renamed_as		string	Aktualisierter Name des Felds, wenn die Umbenennung vorgesehen ist.
page_no	page_no	True	integer	Seitenzahl, auf der das Feld erstellt werden soll.
value	value		string	Wert des Felds. Mögliche Werte sind "true" oder "false"
x	x	True	double	Linke Position des Felds in Pixel.
y	y	True	double	Oberste Position des Felds in Pixel.
width	width	True	double	Breite des Felds in Pixel.
height	height	True	double	Höhe des Felds in Pixel.
validation_rule	validation_rule		string	Mindestens eine Regel für die Überprüfung der Felder sind mögliche Werte "OBLIGATORISCH" oder "OPTIONAL".
Ordner-ID	x-folder-id		string	Geben Sie die Ordner-ID zum Abrufen der Ordnerelemente an, wenn ein freigegebener Speicherplatzordner beteiligt ist.

Gibt zurück

response: object

CheckBox-Feld hinzufügen

Vorgangs-ID:: V4_Checkbox_AddCheckBox

Geschäftsanwendungen können diese Dienst-API verwenden, um einem Dokument in einem Paket ein Kontrollkästchen hinzuzufügen.

Wenn keine Parameter für Breite und Höhe angegeben werden, wird eine Standardgröße von 10 x 10 zugewiesen. Wenn entweder Breite oder Höhe (oder beide) bereitgestellt wird, vergleicht das System diese bereitgestellten Werte miteinander. Der größere Wert zwischen Breite und Höhe wird beiden Dimensionen zugewiesen.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Paket-ID	packageId	True	integer	Paket-ID, zu der das Dokument hinzugefügt wird.
Dokument-ID	documentId	True	integer	Die Dokument-ID, für die die Aktion ausgeführt werden soll.
order	order	True	integer	Die Reihenfolge des Benutzers im Workflow, für den das Feld hinzugefügt wird.
page_no	page_no	True	integer	Seitenzahl, auf der das Feld erstellt werden soll.
field_name	field_name		string	Der Name des angegebenen Felds, das hinzugefügt werden soll. Wenn nicht angegeben, weist das System dem Feld einen eindeutigen automatisch generierten Namen zu.
value	value		string	Wert des Felds. Mögliche Werte sind "true" oder "false"
x	x	True	double	Linke Position des Felds in Pixel.
y	y	True	double	Oberste Position des Felds in Pixel.
width	width	True	double	Breite des Felds in Pixel.
height	height	True	double	Höhe des Felds in Pixel.
validation_rule	validation_rule		string	Mindestens eine Regel für die Überprüfung der Felder sind mögliche Werte "OBLIGATORISCH" oder "OPTIONAL".

Gibt zurück

Body: AddFieldResponse

Digitale Signaturfeld aktualisieren

Vorgangs-ID:: V4_Signature_UpdateSignature

Geschäftsanwendungen können diese Dienst-API verwenden, um ein digitales Signaturfeld eines Dokuments in einem Paket zu aktualisieren.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Paket-ID	packageId	True	integer	Paket-ID, zu der das Dokument hinzugefügt wird.
Dokument-ID	documentId	True	integer	Die Dokument-ID, für die die Aktion ausgeführt werden soll.
field_name	field_name	True	string	Aktueller Name des Felds, das aktualisiert werden soll.
level_of_assurance	level_of_assurance		array of string	Stufe der Zusicherung, die aktualisiert werden soll. Mögliche Werte sind "ELECTRONIC_SIGNATURE", "ELECTRONIC_SEAL", "ADVANCED_ELECTRONIC_SEAL", "QUALIFIED_ELECTRONIC_SEAL", "ADVANCED_ELECTRONIC_SIGNATURE", "HIGH_TRUST_ADVANCED", "QUALIFIED_ELECTRONIC_SIGNATURE"
renamed_as	renamed_as		string	Aktualisierter Name des Felds, wenn die Umbenennung des Felds vorgesehen ist.
page_no	page_no	True	integer	Seitenzahl, auf der das Feld erstellt werden soll.
x	x	True	double	Linke Position des Felds in Pixel.
y	y	True	double	Oberste Position des Felds in Pixel.
width	width	True	double	Breite des Felds in Pixel.
height	height	True	double	Höhe des Felds in Pixel.
Bildschirm	display		string	Sichtbarkeit des zu aktualisierenden Felds, mögliche Werte sind "VISIBLE" und "INVISIBLE"
enabled	enabled	True	boolean	True, wenn die Authentifizierung für das Feld aktiviert ist. Andernfalls ist der Wert FALSE.
enabled	enabled	True	boolean	True, wenn die OTP-Authentifizierung per SMS/E-Mail für das Feld aktiviert ist. Andernfalls ist der Wert FALSE.
mobile_number	mobile_number		string	Mobiltelefonnummer des Empfängers, dem das Feld zugewiesen ist.
enabled	enabled	True	boolean	True, wenn die TOTP-Authentifizierung für das Feld aktiviert ist. Andernfalls ist der Wert FALSE.
Ordner-ID	x-folder-id		string	Geben Sie die Ordner-ID zum Abrufen der Ordnerelemente an, wenn ein freigegebener Speicherplatzordner beteiligt ist.

Gibt zurück

response: object

Dokument ablehnen

Vorgangs-ID:: V4_Package_Decline

Geschäftsanwendungen können diese Dienst-API verwenden, um ein Dokument von einem bestimmten Benutzer in der Reihenfolge abzulehnen.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Paket-ID	packageId	True	integer	Die ID des Pakets, das abgelehnt werden soll.
Grund	reason		string	Grund, der vom Benutzer zur Ablehnung bereitgestellt wird.
Ordner-ID	x-folder-id		string	Geben Sie die Ordner-ID zum Abrufen der Ordnerelemente an, wenn ein freigegebener Speicherplatzordner beteiligt ist.

Gibt zurück

response: object

Dokument aus Bibliothek hinzufügen oder aktualisieren

Vorgangs-ID:: V4_Documents_UploadFromLibrary

Geschäftsanwendungen können diese Dienst-API verwenden, um ein Dokument aus der Bibliothek des Benutzers zu einem Paket hinzuzufügen. Die Paket-ID wird in der URL angegeben, die ID des Dokuments sollte auch als "document_id" in der Ressourcen-URL angegeben werden, um das zu kopierende Bibliotheksdokument zu identifizieren.

Beachten Sie, dass bereits ein Paket vorhanden sein muss, bevor Sie mithilfe dieses Aufrufs ein Dokument hinzufügen können.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Paket-ID	packageId	True	integer	Die Paket-ID des Pakets, dem das Dokument hinzugefügt wird.
Dokument-ID	documentId	True	integer	Die Dokument-ID der Bibliothek, die hinzugefügt/aktualisiert werden muss
Alte Dokument-ID	x-document-id		string	ID des alten Dokuments des aktuellen Pakets, das aktualisiert werden muss

Gibt zurück

Body: UploadDocumentLibraryResponse

Dokument genehmigen

Vorgangs-ID:: V4_Package_Approve

Geschäftsanwendungen können diese Dienst-API verwenden, um ein Dokument von einem bestimmten Benutzer in der Reihenfolge zu genehmigen.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Paket-ID	packageId	True	integer	Die ID des zu genehmigenden Pakets.
Grund	reason		string	Der Grund für die Genehmigung eines Pakets.
Kennwort für den Dokumentzugriff	x-password		string	Das vom Dokumentbesitzer festgelegte Kennwort für den Zugriff auf das Dokument( falls vorhanden). Wenn das Kennwort nicht festgelegt wurde, muss der Wert null sein.
DokumentOne-Time Kennwort	x-otp		string	Das vom Dokumentbesitzer für den Zugriff auf das Dokument festgelegte One-Time Kennwort (OTP), falls vorhanden. Wenn der OTP nicht festgelegt wurde, muss der Wert null sein.
Ordner-ID	x-folder-id		string	Geben Sie die Ordner-ID zum Abrufen der Ordnerelemente an, wenn ein freigegebener Speicherplatzordner beteiligt ist.

Gibt zurück

response: object

Dokument löschen

Vorgangs-ID:: V4_Documents_DeleteDocument

Geschäftsanwendungen können diese Dienst-API verwenden, um ein Dokument in einem Paket zu löschen.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Paket-ID	packageId	True	integer	Paket-ID des Pakets, dem das Dokument hinzugefügt wird.
Dokument-ID	documentId	True	integer	ID des zu löschenden Dokuments.

Gibt zurück

Body: DocumentResponse

Dokument signieren

Vorgangs-ID:: V4_Signing_SignDocument

Geschäftsanwendungen können diese Dienst-API verwenden, um ein Dokument (sowohl elektronisch als auch digital) zu signieren, ohne das Dokument mithilfe von SigningHub für den Endbenutzer anzuzeigen. Beispielsweise kann eine Geschäftsanwendung eine andere Methode zum Anzeigen des Dokuments für den Benutzer haben, und nur die Signaturfunktionalität von SigningHub ist erforderlich, oder für Massenvorgänge kann es gerechtfertigt sein, sich zu signieren, ohne dass der Benutzer jedes Dokument einzeln anzeigen und genehmigen muss. Wenn vor dem Signieren Änderungen im Dokument gespeichert werden sollen, sollte die Api für Füllformularfelder aufgerufen werden, bevor die Signierdokument-API aufgerufen wird. Beachten Sie, dass alle obligatorischen Eingabefelder für ein Dokument abgeschlossen werden müssen, bevor diese API erfolgreich abgeschlossen wird.

Das Signatory wird durch das zugriffstoken identifiziert, das im Aufruf angezeigt wird. Daher ist vor dem Aufruf eine Authentifizierung des Signatorys erforderlich. Sie können sich nicht als Unternehmensadministrator mit der Bereichsvariable authentifizieren und ein Dokument im Namen eines Benutzers signieren. Das Zugriffstoken muss aufgrund der direkten Authentifizierung an das Signatory ausgestellt werden.

Wenn dieser Aufruf abgeschlossen ist, ist es wichtig, dass, wenn der Signator der letzte Signierer für ein Dokument war, das der Aufruf der Finish Document API aufgerufen wird. Der Grund dafür ist, dass das Dokument ohne Aufrufen dieser API im Status "In Bearbeitung" für den Dokumentbesitzer verbleibt. Nachdem die API aufgerufen wurde, wird der Status für den Dokumentbesitzer in "Abgeschlossen" geändert.

Nachdem das Dokument signiert wurde, kann die Überprüfungsantwort über die API "Dokumentüberprüfung abrufen " angezeigt werden.

First- oder Second Factor OTP-Verwendung für die Authentifizierung

Wenn die OTP-Authentifizierung für den serverseitigen Signaturvorgang aktiviert ist, müssen Clientanwendungen mithilfe des OTP-API-Aufrufs einen OTP für die Mobiltelefonnummer generieren. Die entsprechenden Geschäftsanwendungen müssen das OTP aus der Verwendung abrufen und übermitteln, wenn der API-Aufruf ausgeführt wird. Dies erfolgt mithilfe des "x-otp"-Headers in der Anforderung.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Paket-ID	packageId	True	integer	Der Bezeichner des Pakets, das das Dokument für die Signatur enthält.
Dokument-ID	documentId	True	integer	Bezeichner des zu signierten Dokuments.
field_name	field_name	True	string	Eindeutiger Bezeichner des Signaturfelds im Dokument.
hand_signature_image	hand_signature_image		string	Base64-codiertes Zeichenfolgenbild der sichtbaren Signaturdarstellung, das auf dem Dokument platziert wird. Beachten Sie, dass dies mithilfe dieses Anrufs aus den persönlichen Einstellungen des Benutzers abgerufen werden kann. (Die Antwort ist binär, sodass die Geschäftsanwendung sie dann base64 codieren muss, bevor sie in diesem API-Aufruf übermittelt wird.)
hand_signature_method	hand_signature_method		integer	0 = DRAW 1 = TEXT 2 = UPLOAD 3 = SIGNATURE_PAD 4 = NONE
signing_reason	signing_reason		string	Grund für die vom Empfänger bereitgestellte Signatur. Hinweis: Verpflichtungstypanzeige für XML-Dokumente
signing_location	signing_location		string	Gebietsschema des vom Empfänger bereitgestellten Signierers.
contact_information	contact_information		string	Kontaktinformationen des vom Empfänger bereitgestellten Signierers.
user_name	user_name		string	Name des vom Empfänger bereitgestellten Signierers. Beachten Sie, dass dies nur für persönliche Signaturvorgänge gilt.
user_password	user_password		string	Vom Benutzer bereitgestelltes Kennwort, das den Signatureinstellungen des Benutzers unterliegt.
appearance_design	appearance_design		string	Der Name der Signaturdarstellung, die vom Benutzer zum Signieren bereitgestellt wird. Falls kein Darstellungsname angegeben wird, wird die standardmäßige ausgewählte Darstellung verwendet. Mögliche Werte sind "COMPANY_LOGO","DETAILED_SIGNATURE","HAND_SIGNATURE"
signing_capacity	signing_capacity		string	Name des Zertifizierungsprofils/Signierkapazitäts, mit dem das Dokument signiert werden soll. Wenn nicht angegeben, wird die Standardkapazität zum Signieren verwendet. Der angegebene Name muss genau mit dem tatsächlichen Profil übereinstimmen, da die Groß-/Kleinschreibung beachtet wird.
skip_verification	skip_verification	True	boolean	Wenn sie als wahr festgelegt ist, wird keine Signaturüberprüfung im Antworttext zurückgegeben. Standardwert für diesen Parameter, der auf "false" festgelegt ist.
signing_server	signing_server		string	Name des Signaturservers, auf dem das Dokument signiert werden soll.
mechanism	mechanism		string	Mechanismus der Authentifizierung. Mögliche Werte für Mechanismus sind: AUTHENTICATION_PASSWORD, AUTHENTICATION_ACTIVE_DIRECTORY, AUTHENTICATION_AZURE_ACTIVE_DIRECTORY, AUTHENTICATION_OFFICE_365, AUTHENTICATION_OAUTH2, AUTHENTICATION_OIDC
password	password		string	Es handelt sich um einen optionalen Parameter, ist jedoch nur erforderlich, wenn "AUTHENTICATION_PASSWORD" als Parameterwert unter "Mechanismus" verwendet wird.
token	token		string	Es handelt sich um einen optionalen Parameter, der vom Server eines Drittanbieters empfangen wird, jedoch nur bei Verwendung von "AUTHENTICATION_AZURE_ACTIVE_DIRECTORY", "AUTHENTICATION_OFFICE_365", "AUTHENTICATION_OAUTH2" "AUTHENTICATION_OIDC" "AUTHENTICATION_GOOGLE" "AUTHENTICATION_LINKED_IN" "AUTHENTICATION_SALES_FORCE" als Parameterwert unter "Mechanismus" erforderlich ist.
user_identifier	user_identifier		string	Es ist ein optionaler Parameter, ist jedoch nur erforderlich, wenn "AUTHENTICATION_ACTIVE_DIRECTORY" oder "AUTHENTICATION_SAML" als Parameterwert unter "Mechanismus" verwendet wird.
id	id		string	Es ist ein optionaler Parameter, ist aber nur erforderlich, wenn "AUTHENTICATION_SALES_FORCE" oder "AUTHENTICATION_IDFY" als Parameterwert unter "Mechanismus" verwendet wird. Für "AUTHENTICATION_IDFY" ist die Anforderungs-ID
code_verifier	code_verifier		string	CodeÜberprüfung, wenn PKCE für den Client aktiviert ist.
Nonce	nonce		string	Nonce-Wert, wenn er für den Client aktiviert ist.
One-Time Kennwort (OTP)	x-otp		string	OTP wird als zweite Faktorauthentifizierung für den Signaturvorgang verwendet.
Ordner-ID	x-folder-id		string	Geben Sie die Ordner-ID zum Abrufen der Ordnerelemente an, wenn ein freigegebener Speicherplatzordner beteiligt ist.
Mobiler Absender	x-mobile		string	Definieren des Absenders(Web/Mobile) der Anforderung/Aktion

Gibt zurück

Body: SignDocumentResponse

Dokument umbenennen

Vorgangs-ID:: V4_Documents_RenameDocument

Geschäftsanwendungen können diese Dienst-API verwenden, um ein Dokument in einem Paket umzubenennen.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Paket-ID	packageId	True	integer	Paket-ID des Pakets, dem das Dokument hinzugefügt wird.
Dokument-ID	documentId	True	integer	Die ID des Dokuments, für das die Aktion ausgeführt werden soll.
document_name	document_name	True	string	Neuer Name des Dokuments.

Gibt zurück

Body: DocumentResponse

Dokument zurückrufen

Vorgangs-ID:: V4_Workflow_RecallWorkflow

Geschäftsanwendungen können diese Dienst-API verwenden, um einen laufenden Workflow zu beenden. Die Dokument-ID wird in der Ressourcen-URL angegeben. Nach dem Rückruf wird der Dokumentstatus automatisch in "ENTWURF" geändert.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Paket-ID	packageId	True	integer	Die ID des Pakets, das zurückgerufen werden soll.

Gibt zurück

response: object

Dokument übermitteln

Vorgangs-ID:: V4_Package_Submit

Eine der SigningHub-Rollen wird als "Editor" bezeichnet. Dadurch kann ein Empfänger Eingabefelder in einem Dokument bearbeiten, erfordert jedoch keine Signatur. Nach Abschluss des Vorgangs übermittelt der Empfänger seine Änderungen. Die in der GUI verwendete Schaltfläche heißt "Submit".

Dies ist der entsprechende Vorgang für einen Editor, um ihre Änderungen über einen API-Aufruf zu übermitteln.

Klicken Sie auf "SigningHub-Rollen ", um eine Beschreibung aller verfügbaren Workflowempfängerrollen anzuzeigen.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Paket-ID	packageId	True	integer	Die SignHub-Paket-ID, die das zu übermittelnde Dokument enthält.
Kennwort für den Dokumentzugriff	x-password		string	Das vom Dokumentbesitzer festgelegte Kennwort für den Zugriff auf das Dokument( falls vorhanden). Wenn das Kennwort nicht festgelegt wurde, muss der Wert null sein.
DokumentOne-Time Kennwort	x-otp		string	Das vom Dokumentbesitzer für den Zugriff auf das Dokument festgelegte One-Time Kennwort (OTP), falls vorhanden. Wenn der OTP nicht festgelegt wurde, muss der Wert null sein.
Ordner-ID	x-folder-id		string	Geben Sie die Ordner-ID zum Abrufen der Ordnerelemente an, wenn ein freigegebener Speicherplatzordner beteiligt ist.

Gibt zurück

response: object

Dokumentfeld löschen

Vorgangs-ID:: V4_Fields_DeleteDocumentField

Geschäftsanwendungen können diese Dienst-API verwenden, um ein Dokumentfeld in einem Paket zu löschen.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Paket-ID	packageId	True	integer	Paket-ID, zu der das Dokument hinzugefügt wird.
Dokument-ID	documentId	True	integer	Die Dokument-ID, für die die Aktion ausgeführt werden soll.
field_name	field_name	True	string	Name des zu löschenden Felds.

Gibt zurück

response: object

Dokumentfeld zuweisen

Vorgangs-ID:: V4_Fields_AutoAssignField

Geschäftsanwendungen können diese Dienst-API verwenden, um Benutzern Eingabefelder, z. B. Signaturfelder, zuzuweisen und somit die Signierreihenfolge zu definieren. Die Felder müssen bereits im Dokument vorhanden sein, und die Benutzer müssen im Workflow vorhanden sein. Die ID des Workflowdokuments wird zusammen mit dem Paketbezeichner in der Ressourcen-URL angegeben.

Wenn sich Die Empfänger in einem Workflow befinden, werden sie nummeriert, beginnend bei einem Workflow und nach oben für jedes zusätzliche. Wenn also drei Benutzer in einem Workflow vorhanden sind, werden sie "1", "2" und "3" respektvoll nummeriert. Mit diesem API-Aufruf können Sie einem Eingabefeld im Dokument einen Benutzer anhand seiner Workflowreihenfolgenummer zuweisen.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Paket-ID	packageId	True	integer	Paket-ID, zu der das Dokument hinzugefügt wird.
Dokument-ID	documentId	True	integer	Die Dokument-ID, für die der Workflowbenutzer aktualisiert werden muss.
field_name	field_name	True	string	Name des Signaturfelds, das zugewiesen werden soll.
radio_group_name	radio_group_name		string	Gruppenname für Optionsfeld angeben
order	order	True	integer	Die Reihenfolge des Benutzers im Workflow, dem das Feld zugewiesen wird.
level_of_assurance	level_of_assurance		array of string	Stufe der Zusicherung, die hinzugefügt werden soll. Mögliche Werte sind "ELECTRONIC_SIGNATURE", "ELECTRONIC_SEAL", "ADVANCED_ELECTRONIC_SEAL", "QUALIFIED_ELECTRONIC_SEAL", "ADVANCED_ELECTRONIC_SIGNATURE", "HIGH_TRUST_ADVANCED", "QUALIFIED_ELECTRONIC_SIGNATURE"

Gibt zurück

response: object

Dokumentfelder abrufen

Vorgangs-ID:: V4_Fields_GetAllDocumentFields

Geschäftsanwendungen können diese Dienst-API verwenden, um Dokumentfelder abzurufen, z. B. Initialen, Personen, Signaturfelder oder Formularfelder.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Paket-ID	packageId	True	integer	Die ID des Pakets, dem das Dokument hinzugefügt wird.
Dokument-ID	documentId	True	integer	Die ID des Dokuments, für das die Felder angefordert werden.
Seite Nein	pageNo	True	integer	Seiten-Nr. des Dokuments, für das die Felder angefordert werden. Wenn keine Seitenzahl bereitgestellt wird, werden Felder des gesamten Dokuments zurückgegeben.
Urheber	x-mobile		string	Definieren des Absenders(Web/Mobile) der Anforderung/Aktion

Gibt zurück

Body: FieldsResponse

Dokumentpaket freigeben

Vorgangs-ID:: V4_Workflow_StartWorkflow

Geschäftsanwendungen können diese Dienst-API verwenden, um ein Dokumentpaket mit den Signierern zu teilen und einen neuen Workflow zu starten. Das Dokument sollte bereits vorbereitet worden sein, indem eine Vorlage angewendet und optional die in der Vorlage definierten Benutzer und Aktionen aktualisiert werden. Die freigegebene Paket-ID wird in der Ressourcen-URL angegeben.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Paket-ID	packageId	True	integer	Das dokumentpaket, das freigegeben werden soll.

Gibt zurück

response: array of StartWorkflowResponse

Enterprise-Vorlagen abrufen

Vorgangs-ID:: V4_Template_GetEnterpriseTemplates

Geschäftsanwendungen können diese Dienst-API verwenden, um eine Liste der Unternehmensvorlagen des aktuellen Benutzers abzurufen. Dies bedeutet, dass der Unternehmensadministrator oder der Unternehmensbenutzer, wenn die Variable "Scope" in der Authentifizierungsanforderung verwendet wurde.

Es ist möglich, basierend auf dem Kriterium zu suchen, das unter der Kopfzeile "x-search-text" angegeben ist.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Anzahl der Datensätze pro Seite	recordPerPage	True	integer	Die Gesamtzahl der Datensätze, die auf einer Seite abgerufen werden sollen.
Seitenzahl, die abgerufen werden soll	pageNo	True	integer	Seitenzahl, die abgerufen werden soll.
Sortieren nach Spalten	sort-by		string	Sortieren Sie das Ergebnis nach möglichen Werten, die oben erwähnt werden.
Sortieren des Resultsets	asc		boolean	Ordnen Sie das Resultset nach aufsteigender oder absteigender Reihenfolge an.
Filtern nach Vorlagen-IDs	id		array	Suchen nach Vorlagen-IDs.
Suchtext	x-search-text		string	Suchen Sie bei Bedarf Text. Dies ist optional, ohne dass die gesamte Liste zurückgegeben wird. Darüber hinaus ist der empfohlene Wert für den Suchtextparameter im Base64-codierten Format.
Gesamtanzahl von Datensätzen	x-total-records		string	Die Gesamtzahl der Datensätze, die mit den angegebenen Suchkriterien gefunden wurden.

Gibt zurück

response: array of EnterpriseTemplateResponse

Feld "Digitale Signatur hinzufügen"

Vorgangs-ID:: V4_Signature_AddSignature

Geschäftsanwendungen können diese Dienst-API verwenden, um einem Dokument in einem Paket ein digitales Signaturfeld hinzuzufügen.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Paket-ID	packageId	True	integer	Die Paket-ID, für die Workflowdetails aktualisiert werden müssen.
Dokument-ID	documentId	True	integer	Die Dokument-ID, in der das Feld hinzugefügt werden soll.
order	order	True	integer	Reihenfolge des Empfängers, für den das Feld erstellt wird.
page_no	page_no	True	integer	Seitenzahl, bei der das Feld erstellt werden soll.
field_name	field_name		string	Name des Felds, das hinzugefügt werden soll. Wenn nicht angegeben, weist das System dem Feld einen eindeutigen automatisch generierten Namen zu.
level_of_assurance	level_of_assurance		array of string	Stufe der Zusicherung, die hinzugefügt werden soll. Mögliche Werte sind "ELECTRONIC_SIGNATURE", "ELECTRONIC_SEAL", "ADVANCED_ELECTRONIC_SEAL", "QUALIFIED_ELECTRONIC_SEAL", "ADVANCED_ELECTRONIC_SIGNATURE", "HIGH_TRUST_ADVANCED", "QUALIFIED_ELECTRONIC_SIGNATURE"
x	x	True	double	Linke Position des Felds in Pixel.
y	y	True	double	Oberste Position des Felds in Pixel.
width	width	True	double	Breite des Felds in Pixel.
height	height	True	double	Höhe des Felds in Pixel.
Bildschirm	display		string	Sichtbarkeit des hinzuzufügenden Felds, mögliche Werte sind "VISIBLE" und "INVISIBLE"
enabled	enabled	True	boolean	True, wenn die Authentifizierung für das Feld aktiviert ist. Andernfalls ist der Wert FALSE.
enabled	enabled	True	boolean	True, wenn die OTP-Authentifizierung per SMS/E-Mail für das Feld aktiviert ist. Andernfalls ist der Wert FALSE.
mobile_number	mobile_number		string	Mobiltelefonnummer des Empfängers, dem das Feld zugewiesen ist.
enabled	enabled	True	boolean	True, wenn die TOTP-Authentifizierung für das Feld aktiviert ist. Andernfalls ist der Wert FALSE.

Gibt zurück

Body: SignatureFieldResponse

Freigegebenen Speicherplatz abrufen

Vorgangs-ID:: V4_WorkSpace_GetSharedSpace

Geschäftsanwendungen können diese Dienst-API verwenden, um einen bestimmten freigegebenen Speicherplatz abzurufen. Diese API gibt Informationen zum freigegebenen Raum, zum Besitzer und zum Mitarbeiter zurück.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
ID des freigegebenen Raums	id	True	integer	ID des freigegebenen Speicherplatzes, den Sie abrufen möchten

Gibt zurück

Body: WorkSpaceResponse

Freigegebenen Speicherplatz aktualisieren

Vorgangs-ID:: V4_WorkSpace_UpdateSharedSpace

Geschäftsanwendungen können diese Dienst-API verwenden, um freigegebenen Speicherplatz zu aktualisieren. Die Verfügbarkeit der Aktualisierung freigegebener Räume unterliegt der zugewiesenen Unternehmensbenutzerrolle. Um diese Bereitstellung zuzulassen, aktiviert der Unternehmensadministrator die Option "Freigegebenen Speicherplatz verwalten" in den Rollendokumenteinstellungen>.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
ID des freigegebenen Raums	id	True	integer	ID des freigegebenen Speicherplatzes, den Sie aktualisieren möchten
Name	name		string	Name des freigegebenen Leerraums
Name	name	True	string	Name des Arbeitsbereichsmitglieds
E-Mail	email	True	string	E-Mail-Adresse des Arbeitsbereichsmitglieds

Gibt zurück

response: object

Freigegebenen Speicherplatz löschen

Vorgangs-ID:: V4_WorkSpace_DeleteSharedSpace

Geschäftsanwendungen können diese Dienst-API verwenden, um freigegebenen Speicherplatz zu löschen. Die Verfügbarkeit des Löschens freigegebener Leerzeichen unterliegt der zugewiesenen Unternehmensbenutzerrolle. Um diese Bereitstellung zuzulassen, aktiviert der Unternehmensadministrator die Option "Freigegebenen Speicherplatz verwalten" in den Rollendokumenteinstellungen>.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
ID des freigegebenen Raums	id	True	integer	ID des freigegebenen Speicherplatzes, den Sie löschen möchten

Gibt zurück

response: object

Gatekeeper-Ablehnungsdokument

Vorgangs-ID:: V4_Package_GatekeeperDecline

Geschäftsanwendungen können diese Dienst-API verwenden, um ein Dokument von einem bestimmten Benutzer in der Reihenfolge abzulehnen.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Paket-ID	packageId	True	integer	Die ID des Pakets, das abgelehnt werden soll.
Grund	reason		string	Grund, der vom Benutzer zur Ablehnung bereitgestellt wird.

Gibt zurück

response: object

Gatekeeper-Dokument genehmigen

Vorgangs-ID:: V4_Package_GatekeeperApprove

Geschäftsanwendungen können diese Dienst-API verwenden, um ein Dokument von einem bestimmten Benutzer in der Reihenfolge zu genehmigen.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Paket-ID	packageId	True	integer	Die ID des zu genehmigenden Pakets.
Grund	reason		string	Der Grund für die Genehmigung eines Pakets.
Kennwort für den Dokumentzugriff	x-password		string	Das vom Dokumentbesitzer festgelegte Kennwort für den Zugriff auf das Dokument( falls vorhanden). Wenn das Kennwort nicht festgelegt wurde, muss der Wert null sein.
DokumentOne-Time Kennwort	x-otp		string	Das vom Dokumentbesitzer für den Zugriff auf das Dokument festgelegte One-Time Kennwort (OTP), falls vorhanden. Wenn der OTP nicht festgelegt wurde, muss der Wert null sein.

Gibt zurück

response: object

Herunterladen eines Dokuments

Vorgangs-ID:: V4_Documents_DownloadDocumentBytes

Geschäftsanwendungen können diese Dienst-API verwenden, um die Dokumentbytes herunterzuladen. Die Paket-ID und die Dokument-ID werden in der Ressourcen-URL angegeben.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Paket-ID	packageId	True	integer	Paket-ID des Pakets, dem das Dokument hinzugefügt wird.
Dokument-ID	documentId	True	integer	Die ID des dokuments, das heruntergeladen werden soll.
Dokumentkennwort	x-password		string	Das vom Dokumentbesitzer festgelegte Kennwort für den Zugriff auf das Dokument( falls vorhanden). Wenn das Kennwort nicht festgelegt wurde, muss der Wert null sein.
One-Time Kennwort (OTP)	x-otp		string	Das vom Dokumentbesitzer für den Zugriff auf das Dokument festgelegte One-Time Kennwort (OTP), falls vorhanden. Wenn der OTP nicht festgelegt wurde, muss der Wert null sein.
Ordner-ID	x-folder-id		string	Geben Sie die Ordner-ID zum Abrufen der Ordnerelemente an, wenn ein freigegebener Speicherplatzordner beteiligt ist.

Gibt zurück

response: object

Hinzufügen von Benutzern zum Workflow

Vorgangs-ID:: V4_Workflow_WorkflowAddUser

Geschäftsanwendungen können diese Dienst-API verwenden, um Einem Workflow Empfänger hinzuzufügen. Dieser Aufruf fügt dem Workflow nur einen Empfänger hinzu. Das heißt, es werden keine Felder, die sich derzeit im Dokument befinden, automatisch den neuen Empfängern zugewiesen, und es werden keine neuen Felder erstellt.

Beachten Sie, dass die Empfänger als letzte Person im Workflow hinzugefügt werden. Daher können weitere Arbeiten erforderlich sein, um einen aktuellen Empfänger zu entfernen, der bereits im Workflow vorhanden ist.

Mindestens ein Benutzer muss in einem Workflow vorhanden sein, bevor dem Dokument Felder (Eingabe und Signatur) hinzugefügt werden können.

Beachten Sie, dass die Eingabe einen oder mehrere Benutzer in einem einzigen Anruf akzeptiert.

In diesem speziellen Anruf ist der Benutzer eine bekannte natürliche Person. Die gleichen Regeln gelten jedoch für Gruppen und Platzhalter. In einem dieser Fälle wird der Empfänger zu einer Benutzergruppe, in der jedes Mitglied der Gruppe das Dokument signieren kann, oder ein Platzhalter. Der letztere Fall wird verwendet, wenn Sie die Identität des beabsichtigten Unterzeichners nicht kennen.

Note SigningHub workflow signing order starts at "1". Daher beginnt das Hinzufügen eines Benutzers zum Workflow ohne aktuelle Empfänger eine neue Anzahl von Signierreihenfolgen. Der Parameter "signing_order" ist obligatorisch, wenn der Workflowtyp "custom" ist.

Wichtig: Die Verwendung dieses API-Aufrufs wirkt sich möglicherweise auf den Workflowtyp aus. Wenn sich aktuelle Empfänger in einem sequenziellen Workflow befinden und eine neue mit der gleichen Signierreihenfolge wie ein aktueller Empfänger hinzugefügt wird, ändert sich dieser Teil des Workflows automatisch von sequenziell zu parallel. Daher ist der Workflow insgesamt vom Typ "Benutzerdefiniert" im Gegensatz zu rein sequenziellem Typ. Das Hinzufügen eines Empfängers mit derselben Signierreihenfolge wie zwei oder parallele Empfänger ändert den Workflow nicht. Es gibt lediglich drei oder mehr Empfänger an diesem bestimmten Punkt des Workflows; alle in paralleler Reihenfolge.

Beachten Sie, dass während die Dokumentvorbereitung des XML-Typs nur unterstützte Rollentypen "SIGNER", "REVIEWER" und "CARBON_COPY" sind.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Paket-ID	packageId	True	integer	SignHub-Paket-ID, der die Empfänger hinzugefügt werden sollen.
user_email	user_email		string	E-Mail-Adresse des Benutzers, der im Workflow hinzugefügt werden soll.
user_name	user_name	True	string	Der Name des Empfängers, der im Workflow hinzugefügt werden soll.
user_national_id	user_national_id		string	Nationale Benutzer-ID des Empfängers
email_notification	email_notification	True	boolean	Wenn "true" festgelegt ist, sendet SigningHub Benachrichtigungen per E-Mail an den Benutzer gemäß den Einstellungen des Dokumentbesitzers und der Benutzerbenachrichtigung. Der Wert "false" bedeutet, dass im gesamten Workflow keine Benachrichtigungen an den Benutzer gesendet werden.
role	role	True	string	Rolle des Empfängers im Workflow. Mögliche Werte sind "SIGNER", "REVIEWER", "EDITOR","CARBON_COPY" oder "INPERSON_HOST". Während die XML-Typdokumentvorbereitung jedoch nur unterstützte Rollentypen "SIGNER", "REVIEWER" und "CARBON_COPY" sind
signing_order	signing_order		integer	Reihenfolge des Empfängers im Workflow. Diese Signierreihenfolge ist obligatorisch, wenn der Workflowtyp "CUSTOM" ist.
delivery_method	delivery_method	True	string	Übermittlungsmethode des Empfängers im Workflow. Mögliche Werte sind "EMAIL", "SMS" oder "EMAIL_AND_SMS". Standardwert wäre E-MAIL
mobile_number	mobile_number		string	Handynummer

Gibt zurück

response: array of CollaboratorResponse

Hinzufügen von Gruppen zum Workflow

Vorgangs-ID:: V4_Workflow_WorkflowAddGroup

Geschäftsanwendungen können diese Dienst-API verwenden, um Gruppen als Empfänger zu einem Workflow hinzuzufügen. Eine SigningHub-Gruppe bedeutet, dass jedes Mitglied der Gruppe die Aktion ausführen kann, d. h. im Namen aller Mitglieder der Gruppe.

Beachten Sie, dass die Gruppe als letzter Benutzer/gruppe im Workflow hinzugefügt wird. Daher können weitere Arbeiten erforderlich sein, um einen aktuellen Benutzer/eine aktuelle Gruppe zu entfernen, die bereits im Workflow vorhanden ist. Während die XML-Typdokumentvorbereitung, sind nur unterstützte Rollentypen "SIGNER", "REVIEWER" und "CARBON_COPY"

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Paket-ID	packageId	True	integer	ID des Pakets, für das die Gruppe hinzugefügt werden soll.
group_name	group_name		string	Der Name der neuen Gruppe, die im Workflow hinzugefügt werden soll.
email_notification	email_notification	True	boolean	Wenn der Wert auf "true" festgelegt wird, wird eine E-Mail-Benachrichtigung an den Benutzer gesendet, wenn die Benachrichtigung im Workflow eingetroffen ist. Wenn der Wert auf "false" festgelegt wird, wird die E-Mail-Benachrichtigung nicht an den Benutzer gesendet. Wenn kein Wert angegeben wird, wird der Standardwert "true" festgelegt.
role	role	True	string	Rolle des Empfängers im Workflow. Mögliche Werte sind "SIGNER", "REVIEWER", "EDITOR","CARBON_COPY" oder "INPERSON_HOST". Während die XML-Typdokumentvorbereitung jedoch nur unterstützte Rollentypen "SIGNER", "REVIEWER" und "CARBON_COPY" sind
signing_order	signing_order		integer	Reihenfolge, in der der Workflow von den Empfängern signiert wird. Diese Signierreihenfolge ist wichtig, wenn der Workflowtyp auf "CUSTOM" festgelegt ist.

Gibt zurück

response: array of CollaboratorGroupResponse

Hochladen eines Dokuments

Vorgangs-ID:: V4_Documents_UploadStream

Geschäftsanwendungen können diese Dienst-API verwenden, um einem Dokumentpaket ein Dokument hinzuzufügen, das mit dem Konto eines Unternehmensbenutzers verknüpft ist. Die Dokumentinformationen werden im HTTP-Anforderungsheader gesendet, und Dokumentbytes werden im HTTP-Anforderungstext gesendet. Note SigningHub will convert supported document formats to PDF if the header "x-convert-document" is set to a value of "true". Der einzige unterstützte Fall, bei dem dieser Wert auf "false" festgelegt ist, besteht darin, Word Format- und XML-Dokumente beizubehalten.

SigningHub unterstützt eine Vielzahl von Dokumentformaten, von denen jedes beim Hochladen in das PDF-Format konvertiert werden kann. Klicken Sie hier, um die vollständige Liste anzuzeigen.

Hinweis PDF-Dokumente werden beim Hochladen in das System nicht geändert.

Beachten Sie, dass bereits ein Paket vorhanden sein muss, bevor Sie mithilfe dieses Aufrufs ein Dokument hinzufügen können.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Paket-ID	packageId	True	integer	Paket-ID des Pakets, dem das Dokument hinzugefügt wird.
Inhalt der Datei	body	True	binary	Dies ist das Dokument im unformatierten Binärformat.
Dateiname	x-file-name		string	Es ist der Name der Datei mit der Erweiterung.
Dokument konvertieren	x-convert-document		string	Dadurch wird angegeben, ob das Dokument in eine PDF-Datei konvertiert werden soll oder ob es im ursprünglichen Format beibehalten werden soll. Beachten Sie, dass das einzige unterstützte Originalformat derzeit Word & XML. Alle anderen Dokumenttypen führen zu einem Fehler, wenn dieser Headerwert auf "false" festgelegt ist. Wenn Sie ein PDF-Dokument hochladen, kann dieser Header weggelassen werden.
Source	x-source		string	Dies ist die Identifizierung der Quelle des Dokuments, aus dem das Dokument hochgeladen wird, z. B. "Meine App".

Gibt zurück

Body: UploadDocument

Initialen ausfüllen

Vorgangs-ID:: V4_Initials_Fill

Geschäftsanwendungen können diese Dienst-API verwenden, um ein Initialenfeld in einem Dokument von einem bestimmten Benutzer in der Reihenfolge auszufüllen.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Paket-ID	packageId	True	integer	Paket-ID, zu der das Dokument hinzugefügt wird.
Dokument-ID	documentId	True	integer	Die ID des Dokuments.
field_name	field_name	True	string	Eindeutiger Bezeichner des Felds im Dokument.
Bild	image	True	string	Base64-Bild, das für das Ausfüllen der Initialen verwendet wird.
method	method		integer	0 = DRAW 1 = TEXT 2 = UPLOAD 3 = SIGNATURE_PAD 4 = NONE
apply_to_all	apply_to_all	True	boolean	True, wenn alle Initialen ausgefüllt werden sollen.
Ordner-ID	x-folder-id		string	Geben Sie die Ordner-ID zum Abrufen der Ordnerelemente an, wenn ein freigegebener Speicherplatzordner beteiligt ist.

Gibt zurück

response: object

Kontakte abrufen

Vorgangs-ID:: V4_Contacts_Get

Geschäftsanwendungen können diese Dienst-API verwenden, um Kontakte von persönlichen und Unternehmenskontakten für den aktuellen Benutzer zurück zu setzen.

Es ist möglich, basierend auf dem Kriterium zu suchen, das unter der Kopfzeile "x-search-text" angegeben ist. Darüber hinaus ist es möglich, die spezifischen Kontakte eines Benutzers oder die des Unternehmens zu durchsuchen, zu dem der Benutzer gehört.

Die Suchantwortinformationen enthalten die E-Mail-Adresse des Benutzers und den entsprechenden Benutzernamen.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Datensätze pro Seite	recordPerPage	True	integer	Die Gesamtzahl der Datensätze, die auf einer Seite abgerufen werden sollen.
Seitennummer	pageNo	True	integer	Seitenzahl, die abgerufen werden soll.
Sortieren nach	sort-by		string	Sortieren Sie das Ergebnis nach möglichen Werten, die oben erwähnt werden.
Aufsteigend	asc		boolean	Ordnen Sie das Resultset nach aufsteigender oder absteigender Reihenfolge an.
Suchtext	x-search-text		string	Suchen Sie bei Bedarf Text. Dies ist optional, ohne dass die gesamte Liste zurückgegeben wird. Darüber hinaus ist der empfohlene Wert für den Suchtextparameter im Base64-codierten Format.
Nur Unternehmenskontakte	x-enterprise		string	Wenn dieser Wert auf "true" festgelegt ist, wird nur die Liste der Unternehmenskontakte zurückgegeben. Bei "false" wird nur die Kontaktliste des Benutzers zurückgegeben. Wenn Sie die Kopfzeile nicht festlegen, werden sowohl die Kontaktlisten des Unternehmens als auch die Kontaktlisten des Benutzers zurückgegeben.
Datensätze insgesamt	x-total-records		string	Die Gesamtzahl der Datensätze, die mit den angegebenen Suchkriterien gefunden wurden.

Gibt zurück

response: array of ContactResponse

Massen signieren Von Paketen

Vorgangs-ID:: V4_Signing_BulkSignDocuments

Geschäftsanwendungen können diese API verwenden, um mehrere Dokumente (sowohl elektronisch als auch digital) zu signieren/freizugeben und freizugeben, ohne die Dokumente dem Endbenutzer anzuzeigen. Diese API benötigt Informationen aus der Geschäftsanwendung zu Dokumentpaketen und details zu Signaturen, persönlich und initialen Feldern. Nach erfolgreichem Abschluss der Massensignierungstransaktion gibt die API die Status und Transaktions-IDs der Dokumentpakete zurück.

Im Gegensatz zur Signierdokument-API signiert diese API nicht nur ein Dokumentpaket, sondern kennzeichnet es auch als genehmigt und überprüft, basierend darauf, ob der Empfänger ein Signierer, Editor oder Prüfer ist. Jedes Dokumentpaket, für das der Status als ABGESCHLOSSEN zurückgegeben wird, wurde von dieser API signiert, genehmigt oder überprüft.

Die Massensignierung funktioniert mit allen Signaturzeitauthentifizierungsmethoden.

Wenn SIGN als bulk_action übergeben wird und sich das Paket im Entwurfszustand befindet, wird sign and Share automatisch ausgeführt.

Sie müssen diese API nach der API für vorab signierte Dokumente aufrufen.

Falls Sie vor dem Signieren Änderungen an einem dokument vornehmen müssen, sollte die Api für Füllformularfelder aufgerufen werden, bevor Sie die Api für das Vorabsignieren von Dokumenten aufrufen. Denken Sie daran, dass alle obligatorischen Eingabefelder für ein Dokument abgeschlossen werden müssen, bevor diese API erfolgreich abgeschlossen wird. in der Erwägung, dass die automatisch ausgefüllten Felder (z. B. Name, E-Mail, Datum, Position usw.) automatisch ausgefüllt werden.

Nachdem das Dokument signiert wurde, kann die Überprüfungsantwort über die Api für die Massensignierungsstatus angezeigt werden.

First- oder Second Factor OTP-Verwendung für die Authentifizierung

Falls die OTP-Authentifizierung für den serverseitigen Signaturvorgang aktiviert ist, müssen die Clientanwendungen mithilfe des OTP-API-Aufrufs einen OTP für die Mobiltelefonnummer generieren. Die entsprechenden Geschäftsanwendungen müssen das OTP aus der Verwendung abrufen und übermitteln, wenn der API-Aufruf ausgeführt wird. Dies erfolgt mithilfe des "x-otp"-Headers in der Anforderung.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
ids	ids		array of integer	Ein Array der Dokumentpaket-IDs, die für die Massensignierung ausgewählt sind.
hand_signature_initials_image	hand_signature_initials_image		string	Base64-Bild, das für das Ausfüllen der Initialen verwendet wird
hand_signature_initials_method	hand_signature_initials_method		integer	0 = DRAW 1 = TEXT 2 = UPLOAD 3 = SIGNATURE_PAD 4 = NONE
hand_signature_image	hand_signature_image		string	Base64-codiertes Zeichenfolgenbild der sichtbaren Signaturdarstellung
hand_signature_method	hand_signature_method		integer	0 = DRAW 1 = TEXT 2 = UPLOAD 3 = SIGNATURE_PAD 4 = NONE
signing_reason	signing_reason		string	Grund für die vom Empfänger bereitgestellte Signatur.
signing_location	signing_location		string	Gebietsschema des vom Empfänger bereitgestellten Signierers
contact_information	contact_information		string	Kontaktinformationen des vom Empfänger bereitgestellten Signierers
appearance_design	appearance_design		string	Der Name der Signaturdarstellung, die vom Benutzer zum Signieren bereitgestellt wird. Falls kein Darstellungsname angegeben wird, wird die standardmäßige ausgewählte Darstellung verwendet. Mögliche Werte sind "COMPANY_LOGO", "DETAILED_SIGNATURE", "HAND_SIGNATURE"
signing_server	signing_server		string	Name des Signierservers, auf dem das Dokument signiert werden soll
signing_capacity	signing_capacity		string	Name des Zertifizierungsprofils/der Signierkapazität, mit dem das Dokument signiert werden soll
mechanism	mechanism		string	Mechanismus der Authentifizierung. Mögliche Werte für mechanismus sind: AUTHENTICATION_PASSWORD, AUTHENTICATION_ACTIVE_DIRECTORY, AUTHENTICATION_AZURE_ACTIVE_DIRECTORY, AUTHENTICATION_OFFICE_365, AUTHENTICATION_OAUTH2, AUTHENTICATION_OIDC
password	password		string	Es handelt sich um einen optionalen Parameter, ist jedoch nur erforderlich, wenn "AUTHENTICATION_PASSWORD" als Parameterwert unter "Mechanismus" verwendet wird.
token	token		string	Es handelt sich um einen optionalen Parameter, der vom Server eines Drittanbieters empfangen wird, jedoch nur bei Verwendung von "AUTHENTICATION_AZURE_ACTIVE_DIRECTORY", "AUTHENTICATION_OFFICE_365", "AUTHENTICATION_OAUTH2" "AUTHENTICATION_OIDC" "AUTHENTICATION_GOOGLE" "AUTHENTICATION_LINKED_IN" "AUTHENTICATION_SALES_FORCE" als Parameterwert unter "Mechanismus" erforderlich ist.
user_identifier	user_identifier		string	Es ist ein optionaler Parameter, ist jedoch nur erforderlich, wenn "AUTHENTICATION_ACTIVE_DIRECTORY" oder "AUTHENTICATION_SAML" als Parameterwert unter "Mechanismus" verwendet wird.
id	id		string	Es ist ein optionaler Parameter, ist aber nur erforderlich, wenn "AUTHENTICATION_SALES_FORCE" oder "AUTHENTICATION_IDFY" als Parameterwert unter "Mechanismus" verwendet wird. Für "AUTHENTICATION_IDFY" ist die Anforderungs-ID
code_verifier	code_verifier		string	CodeÜberprüfung, wenn PKCE für den Client aktiviert ist.
Nonce	nonce		string	Nonce-Wert, wenn er für den Client aktiviert ist.
Transaktions-ID	transaction_id		string	Erneut initiierte Signaturprozesstransaktions-ID
Paket-ID	packageId_bulkAction	True	string	Massenaktion, die ausgeführt werden soll. Mögliche Werte sind: SIGN \| FREIGEBEN
Signieren von OTP	x-otp		string	OTP/TOTP wird als zweiter Faktor/Dokumentsignaturauthentifizierung für den Signaturvorgang verwendet.
Kennwort für den Dokumentzugriff	x-open-password		string	Das vom Dokumentbesitzer festgelegte Kennwort für den Zugriff auf das Dokument( falls vorhanden). Wenn das Kennwort nicht festgelegt wurde, muss der Wert null sein.
DokumentOne-Time Kennwort	x-open-otp		string	Das vom Dokumentbesitzer für den Zugriff auf das Dokument festgelegte One-Time Kennwort (OTP), falls vorhanden. Wenn der OTP nicht festgelegt wurde, muss der Wert null sein.
Ordner-ID	x-folder-id		string	Geben Sie die Ordner-ID zum Abrufen der Ordnerelemente an, wenn ein freigegebener Speicherplatzordner beteiligt ist.
Mobiler Absender	x-mobile		string	Definieren des Absenders(Web/Mobile) der Anforderung/Aktion

Gibt zurück

Body: BulkSignResponse

Massensignierungsstatus

Vorgangs-ID:: V4_Signing_BulkSignStatus

Geschäftsanwendungen können diese API verwenden, um den Status einer bestimmten Massensignierungstransaktion zusammen mit den Details von Dokumentpaketen abzurufen, die von der Massensignaturpaket-API verarbeitet wurden.

Sie müssen diese API nach der API für massensignierende Pakete aufrufen.

Bei der RAS-Signatur wird die ACTION-Eigenschaft REMOTE_AUTHORIZATION_REQURIED, und die STATUS-Eigenschaft steht ausstehend und gibt an, dass die Anforderung mithilfe des mobilen Geräts autorisiert werden muss. Wenn der Signiervorgang in einem Dokument aufgrund verschiedener Zusicherungsebenen fehlschlägt und der Benutzer den Signaturvorgang erneut initiieren möchte, um den Signierungsprozess für fehlgeschlagene Dokumente abzuschließen, wird die ACTION-Eigenschaft REINITIATE_SIGNING_PROCESS, und die STATUS-Eigenschaft ist ausstehend.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Transaktions-ID	transaction_id		string	Die Identifikationsnummer der Massensignierungstransaktion
Massenaktion	bulk_action	True	string	Massenaktion, die ausgeführt werden soll. Mögliche Werte sind: SIGN \| FREIGEBEN

Gibt zurück

Body: BulkSignStatusResponse

Nachbearbeitung aktualisieren

Vorgangs-ID:: V4_Workflow_UpdateWorkflowPostProcess

Geschäftsanwendungen können diese Dienst-API verwenden, um einem Workflow ein Dokument in einem Paket Platzhalter hinzuzufügen.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Paket-ID	packageId	True	integer	ID des Dokumentpakets, für das die Nachbearbeitung aktualisiert wird.
enabled	enabled	True	boolean	True, wenn die Nachbearbeitung für das Paket aktiviert ist.
contacts	contacts		array of string
Name	name	True	string
E-Mail	email	True	string
message	message		string	Eine benutzerdefinierte Zeichenfolgenmeldung für alle Kontakte. Die Nachricht wird Teil der E-Mail, die an die Kontakte gesendet wird.
google_drive	google_drive		boolean	True, wenn das Dokument nach Abschluss des Workflows in das bereitgestellte Google-Konto hochgeladen werden soll.
Dropbox	dropbox		boolean	True, wenn das Dokument nach Abschluss des Workflows in das bereitgestellte Dropbox-Konto hochgeladen werden soll.
OneDrive	onedrive		boolean	True, wenn das Dokument nach Abschluss des Workflows in das bereitgestellte OneDrive-Konto hochgeladen werden soll.
workflow_recipients	workflow_recipients	True	boolean	True, wenn der Workflowabschlussbericht an alle Empfänger des Workflows gesendet werden soll, wenn die Nachbearbeitung ausgeführt wird. Der Standardwert ist „false“.
document_processing_report	document_processing_report	True	boolean	True, wenn das Senden des Dokumentverarbeitungsberichts (XML) für den Workflow aktiviert sein soll

Gibt zurück

response: object

Paket herunterladen

Vorgangs-ID:: V4_Package_DownloadPackageBytes

Geschäftsanwendungen können diese Dienst-API verwenden, um das Dokumentpaket im Binärformat herunterzuladen.

Die Paket-ID wird in der Ressourcen-URL angegeben.

Wenn das Paket nur ein Dokument enthält, ist der Download das binäre PDF-Dokument.

Wenn das Paket über mehrere Dokumente verfügt, ist der Download die binär zip-Datei aller Dokumente.

Die x-Password- und x-otp-Header sind optional. Sie sind erforderlich, wenn der Dokumentbesitzer sie während der Workflowerstellungsphase festlegt.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Paket-ID	packageId_bulkAction	True	integer	Die paket-ID, die heruntergeladen werden soll.
Dokument-IDs	document-ids		array	Der Parameter "Document IDs" ist optional. Wenn "x-combine-files" auf "true" festgelegt ist, werden die Dokumente basierend auf den erwähnten Dokumenten des Pakets zusammengeführt.
Kennwort für den Dokumentzugriff	x-password		string	Das vom Dokumentbesitzer festgelegte Kennwort für den Zugriff auf das Dokument( falls vorhanden). Wenn das Kennwort nicht festgelegt wurde, muss der Wert null sein.
DokumentOne-Time Kennwort	x-otp		string	Das vom Dokumentbesitzer für den Zugriff auf das Dokument festgelegte One-Time Kennwort (OTP), falls vorhanden. Wenn der OTP nicht festgelegt wurde, muss der Wert null sein.
Kombinieren von Dateien	x-combine-files		string	Der Standardwert ist "false", "true", um das gesamte Dokumentpaket in einer einzelnen PDF-Datei zu kombinieren.
Ordner-ID	x-folder-id		string	Geben Sie die Ordner-ID zum Abrufen der Ordnerelemente an, wenn ein freigegebener Speicherplatzordner beteiligt ist.

Gibt zurück

response: object

Paket hinzufügen

Vorgangs-ID:: V4_Package_AddPackage

Diese Dienst-API wird verwendet, um ein Dokumentpaket hinzuzufügen/zu erstellen, um ein oder mehrere Dokumente zu speichern. Dieses Paket kann dann verwendet werden, um Dokumente und Empfänger hinzuzufügen, um einen neuen Workflow zu starten.

Wie bereits erwähnt, ist dieser Aufruf obligatorisch, wenn Sie mit Dokumenten arbeiten möchten. Ein Paket muss vorhanden sein, bevor Sie Dokumente in SigningHub hochladen oder hinzufügen können.

Selbst ein einzelnes Dokument ist Teil eines Pakets: ein Paket, das ein Dokument enthält.

Hinweis: Ein Paket kann bei Bedarf umbenannt werden, sobald es erstellt wurde.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
package_name	package_name		string	Der Name des Pakets. Der Standardpaketname ist immer "Unbenannt", wenn der package_name nicht angegeben wird.
workflow_mode	workflow_mode	True	string	Der Workflowmodus enthält drei Typen von Workflowmodi, die in der Anwendung unterstützt werden. Mögliche Werte sind "ONLY_ME", "ME_AND_OTHERS" und "ONLY_OTHERS"
folder_name	folder_name		string	Der Name des Ordners. Es wird verwendet, um das Paket in einen beliebigen Ordner des Benutzers hochzuladen, entweder ein benutzerdefinierter Ordner oder ein freigegebener Ordner.

Gibt zurück

Body: AddPackageResponse

Paket löschen

Vorgangs-ID:: V4_Package_DeletePackage

Geschäftsanwendungen können diese Dienst-API verwenden, um ein Dokument aus dem Posteingang des Benutzers zu löschen. Die Paket-ID wird in der Ressourcen-URL als "{package_id}" angegeben. Wenn der Dokumentstatus ausstehend ist, wird es automatisch als Ergebnis des Löschvorgangs abgelehnt. Wenn der Dokumentstatus FREIGEGEBEN ist, wird das Dokument automatisch zurückgerufen, und der Workflow wird beendet, bevor das Dokument gelöscht wird.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Paket-ID	packageId_bulkAction	True	integer	Paket-ID des Pakets, das das Dokument enthält.

Gibt zurück

response: object

Paket umbenennen

Vorgangs-ID:: V4_Package_RenamePackage

Diese Dienst-API wird verwendet, um ein Dokumentpaket umzubenennen.

Das Dokumentpaket wird anhand seines eindeutigen Bezeichners in der URL des Aufrufs identifiziert.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Paket-ID	packageId_bulkAction	True	integer	Paket-ID, um den Namen zu ändern.
package_name	package_name	True	string	Neuer Name des Dokumentpakets.

Gibt zurück

response: object

Paketdetails abrufen

Vorgangs-ID:: V4_Package_GetPackageDetails

Geschäftsanwendungen können diese Dienst-API verwenden, um die Details eines Pakets abzurufen. Diese API kann auch von der Geschäftsanwendung verwendet werden, um Aktionen im Auftrag des Unternehmensbenutzers über "Bereichsauthentifizierung" auszuführen.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Paket-ID	packageId	True	integer	Paket-ID des Dokumentpakets.

Gibt zurück

Body: GetPackageDetailsResponse

Pakete abrufen

Vorgangs-ID:: V4_Package_GetAllPackages

Geschäftsanwendungen können diese Dienst-API verwenden, um eine Liste von Dokumenten abzurufen, die nach verschiedenen Status gefiltert wurden. Benutzer können die Datensätze auf Seiten aufteilen, indem sie eine Anzahl von Datensätzen pro Seite angeben.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Dokumentstatus	document_status	True	string	Filter nach Dokumentstatus mögliche Werte sind ALLE, ENTWURF, AUSSTEHEND, SIGNIERT, ABGELEHNT, INPROGRESS, EDITED, REVIEW, COMPLETED, EXPIRING_IN_SEVEN_DAYS.
Seitennummer	pageNo	True	integer	Seitenzahl gemäß der Division von Datensätzen pro Seite.
Datensätze pro Seite	recordPerPage	True	integer	Die Anzahl der Datensätze, die in einer Anforderung abgerufen werden müssen.
Paketname	package-name		string	Paketname
Paket-ID	package-id		integer	Paket-ID
Von	recipient-from		string	Von
To	recipient-to		string	To
Dokument-ID	document-id		integer	Dokument-ID
Ablauf (Tage)	expiry		integer	Ablauf (Tage)
Ab Änderungsdatum	modified-from		date-time	Ab Änderungsdatum
Änderungsdatum	modified-to		date-time	Änderungsdatum
Von Größe (KB)	size-from		integer	Von Größe (KB)
Größe (KB)	size-to		integer	Größe (KB)
Zertifizierte Dokumente	certified-documents		boolean	Nur zertifizierte signierte Dokumente
Formularfelder	form-fields		boolean	Nur Dokumente mit Formularfeldern
Anlagen	attachments		boolean	Nur Dokumente mit Anlagen
Dokumenttyp	document-type		string	Dokumenttyp wie XML, PDF, DOCX usw.
Sortieren nach	sort-by		string	Sortieren der resultierenden Datensätze gemäß Ihrer Wahl
Aufsteigende Reihenfolge	asc		boolean	Sortiert die resultierenden Datensätze nach aufsteigender oder absteigender Reihenfolge
Dokumentstatus	document-statuses		array	Dokumenttyp
Im Besitz von	owned-by		string	Mögliche Werte im Besitz von Filtern sind ME_OTHERS, ME, ANDERE.
Smart Form Name	smart-form		string	Smart form name
Ordnername	x-folder		string	Ordnername, von dem die Dokumente abgerufen werden sollen. Mögliche Werte sind INBOX und ARCHIVE. Darüber hinaus ist der empfohlene Wert für den x-Folder-Parameter im Base64-codierten Format.
Suchtext	x-search-text		string	Suchtext, der in Kopfzeilen zur weiteren Filterung der Dokumente gesendet wurde. Paket-ID, Name und Dokumentbesitzer können durchsucht werden. Darüber hinaus ist der empfohlene Wert für den Suchtextparameter im Base64-codierten Format.
Datensätze insgesamt	x-total-records		string	Die Gesamtzahl der Datensätze, die mit den angegebenen Suchkriterien gefunden wurden.
Source	x-source		string	Dies ist die Identifizierung der Quelle des Dokuments, aus dem das Dokument hochgeladen wird, z. B. "Meine App".
Empfängerdetails	x-recipient-details		string	Wenn "true" übergeben wird, werden Empfängerdetails zur Dauer des Dokumentzugriffs zusammen mit Denkinformationen zur Ablehnung bereitgestellt.

Gibt zurück

response: array of GetPackagesResponse

Persönliches Feld aktualisieren

Vorgangs-ID:: V4_InPerson_UpdateInPerson

Geschäftsanwendungen können diese Dienst-API verwenden, um ein persönliches Signaturfeld eines Dokuments in einem Paket zu aktualisieren.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Paket-ID	packageId	True	integer	Paket-ID, zu der das Dokument hinzugefügt wird.
Dokument-ID	documentId	True	integer	Die Dokument-ID, für die die Aktion ausgeführt werden soll.
field_name	field_name	True	string	Aktueller Name des Felds, das aktualisiert werden soll.
renamed_as	renamed_as		string	aktualisierter Name des Felds, wenn die Umbenennung beabsichtigt ist.
page_no	page_no	True	integer	Seitenzahl, auf der das Feld erstellt werden soll.
Platzhalter	placeholder		string	Zeichenfolgenbezeichner für das persönliche Feld, es kann Kunde, Jack, CEO usw. sein.
x	x	True	double	Linke Position des Felds in Pixel.
y	y	True	double	Oberste Position des Felds in Pixel.
width	width	True	double	Breite des Felds in Pixel.
height	height	True	double	Höhe des Felds in Pixel.
Bildschirm	display		string	Sichtbarkeit des zu aktualisierenden Felds, mögliche Werte sind "VISIBLE" und "INVISIBLE"
level_of_assurance	level_of_assurance		array of string	Stufe der Zusicherung, die aktualisiert werden soll. Mögliche Werte sind "ELECTRONIC_SEAL", "ADVANCED_ELECTRONIC_SEAL", "QUALIFIED_ELECTRONIC_SEAL", "ELECTRONIC_SIGNATURE"
enabled	enabled	True	boolean	True, wenn die Authentifizierung für das Feld aktiviert ist. Andernfalls ist der Wert FALSE.
enabled	enabled	True	boolean	True, wenn die OTP-Authentifizierung per SMS/E-Mail für das Feld aktiviert ist. Andernfalls ist der Wert FALSE.
mobile_number	mobile_number		string	Mobiltelefonnummer des Empfängers, dem das Feld zugewiesen ist.
enabled	enabled	True	boolean	True, wenn die TOTP-Authentifizierung für das Feld aktiviert ist. Andernfalls ist der Wert FALSE.
Ordner-ID	x-folder-id		string	Geben Sie die Ordner-ID zum Abrufen der Ordnerelemente an, wenn ein freigegebener Speicherplatzordner beteiligt ist.

Gibt zurück

response: object

Platzhalter zum Workflow hinzufügen

Vorgangs-ID:: V4_Workflow_WorkflowAddPlaceholder

Geschäftsanwendungen können diese Dienst-API verwenden, um einem Workflow in einem Paket Platzhalter hinzuzufügen. Ein Platzhalter ist erforderlich, wenn Sie die Identität des vorgesehenen Empfängers in einem Workflow nicht kennen.

Beachten Sie, dass der Platzhalter als letzter Benutzer im Workflow hinzugefügt wird. Daher können weitere Arbeiten erforderlich sein, um einen aktuellen Benutzer/eine aktuelle Gruppe zu entfernen, die bereits im Workflow vorhanden ist.

Durch das Hinzufügen eines Platzhalters können Sie signatur- und/oder eingabefelder zum Dokument hinzufügen, die dann später einzelnen Benutzern zugewiesen werden können. Während die XML-Typdokumentvorbereitung, sind nur unterstützte Rollentypen "SIGNER", "REVIEWER" und "CARBON_COPY"

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Paket-ID	packageId	True	integer	ID des Pakets, für das der Platzhalter hinzugefügt werden soll.
Platzhalter	placeholder		string	Der Name des neuen Platzhalters, der im Workflow hinzugefügt werden soll.
email_notification	email_notification	True	boolean	Wenn der Wert auf "true" festgelegt wird, wird eine E-Mail-Benachrichtigung an den Benutzer gesendet, wenn die Benachrichtigung im Workflow eingetroffen ist. Wenn der Wert auf "false" festgelegt wird, wird die E-Mail-Benachrichtigung nicht an den Benutzer gesendet.
role	role	True	string	Rolle des Empfängers im Workflow. Mögliche Werte sind "SIGNER", "REVIEWER", "EDITOR","CARBON_COPY" oder "INPERSON_HOST". Während die XML-Typdokumentvorbereitung jedoch nur unterstützte Rollentypen "SIGNER", "REVIEWER" und "CARBON_COPY" sind
signing_order	signing_order		integer	Reihenfolge, in der der Workflow von den Empfängern signiert wird. Diese Signierreihenfolge ist wichtig, wenn der Workflowtyp auf "CUSTOM" festgelegt ist.

Gibt zurück

response: array of CollaboratorPlaceholderResponse

Prozessnachweisbericht abrufen

Vorgangs-ID:: V4_WorkflowEvidenceReport_DownloadBytes

Geschäftsanwendungen können diese Dienst-API verwenden, um den Workflowprozessnachweisbericht eines Dokuments herunterzuladen.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Paket-ID	packageId	True	integer	Die ID des Dokuments.
Ordner-ID	x-folder-id		string	Geben Sie die Ordner-ID zum Abrufen der Ordnerelemente an, wenn ein freigegebener Speicherplatzordner beteiligt ist.

Gibt zurück

response: object

QR-Code aktualisieren

Vorgangs-ID:: V4_QR_UpdateQRCode

Geschäftsanwendungen können diese Dienst-API verwenden, um einen QR-Code eines Dokuments in einem Paket zu aktualisieren.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Paket-ID	packageId	True	integer	Paket-ID, zu der das Dokument hinzugefügt wird.
Dokument-ID	documentId	True	integer	Die Dokument-ID, für die die Aktion ausgeführt werden soll.
field_name	field_name	True	string	Aktueller Name des Felds, das aktualisiert werden soll.
renamed_as	renamed_as		string	Aktualisierter Name des Felds, wenn die Umbenennung vorgesehen ist.
page_no	page_no	True	integer	Seitenzahl, für die das Feld aktualisiert werden muss
x	x	True	double	Linke Position des Felds in Pixel.
y	y	True	double	Oberste Position des Felds in Pixel.
width	width	True	double	Breite des Felds in Pixel.
height	height	True	double	Höhe des Felds in Pixel.
Daten	data		string	Die nur-Text-Daten, die im QR-Code codiert werden sollen. Der Standardwert ist die URL, die für den Zugriff auf das zugehörige Dokument generiert wird. z. B. {base_url}/document/{document_unique_id}
error_correction_level	error_correction_level	True	string	Fehlerkorrekturstufe für den QR-Code, der die Datenredundanz bestimmt. Optionen sind: L (Niedrig), M (Mittel), Q (Quartile) und H (Hoch). Höhere Stufen bieten mehr Fehlerresistenz. Der Standardwert ist "Q"
encoding	encoding	True	string	Gibt den Zeichencodierungsmodus für den QR-Codeinhalt an. Unterstützte Optionen sind: "Standard", "Iso8859_1", "Iso8859_2" und "Utf8". Der Standardwert ist "Standard"
pixels_per_module	pixels_per_module	True	integer	Gibt die Anzahl der Pixel pro Modul im QR-Code an. Eine höhere Zahl führt zu einem größeren und detaillierteren QR-Code. Der Standardwert ist "20". Mögliche Werte sind: 20 \| 30 \| 40 \| 50
add_margins	add_margins	True	boolean	Gibt an, ob Ruhezonen (Seitenränder) um den QR-Code gezeichnet werden sollen. Ruhige Zonen helfen Scannern, den QR-Code genauer zu erkennen und zu decodieren. Der Standardwert ist "true"
Punkte	dots		string	Stellt die dunkle Farbe dar, die für die Punkte im QR-Code verwendet wird. Der Standardwert ist "schwarz". z. B. "#000000"
Hintergrund	background		string	Stellt die Lichtfarbe dar, die für den Hintergrund des QR-Codes verwendet wird. Der Standardwert ist "weiß". z. B. "#ffffff"
Base64	base64		string	Ein optionales Symbol (Base64), das in der Mitte des QR-Codes platziert werden soll.
hide_background_dots	hide_background_dots	True	boolean	Die Hintergrundfarbe hinter dem Symbol, wenn ein Symbol bereitgestellt wird. Wenn keine Farbe bereitgestellt wird, wird transparenter Hintergrund implementiert.
Größe	size	True	integer	Die Größe des Symbols als Prozentsatz der Größe des QR-Codes, wenn ein Symbol angegeben wird. Der Standardwert ist "15". Mögliche Werte sind: 10 \| 15 \| 20 \| 25 \| 30 \| 35 \| 40

Gibt zurück

Body: UpdateQrCodeResponse

QR-Code hinzufügen

Vorgangs-ID:: V4_QR_AddQRCode

Geschäftsanwendungen können diese Dienst-API verwenden, um einem Dokument in einem Paket einen QR-Code hinzuzufügen.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Paket-ID	packageId	True	integer	Paket-ID, zu der das Dokument hinzugefügt wird.
Dokument-ID	documentId	True	integer	Die Dokument-ID, für die die Aktion ausgeführt werden soll.
page_no	page_no	True	integer	Seitenzahl, auf der das Feld erstellt werden soll.
field_name	field_name		string	Der Name des angegebenen Felds, das hinzugefügt werden soll. Wenn nicht angegeben, weist das System dem Feld einen eindeutigen automatisch generierten Namen zu.
x	x	True	double	Linke Position des Felds in Pixel.
y	y	True	double	Oberste Position des Felds in Pixel.
width	width	True	double	Breite des Felds in Pixel.
height	height	True	double	Höhe des Felds in Pixel.
Daten	data		string	Die nur-Text-Daten, die im QR-Code codiert werden sollen. Der Standardwert ist die URL, die für den Zugriff auf das zugehörige Dokument generiert wird. z. B. {base_url}/document/{document_unique_id}
error_correction_level	error_correction_level	True	string	Fehlerkorrekturstufe für den QR-Code, der die Datenredundanz bestimmt. Optionen sind: L (Niedrig), M (Mittel), Q (Quartile) und H (Hoch). Höhere Stufen bieten mehr Fehlerresistenz. Der Standardwert ist "Q"
encoding	encoding	True	string	Gibt den Zeichencodierungsmodus für den QR-Codeinhalt an. Unterstützte Optionen sind: "Standard", "Iso8859_1", "Iso8859_2" und "Utf8". Der Standardwert ist "Standard"
pixels_per_module	pixels_per_module	True	integer	Gibt die Anzahl der Pixel pro Modul im QR-Code an. Eine höhere Zahl führt zu einem größeren und detaillierteren QR-Code. Der Standardwert ist "20". Mögliche Werte sind: 20 \| 30 \| 40 \| 50
add_margins	add_margins	True	boolean	Gibt an, ob Ruhezonen (Seitenränder) um den QR-Code gezeichnet werden sollen. Ruhige Zonen helfen Scannern, den QR-Code genauer zu erkennen und zu decodieren. Der Standardwert ist "true"
Punkte	dots		string	Stellt die dunkle Farbe dar, die für die Punkte im QR-Code verwendet wird. Der Standardwert ist "schwarz". z. B. "#000000"
Hintergrund	background		string	Stellt die Lichtfarbe dar, die für den Hintergrund des QR-Codes verwendet wird. Der Standardwert ist "weiß". z. B. "#ffffff"
Base64	base64		string	Ein optionales Symbol (Base64), das in der Mitte des QR-Codes platziert werden soll.
hide_background_dots	hide_background_dots	True	boolean	Die Hintergrundfarbe hinter dem Symbol, wenn ein Symbol bereitgestellt wird. Wenn keine Farbe bereitgestellt wird, wird transparenter Hintergrund implementiert.
Größe	size	True	integer	Die Größe des Symbols als Prozentsatz der Größe des QR-Codes, wenn ein Symbol angegeben wird. Der Standardwert ist "15". Mögliche Werte sind: 10 \| 15 \| 20 \| 25 \| 30 \| 35 \| 40

Gibt zurück

Body: AddQrCodeResponse

RadioBox-Feld aktualisieren

Vorgangs-ID:: V4_Radio_UpdateRadioBox

Geschäftsanwendungen können diese Dienst-API verwenden, um ein Optionsfeld eines Dokuments in einem Paket zu aktualisieren.

Breite und Höhe können nicht aktualisiert werden. Sie bleiben gleich, als sie hinzugefügt wurden.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Paket-ID	packageId	True	integer	Paket-ID, zu der das Dokument hinzugefügt wird.
Dokument-ID	documentId	True	integer	Die Dokument-ID, für die die Aktion ausgeführt werden soll.
field_name	field_name	True	string	Aktueller Name des Felds, das aktualisiert werden soll.
renamed_as	renamed_as		string	Aktualisierter Name des Felds, wenn die Umbenennung vorgesehen ist.
page_no	page_no	True	integer	Seitenzahl, auf der das Feld erstellt werden soll.
value	value		string	Wert des Felds. Mögliche Werte sind "true" oder "false"
validation_rule	validation_rule	True	string	Mindestens eine Regel für die Überprüfung der Felder sind mögliche Werte "OBLIGATORISCH" oder "OPTIONAL".
radio_group_name	radio_group_name	True	string	Der Gruppenname, zu dem das Feld gehört.
x	x	True	double	Linke Position des Felds in Pixel.
y	y	True	double	Oberste Position des Felds in Pixel.
width	width	True	double	Breite des Felds in Pixel.
height	height	True	double	Höhe des Felds in Pixel.

Gibt zurück

response: object

RadioBox-Feld hinzufügen

Vorgangs-ID:: V4_Radio_AddRadioBox

Geschäftsanwendungen können diese Dienst-API verwenden, um einem Dokument in einem Paket ein Kontrollkästchen hinzuzufügen.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Paket-ID	packageId	True	integer	Paket-ID, zu der das Dokument hinzugefügt wird.
Dokument-ID	documentId	True	integer	Die Dokument-ID, für die die Aktion ausgeführt werden soll.
order	order	True	integer	Die Reihenfolge des Benutzers im Workflow, für den das Feld hinzugefügt wird.
page_no	page_no	True	integer	Seitenzahl, auf der das Feld erstellt werden soll.
field_name	field_name		string	Der Name des angegebenen Felds, das hinzugefügt werden soll. Wenn nicht angegeben, weist das System dem Feld einen eindeutigen automatisch generierten Namen zu.
value	value		string	Wert des Felds. Mögliche Werte sind "true" oder "false"
validation_rule	validation_rule	True	string	Mindestens eine Regel für die Überprüfung der Felder sind mögliche Werte "OBLIGATORISCH" oder "OPTIONAL".
radio_group_name	radio_group_name	True	string
x	x	True	double	Linke Position des Felds in Pixel.
y	y	True	double	Oberste Position des Felds in Pixel.
width	width	True	double	Breite des Felds in Pixel.
height	height	True	double	Höhe des Felds in Pixel.

Gibt zurück

Body: AddFieldResponse

Textfeld-Feld aktualisieren

Vorgangs-ID:: V4_TextBox_UpdateTextBox

Geschäftsanwendungen können diese Dienst-API verwenden, um ein Textfeld eines Dokuments in einem Paket zu aktualisieren.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Paket-ID	packageId	True	integer	Paket-ID, zu der das Dokument hinzugefügt wird.
Dokument-ID	documentId	True	integer	Die Dokument-ID, für die die Aktion ausgeführt werden soll.
field_name	field_name	True	string	Aktueller Name des Felds, das aktualisiert werden soll.
renamed_as	renamed_as		string	Aktualisierter Name des Felds, wenn die Umbenennung vorgesehen ist.
page_no	page_no	True	integer	Seitenzahl, auf der das Feld erstellt werden soll.
value	value		string	Wert des Felds. Für typ = DATE wird erwartet, dass der Wert dem ISO 8601-Format entspricht. Nach dem Format JJJJ-MM-DD hh:mm:ss +00. Da die Werte für Datumsfelder gelten, können Clientanwendungen JJJJ-MM-DD senden und hh:mm:ss +00 ignorieren. Wenn der Wert nicht im richtigen Format ist, wird ein Fehler zurückgegeben.
Maximallänge	max_length	True	integer	Maximale Länge des zulässigen Werts im Feld. Muss zwischen 1 und 9999
field_type	field_type	True	string	Feldtyp im Hinblick auf die Annahme des Typs von Werten, mögliche Werte sind "ZAHL" oder "TEXT".
validation_rule	validation_rule	True	string	Mindestens eine Regel für die Überprüfung der Felder sind mögliche Werte "OBLIGATORISCH" oder "OPTIONAL".
Name	name		string	Name der schriftart, die für das Textfeld ausgewählt ist. Mögliche Werte sind "COURIER", "HELVETICA".
Größe	size		string	Der Schriftgrad, der für das Textfeld ausgewählt ist. Mögliche Werte sind 8, 10, 12, 14, 16, 18, 20
embedded_size	embedded_size		string	Schriftgrad im ursprünglichen PDF-Dokument.
x	x	True	double	Linke Position des Felds in Pixel.
y	y	True	double	Oberste Position des Felds in Pixel.
width	width	True	double	Breite des Felds in Pixel.
height	height	True	double	Höhe des Felds in Pixel.
Platzhalter	placeholder		string	Entwickler können eigene Platzhaltertexte bereitstellen. Diese Platzhalter werden in den Textfeldern angezeigt, während das Dokument im Viewer angezeigt wird.
format	format		string	Textformat des Felds. Wird nur für das Datumstypfeld verwendet. Mögliche Werte sind m/d m/d/yy m/d/jjjj mm/tt/jj mm/tt/jjjj mm/jj mm/jjjj d-mmm d-mmm-yyy d-mmm-jjjj tt-mmm-yyy tt-mmm-yyyyy yy-mm-dd yyyy-mm-dd mmm-yy mmm-jjjj mmmm-jj mmmm-jjjj mmmm d, jjjj tt/mm/jj ddmmmyyyy
required	required	True	boolean
type	type		string	Gibt den Typ der Gültigkeitsprüfungsregel an, der derzeit immer auf EQUALS für Textfeld festgelegt ist.
value	value		string	Stellt den Wert dar, der für die Überprüfung verwendet wird.

Gibt zurück

response: object

Textfeld-Feld hinzufügen

Vorgangs-ID:: V4_TextBox_AddTextBox

Geschäftsanwendungen können diese Dienst-API verwenden, um einem Dokument in einem Paket ein Texteingabefeld hinzuzufügen.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Paket-ID	packageId	True	integer	Paket-ID, zu der das Dokument hinzugefügt wird.
Dokument-ID	documentId	True	integer	Die Dokument-ID, für die die Aktion ausgeführt werden soll.
order	order	True	integer	Die Reihenfolge des Benutzers im Workflow, für den das Feld hinzugefügt wird.
page_no	page_no	True	integer	Seitenzahl, auf der das Feld erstellt werden soll.
type	type	True	string	Der Typ des Felds, mögliche Werte sind "TEXT", "NAME", "EMAIL", "COMPANY", "JOBTITLE", "DATE". Alle Anderen Textfelder werden automatisch im ausstehenden Modus mit den Attributen/Daten des Empfängers ausgefüllt.
value	value		string	Wert des Felds. Für typ = DATE wird erwartet, dass der Wert dem ISO 8601-Format entspricht. Nach dem Format JJJJ-MM-DD hh:mm:ss +00. Da die Werte für Datumsfelder gelten, können Clientanwendungen JJJJ-MM-DD senden und hh:mm:ss +00 ignorieren. Wenn der Wert nicht im richtigen Format ist, wird ein Fehler zurückgegeben.
Platzhalter	placeholder		string	Platzhaltertext für das Textfeld. Bei Name, E-Mail, Firma, Position und Datum kann der Platzhalterwert "NAME", "EMAIL", "COMPANY", "JOBTITLE", "DATE" sein. Entwickler können eigene Platzhalter senden, um die Standardwerte zu überschreiben. Für "TEXT" können Entwickler eigene Platzhaltertexte bereitstellen. Diese Platzhalter werden in den Textfeldern angezeigt, während das Dokument im Viewer angezeigt wird.
Maximallänge	max_length	True	integer	Maximale Länge des zulässigen Werts im Feld. Muss zwischen 1 und 9999
format	format		string	Textformat des Felds. Wird nur für das Datumstypfeld verwendet. Mögliche Werte sind m/d m/d/yy m/d/jjjj mm/tt/jj mm/tt/jjjj mm/jj mm/jjjj d-mmm d-mmm-yyy d-mmm-jjjj tt-mmm-yyy tt-mmm-yyyyy yy-mm-dd yyyy-mm-dd mmm-yy mmm-jjjj mmmm-jj mmmm-jjjj mmmm d, jjjj tt/mm/jj ddmmmyyyy
field_name	field_name		string	Name des Felds, das hinzugefügt werden soll. Wenn nicht angegeben, weist das System dem Feld einen eindeutigen automatisch generierten Namen zu.
field_type	field_type	True	string	Feldtyp im Hinblick auf die Annahme des Typs von Werten, mögliche Werte sind "ZAHL" oder "TEXT".
validation_rule	validation_rule	True	string	Mindestens eine Regel für die Überprüfung der Felder sind mögliche Werte "OBLIGATORISCH" oder "OPTIONAL".
required	required	True	boolean
type	type		string	Gibt den Typ der Gültigkeitsprüfungsregel an, der derzeit immer auf EQUALS für Textfeld festgelegt ist.
value	value		string	Stellt den Wert dar, der für die Überprüfung verwendet wird.
Name	name		string	Name der schriftart, die für das Textfeld ausgewählt ist. Mögliche Werte sind "COURIER", "HELVETICA".
Größe	size		string	Der Schriftgrad, der für das Textfeld ausgewählt ist. Mögliche Werte sind 8, 10, 12, 14, 16, 18, 20
embedded_size	embedded_size		string	Schriftgrad im ursprünglichen PDF-Dokument.
x	x	True	double	Linke Position des Felds in Pixel.
y	y	True	double	Oberste Position des Felds in Pixel.
width	width	True	double	Breite des Felds in Pixel.
height	height	True	double	Höhe des Felds in Pixel.
Mehrzeile	multiline	True	boolean	Wenn dieser Wert auf "true" festgelegt ist, würde ein Textfeld erstellt werden.

Gibt zurück

Body: AddFieldResponse

Verarbeitung beenden

Vorgangs-ID:: V4_Package_Finish

Geschäftsanwendungen können diese Dienst-API verwenden, um die Dokumentverarbeitung nach dem Signieren aller Signaturfelder abzuschließen. Diese Methode wird in erster Linie von nativen mobilen SigningHub-Apps für iOS und Android und mobilen Web-Anwendungsfällen verwendet. Allgemeine Geschäftsanwendungen, die eine enge Integration in ihr jeweiliges Portal verwenden, müssen diese Methode nicht aufrufen. Wenn Sie jedoch die Signierdokument-API verwenden (und demzufolge wird dem Benutzer keine visuelle Darstellung des Dokuments angezeigt, das sie signieren möchten), ist das Aufrufen dieser API erforderlich, um sicherzustellen, dass der jeweilige Workflow fortgesetzt oder abgeschlossen wird. Wenn beispielsweise alle Signaturen mithilfe des "blinden" Signierdokument-API-Aufrufs angewendet wurden, wird das Dokument erst dann als Status "Abgeschlossen" für den Besitzer angezeigt, wenn diese API aufgerufen wird. Der Dokumentbesitzer sieht den Status "In Bearbeitung", bis diese API aufgerufen wird.

In nativen SignHub Mobile-Apps und mobilen Web-Anwendungsfällen ist dieser Aufruf erforderlich, um sicherzustellen, dass jeder Benutzer seine jeweiligen Aktionen im Hinblick auf SigningHub abgeschlossen hat. Nachdem beispielsweise ein Signatory ein Dokument in signingHub App signiert hat, wird diese Methode von der Anwendung aufgerufen, um sicherzustellen, dass der Workflow weiterhin verarbeitet wird und der nächste Signator benachrichtigt wird, und der Dokumentstatus ist über die konfigurierte Rückruf-URL verfügbar.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Paket-ID	packageId	True	integer	Die ID des Pakets, das fertig gestellt werden soll.
Ordner-ID	x-folder-id		string	Geben Sie die Ordner-ID zum Abrufen der Ordnerelemente an, wenn ein freigegebener Speicherplatzordner beteiligt ist.

Gibt zurück

response: object

Verschieben des Pakets in den Ordner "Benutzerdefinierter oder freigegebener Speicherplatz"

Vorgangs-ID:: V4_Folder_MovePackage

Geschäftsanwendungen können diese Dienst-API verwenden, um das Dokumentpaket in einen freigegebenen Bereich oder einen benutzerdefinierten Ordner des Benutzers zu verschieben.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Paket-ID	packageId	True	integer	Paket-ID, die in den Ordner verschoben werden muss
folder_name	folder_name	True	string	Zielordnername, in dem das Paket verschoben werden muss

Gibt zurück

response: object

Vollständiger Workflow in der Mitte (Workflow beenden)

Vorgangs-ID:: V4_Workflow_MarkWorkflowCompleted

Geschäftsanwendungen können den Workflow sogar in der Mitte des Workflows als erledigt markieren. Verwenden Sie diese Dienst-API, um den Status des Workflows so zu ändern, dass er abgeschlossen ist. Wenn Empfänger vorhanden sind, die das Dokument noch nicht signiert haben. Ihre Signatur wird nicht mehr benötigt, und sie können das Dokument nicht weiter in ihrem Posteingang sehen. Bearertoken sollte zum Dokumentbesitzer oder Unternehmensadministrator gehören, kann Bereichsvariable verwenden, um das Zugriffstoken im Namen des Dokumentbesitzers abzurufen, um diese Aktion auszuführen.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Paket-ID	packageId	True	integer	Die Paket-ID, aus der der Empfänger gelöscht werden soll.
Ordner-ID	x-folder-id		string	Geben Sie die Ordner-ID zum Abrufen der Ordnerelemente an, wenn ein freigegebener Speicherplatzordner beteiligt ist.

Gibt zurück

response: object

Vorlagen abrufen

Vorgangs-ID:: V4_Settings_GetTemplates

Geschäftsanwendungen können diese Dienst-API verwenden, um eine Liste der Vorlagen für den aktuellen Benutzer abzurufen.

Es ist möglich, basierend auf dem Kriterium zu suchen, das unter der Kopfzeile "x-search-text" angegeben ist. Darüber hinaus ist es möglich, die persönlichen Vorlagen eines Benutzers oder die Unternehmensvorlagen nach ihrer Benutzerrolle durch den Unternehmensadministrator zu durchsuchen.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Anzahl der Datensätze pro Seite	recordPerPage	True	integer	Die Gesamtzahl der Datensätze, die auf einer Seite abgerufen werden sollen.
Seitenzahl, die abgerufen werden soll	pageNo	True	integer	Seitenzahl, die abgerufen werden soll.
Sortieren nach Spalten	sort-by		string	Sortieren nach Spalte. Mögliche Werte sind CREATED_ON und NAME. Der Standardwert ist nach CREATED_ON
Asc	asc		boolean	Die resultierende Listenreihenfolge. Die standardmäßige resultierende Liste wird absteigend angezeigt.
Suchtext	x-search-text		string	Suchen Sie bei Bedarf Text. Dies ist optional, ohne dass die gesamte Liste zurückgegeben wird. Darüber hinaus ist der empfohlene Wert für den Suchtextparameter im Base64-codierten Format.
Nur Enterprise-Vorlagen	x-enterprise		string	Wenn sie als "true" festgelegt ist, wird nur die Liste der Enterprise-Vorlagen zurückgegeben. Bei "false" wird nur die Vorlagenliste des Benutzers zurückgegeben. Wenn Sie den Header nicht festlegen, werden sowohl die Vorlagenlisten für Unternehmen als auch die Vorlagenlisten des Benutzers zurückgegeben.
Gesamtanzahl von Datensätzen	x-total-records		string	Die Gesamtzahl der Datensätze, die mit den angegebenen Suchkriterien gefunden wurden.

Gibt zurück

response: array of TemplateResponse

Workflowbenutzer aktualisieren

Vorgangs-ID:: V4_Workflow_WorkflowUserUpdate

Geschäftsanwendungen können diese Dienst-API verwenden, um die Details eines Empfängers, einer Gruppe oder eines Platzhalters zu aktualisieren, der einem Workflow bereits hinzugefügt wurde. Normalerweise ist dieser Aufruf nützlich, nachdem eine Vorlage auf ein Dokument angewendet wurde und Geschäftsanwendungen die Details eines bestimmten Benutzers innerhalb des Workflows außer Kraft setzen möchten. Die ID des Workflowdokuments wird in der Ressourcen-URL angegeben, und der Workflowempfänger wird durch die Reihenfolge identifiziert, in der es dem Workflow hinzugefügt wird. Beachten Sie, dass während der XML-Typdokumentvorbereitung nur Rollentypen "SIGNER", "REVIEWER" und "CARBON_COPY" unterstützt werden.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Paket-ID	packageId	True	integer	Die Paket-ID, für die der Workflowbenutzer aktualisiert werden muss.
Bestellung	order	True	integer	Die Reihenfolge des Benutzers im Workflow.
user_email	user_email		string	Die E-Mail-Adresse des neuen Benutzers, der im Workflow aktualisiert werden soll. Wenn kein Wert angegeben wird, wird der alte Wert beibehalten.
user_name	user_name		string	Der Name des Empfängers, der aktualisiert werden soll. Wenn kein Wert angegeben wird, wird der alte Wert beibehalten.
email_notification	email_notification		boolean	Wenn der Wert auf "true" festgelegt wird, wird eine E-Mail-Benachrichtigung an den Benutzer gesendet, wenn die Benachrichtigung im Workflow eingetroffen ist. Wenn der Wert auf "false" festgelegt wird, wird die E-Mail-Benachrichtigung nicht an den Benutzer gesendet. Wenn kein Wert angegeben wird, wird der alte Wert beibehalten.
mobile_number	mobile_number		string	Mobiltelefonnummer. Wenn kein Wert angegeben wird, wird der alte Wert beibehalten.
role	role	True	string	Rolle des Empfängers, der aktualisiert werden soll. Mögliche Werte sind "SIGNER", "REVIEWER", "EDITOR","CARBON_COPY" oder "INPERSON_HOST". Wenn kein Wert angegeben wird, wird der alte Wert beibehalten. Während die XML-Typdokumentvorbereitung jedoch nur unterstützte Rollentypen "SIGNER", "REVIEWER" und "CARBON_COPY" sind
signing_order	signing_order		integer	Reihenfolge, in der der Workflow von den Empfängern signiert wird. Diese Signierreihenfolge ist wichtig, wenn der Workflowtyp auf "CUSTOM" festgelegt ist.
email_language_code	email_language_code		string	E-Mail-Sprachcode
delivery_method	delivery_method	True	string	Übermittlungsmethode des Empfängers im Workflow. Mögliche Werte sind "EMAIL", "SMS" oder "EMAIL_AND_SMS". Standardwert wäre E-MAIL
Ordner-ID	x-folder-id		string	Geben Sie die Ordner-ID zum Abrufen der Ordnerelemente an, wenn ein freigegebener Speicherplatzordner beteiligt ist.

Gibt zurück

Body: UpdateCollaboratorResponse

Workflowbenutzer löschen

Vorgangs-ID:: V4_Workflow_WorkflowDeleteUser

Geschäftsanwendungen können diese Dienst-API verwenden, um Workflowempfänger zu löschen.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Paket-ID	packageId	True	integer	Die Paket-ID, aus der der Empfänger gelöscht werden soll.
Bestellung	order	True	integer	Reihenfolge des Empfängers im Workflow, der gelöscht werden soll.

Gibt zurück

response: object

Workflowbenutzerberechtigungen aktualisieren

Vorgangs-ID:: V4_WorkflowPermission_UpdateWorkflowPermissions

Geschäftsanwendungen können diese Dienst-API verwenden, um die Workflowberechtigungen für einen Benutzer zu aktualisieren, der bereits einem Workflow hinzugefügt wurde. Normalerweise ist dieser Aufruf nützlich, nachdem eine Vorlage auf ein Dokument angewendet wurde und Geschäftsanwendungen die Berechtigungen im Workflow überschreiben möchten. Die ID des Dokumentpakets wird in der Ressourcen-URL angegeben, und der Workflowbenutzer wird durch die Reihenfolge identifiziert, in der es dem Workflow hinzugefügt wird.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Paket-ID	packageId	True	integer	Die Paket-ID, für die Workflowberechtigungen aktualisiert werden sollen.
Bestellung	order	True	integer	Die Reihenfolge des Empfängers, für den die Workflowberechtigungen aktualisiert werden sollen.
apply_to_all	apply_to_all	True	boolean	True, wenn die Berechtigungen auf alle Empfänger im Workflow angewendet werden sollen.
print	print		boolean	Er definiert, ob der Empfänger das Dokument drucken darf.
Download	download		boolean	Er definiert, ob der Empfänger das Dokument herunterladen darf.
add_text	add_text		boolean	Es definiert, ob der Empfänger Textfelder im Dokument hinzufügen darf.
change_recipients	change_recipients		boolean	Er ermöglicht es dem Benutzer, jeden Empfänger zu ändern, der sich noch nicht angemeldet hat.
add_attachment	add_attachment		boolean	Er definiert, ob der Empfänger Anlagen im PDF-Dokument hinzufügen darf.
enabled	enabled	True	boolean	True, wenn der rechtliche Hinweis aktiviert ist.
legal_notice_name	legal_notice_name		string	Name des für den Empfänger ausgewählten rechtlichen Hinweises.
enabled	enabled	True	boolean	Aktiviert
Ordner-ID	x-folder-id		string	Geben Sie die Ordner-ID zum Abrufen der Ordnerelemente an, wenn ein freigegebener Speicherplatzordner beteiligt ist.

Gibt zurück

response: object

Workflowbenutzerreihenfolge aktualisieren

Vorgangs-ID:: V4_Workflow_WorkflowUserUpdateOrder

Geschäftsanwendungen können diese Dienst-API verwenden, um die Reihenfolge des Empfängers im Workflow zu aktualisieren.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Paket-ID	packageId	True	integer	ID des Pakets, dem die Empfänger hinzugefügt werden sollen.
Bestellung	order	True	integer	Vorhandene Reihenfolge des Empfängers, der aktualisiert werden soll.
order	order	True	integer	Die Reihenfolge des Empfängers, der aktualisiert werden soll.

Gibt zurück

response: object

Workflowdetails abrufen

Vorgangs-ID:: V4_Workflow_GetWorkflowDetail

Geschäftsanwendungen können diese Dienst-API verwenden, um Workflowdetails für das Paket abzurufen.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Paket-ID	packageId	True	integer	Die ID des herunterzuladenden Pakets.
Ordner-ID	x-folder-id		string	Geben Sie die Ordner-ID zum Abrufen der Ordnerelemente an, wenn ein freigegebener Speicherplatzordner beteiligt ist.

Gibt zurück

Body: WorkflowDetailsResponse

Workflowdetails aktualisieren

Vorgangs-ID:: V4_Workflow_UpdateWorkflow

Geschäftsanwendungen können diese Dienst-API verwenden, um die Workflowdetails zu aktualisieren. Normalerweise ist dieser Aufruf nützlich, nachdem eine Vorlage auf ein Dokument angewendet wurde, aber Geschäftsanwendungen möchten die Zertifizierungsberechtigung oder die Nachbearbeitungsdetails außer Kraft setzen. Die Paket-ID wird in der Ressourcen-URL angegeben.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Paket-ID	packageId	True	integer	Die Paket-ID, für die Workflowdetails aktualisiert werden müssen.
workflow_type	workflow_type		string	Workflowtyp für das Paket z. B. (SERIAL,PARALLEL,INDIVIDUAL,CUSTOM). Wenn kein Wert angegeben wird, wird der alte Wert beibehalten.
workflow_mode	workflow_mode		string	Workflowmodus des Pakets z. B. (ONLY_ME, ME_AND_OTHERS, ONLY_OTHERS). Wenn der Workflowmodus auf ONLY_ME festgelegt ist, kann kein Mitarbeiter dem Paket eines anderen authentifizierten Benutzers selbst hinzugefügt werden.
continue_on_decline	continue_on_decline		boolean	True, wenn der Workflow fortgesetzt werden muss, auch wenn ein Empfänger das Dokument ablehnt. Wenn kein Wert angegeben wird, wird der alte Wert beibehalten.
message	message		string	Eine benutzerdefinierte Zeichenfolgennachricht vom Dokumentbesitzer an jeden Empfänger, diese Nachricht wird sowohl in der Freigabe-E-Mail als auch auf dem Bildschirm angezeigt. Wenn kein Wert angegeben wird, wird der alte Wert beibehalten.
comments	comments		boolean	Kommentare zulassen

Gibt zurück

response: object

Workflowerinnerung abrufen

Vorgangs-ID:: V4_Workflow_GetWorkflowReminder

Geschäftsanwendungen können diese Dienst-API verwenden, um die Erinnerungen für die Empfänger zu aktualisieren, die bereits einem Workflow hinzugefügt wurden. Normalerweise ist dieser Aufruf nützlich, nachdem eine Vorlage auf ein Dokument angewendet wurde und Geschäftsanwendungen die Erinnerungseinstellungen im Workflow überschreiben möchten. Die ID des Workflowdokuments wird in der Ressourcen-URL angegeben, und der Workflowempfänger wird durch die Reihenfolge identifiziert, in der es dem Workflow hinzugefügt wird.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Paket-ID	packageId	True	integer	Die Paket-ID, für die Workflowerinnerungen aktualisiert werden sollen.
Bestellung	order	True	integer	Die Reihenfolge des Benutzers, für die die Workflowerinnerungen aktualisiert werden sollen.

Gibt zurück

Body: ReminderResponse

Workflowerinnerungen aktualisieren

Vorgangs-ID:: V4_Workflow_UpdateWorkflowReminder

Geschäftsanwendungen können diese Dienst-API verwenden, um die Workflowerinnerungen für einen Empfänger zu aktualisieren, der bereits einem Workflow hinzugefügt wurde. Normalerweise ist dieser Aufruf nützlich, nachdem eine Vorlage auf ein Dokument angewendet wurde und Geschäftsanwendungen die Erinnerungseinstellungen im Workflow überschreiben möchten. Die ID des Workflowdokuments wird in der Ressourcen-URL angegeben, und der Workflowempfänger wird durch die Reihenfolge identifiziert, in der es dem Workflow hinzugefügt wird.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Paket-ID	packageId	True	integer	Die Paket-ID, für die Workflowerinnerungen aktualisiert werden sollen.
Bestellung	order	True	integer	Die Reihenfolge des Benutzers, für die die Workflowerinnerungen aktualisiert werden sollen.
apply_to_all	apply_to_all	True	boolean	True, wenn Erinnerungseinstellungen auf alle Empfänger im Workflow angewendet werden sollen.
enabled	enabled	True	boolean	True, wenn Erinnerungseinstellungen aktiviert werden sollen.
Frequenz	frequency		string	Erinnerungshäufigkeit. Mögliche Werte sind TAGE \| STUNDEN.
remind_after	remind_after	True	integer	Erforderlich, bei aktivierter Eigenschaft true. Die Anzahl der Tage, nach denen die erste Erinnerung an den Workflowbenutzer gesendet wird.
enabled	enabled	True	boolean	True, wenn nachfolgende Erinnerungen aktiviert sind.
Frequenz	frequency		string	Wiederholte Erinnerungshäufigkeit. Mögliche Werte sind TAGE \| STUNDEN.
keep_reminding_after	keep_reminding_after	True	integer	Erforderlich, bei aktivierter Eigenschaft true. Die Anzahl der Tage, nach denen die nachfolgenden Erinnerungen an den Workflowbenutzer gesendet werden.
total_reminders	total_reminders	True	integer	Erforderlich, bei aktivierter Eigenschaft true. Die Anzahl der nachfolgenden Erinnerungen würde an den Workflowbenutzer gesendet.

Gibt zurück

response: object

Workflowverlauf abrufen

Vorgangs-ID:: V4_Workflow_GetWorkflowHistory

Geschäftsanwendungen können diese Dienst-API verwenden, um die Liste der Aktionen abzurufen, die für ein Dokument ausgeführt werden. Die Paket-ID wird in der Ressourcen-URL angegeben. Das Suchfeld (x-search-text header) ist für E-Mail, Dokumentname, Aktion, Infoschlüssel und Infowert vorgesehen.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Paket-ID	packageId	True	integer	Die ID des Dokuments, für das das Protokoll erforderlich ist.
Seitennummer	pageNo	True	integer	Seitenzahl, die abgerufen werden soll.
Datensätze pro Seite	recordsPerPage	True	integer	Die Gesamtzahl der Datensätze, die auf einer Seite abgerufen werden sollen.
Suchtext	x-search-text		string	Das Suchfeld (x-search-text header) ist für E-Mail, Dokumentname, Aktion, Infoschlüssel und Infowert vorgesehen.

Gibt zurück

Body: WorkflowHistoryResponse

Workflowvorlage anwenden

Vorgangs-ID:: V4_Workflow_ApplyTemplate

Geschäftsanwendungen können diese Dienst-API verwenden, um eine Workflowvorlage auf ein Dokument anzuwenden. Die Dokument-ID, auf die die Vorlage angewendet werden muss, wird in der Ressourcen-URL angegeben. Wenn die Dokument-ID auf 0 festgelegt ist, wird die Vorlage auf alle Doucments in einem Pacakge angewendet.

Beim Anwenden der Vorlage ist es wichtig, diese beiden wichtigen Punkte zu beachten:

Punkt 1 : Wenn die angewendete Vorlage mit einer PDF erstellt wird, die bereits Formularfelder enthält, stellen Sie sicher, dass das Dokument, auf das diese Vorlage jetzt angewendet wird, diese Formularfelder im Voraus enthalten muss und SignHub diese Formularfelder nicht über die Vorlage erstellt, sondern nur die Formulardaten anwendet und den jeweiligen Benutzern zugewiesen wird.

Punkt 2: Wenn die angewendete Vorlage erstellt wird, bei der Formularfelder manuell (daher nicht in der PDF-Datei ursprünglich vorhanden) über SigningHub hinzugefügt werden, z. B. Signaturfeld, initiale, persönliche Signatur, Kontrollkästchen, Optionsfelder, Textfelder usw. beim Anwenden einer solchen Vorlage, werden diese Formularfelder auch dann im Zieldokument erstellt, wenn diese Formularfelder bereits im Dokument vorhanden waren.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Paket-ID	packageId	True	integer	Die Paket-ID des Pakets, auf das die Vorlage angewendet werden muss.
Dokument-ID	documentId	True	integer	Die Dokument-ID, auf die die Vorlage angewendet werden muss. Wenn der Wert auf 0 festgelegt ist, wenn die Vorlage auf alle Dokumente im Paket angewendet werden soll.
template_name	template_name	True	string	Der Name der Vorlage, die auf das Dokument angewendet werden soll.
apply_to_all	apply_to_all	True	boolean	True, wenn die Vorlage auf alle Dokumente im Paket angewendet werden soll.

Gibt zurück

Body: DocumentDetailsResponse

Zertifizierungsrichtlinie für ein Dokument abrufen

Vorgangs-ID:: V4_Documents_GetCertifyPolicy

Geschäftsanwendungen können diese Dienst-API verwenden, um Signatureinstellungen eines Dokuments in einem Paket abzurufen.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Paket-ID	packageId	True	integer	Paket-ID des Pakets, dem das Dokument hinzugefügt wird.
Dokument-ID	documentId	True	integer	Die ID des dokuments, das heruntergeladen werden soll.

Gibt zurück

Body: CertifyPolicyResponse

Definitionen

ElectronicSealRecipient

Name	Pfad	Typ	Beschreibung
Name	name	string
level_of_assurance	level_of_assurance	string

PermissionLegalNoticeResponse

Name	Pfad	Typ	Beschreibung
enabled	enabled	boolean	True, wenn rechtliche Hinweise aktiviert und für den Empfänger konfiguriert sind.
allowed_notices	allowed_notices	array of LegalNoticeResponse	Liste der rechtlichen Hinweise, die dem Dokumentbesitzer gestattet sind, aus dem er eine für den Empfänger auswählen kann.
default_notice	default_notice	array of LegalNoticeResponse	Standard- oder ausgewählter rechtlicher Hinweis für den Empfänger.

LegalNoticeResponse

Name	Pfad	Typ	Beschreibung
legal_notice_id	legal_notice_id	integer
legal_notice_name	legal_notice_name	string	LegalNoticeResponse
legal_notice_html	legal_notice_html	string	HTML-Inhalt des Rechtlichen Hinweises.

AccessResponse

Name	Pfad	Typ
Authentifizierung	authentication	AuthenticationResponse
authentication_signing	authentication_signing	AuthenticationSigningResponse
access_duration	access_duration	PermissionAccessDurationResponse

AuthenticationResponse

Name	Pfad	Typ	Beschreibung
enabled	enabled	boolean	True, wenn die Authentifizierung für das Paket aktiviert ist.
password	password	AccessSecurityPasswordResponse
sms_otp	sms_otp	AccessSecuritySmsOtpResponse
totp	totp	TotpPermissionResponse

AccessSecurityPasswordResponse

Name	Pfad	Typ	Beschreibung
enabled	enabled	boolean	True, wenn die Kennwortauthentifizierung für das Paket aktiviert ist.
user_password	user_password	string	Authentifizierungskennwort für den Dokumentzugriff.

AccessSecuritySmsOtpResponse

Name	Pfad	Typ	Beschreibung
enabled	enabled	boolean	True, wenn die SMS OTP-Authentifizierung für das Paket aktiviert ist.
otp_length	otp_length	integer
retry_duration	retry_duration	integer
mobile_number	mobile_number	string	Mobiltelefonnummer des Empfängers. Mobiltelefonnummer ist erforderlich, um die SMS an den Empfänger für die Authentifizierung zu senden.
methods	methods	array of string	Zulässige OTP-Methoden

TotpPermissionResponse

Name	Pfad	Typ	Beschreibung
enabled	enabled	boolean	Aktiviert

AuthenticationSigningResponse

Name	Pfad	Typ	Beschreibung
enabled	enabled	boolean	True, wenn die Authentifizierung für das Paket aktiviert ist.
sms_otp	sms_otp	AuthenticationSigningSmsOtpResponse
totp	totp	TotpPermissionResponse

AuthenticationSigningSmsOtpResponse

Name	Pfad	Typ	Beschreibung
otp_length	otp_length	integer
retry_duration	retry_duration	integer
mobile_number	mobile_number	string	Mobiltelefonnummer des Empfängers. Mobiltelefonnummer ist erforderlich, um die SMS an den Empfänger für die Authentifizierung zu senden.
methods	methods	array of string	Zulässige OTP-Methoden

PermissionAccessDurationResponse

Name	Pfad	Typ	Beschreibung
enabled	enabled	boolean	True, wenn die Zugriffsdauersicherheit für das Paket aktiviert ist.
duration_by_date	duration_by_date	AccessDurationByDateResponse
duration_by_days	duration_by_days	AccessDurationByDaysResponse

AccessDurationByDateResponse

Name	Pfad	Typ	Beschreibung
enabled	enabled	boolean	True, wenn die Zugriffssicherheit für eine Dauer nach Datum und Uhrzeit aktiviert ist.
Zugänglich	accessible	boolean
duration	duration	DurationByDateResponse

DurationByDateResponse

Name	Pfad	Typ	Beschreibung
start_date_time	start_date_time	string	Datum und Uhrzeit, an dem das Paket für den Empfänger zugänglich ist.
end_date_time	end_date_time	string	Datum und Uhrzeit, nach der das Paket nicht für den Empfänger zugänglich ist.

AccessDurationByDaysResponse

Name	Pfad	Typ	Beschreibung
enabled	enabled	boolean	True, wenn die Zugriffssicherheit für eine Dauer nach Anzahl von Tagen aktiviert ist.
Zugänglich	accessible	boolean
duration	duration	DurationByDaysResponse

DurationByDaysResponse

Name	Pfad	Typ	Beschreibung
total_days	total_days	integer	Die Gesamtzahl der Tage, für die das Paket nach Erhalt des Pakets für den Empfänger zugänglich ist.

ReminderResponse

Name	Pfad	Typ	Beschreibung
enabled	enabled	boolean	True, wenn Erinnerungen für den Empfänger aktiviert sind
Frequenz	frequency	string	Erinnerungshäufigkeit. Mögliche Werte sind TAGE \| STUNDEN.
remind_after	remind_after	integer	Die Anzahl der Tage, nach denen die erste Erinnerung an den Workflowbenutzer gesendet wird.
wiederholen	repeat	ReminderRepeat

ReminderRepeat

Name	Pfad	Typ	Beschreibung
enabled	enabled	boolean	True, wenn nachfolgende Erinnerungen aktiviert sind.
Frequenz	frequency	string	Wiederholte Erinnerungshäufigkeit. Mögliche Werte sind TAGE \| STUNDEN.
keep_reminding_after	keep_reminding_after	integer	Die Anzahl der Tage, nach denen die nachfolgenden Erinnerungen an den Workflowempfänger gesendet werden.
total_reminders	total_reminders	integer	Die Anzahl der nachfolgenden Erinnerungen, die an den Workflowbenutzer gesendet werden sollen.

AddQrCodeResponse

Name	Pfad	Typ	Beschreibung
Daten	data	string	QR-Code generierte Daten
field_name	field_name	string	Name des im Dokument erstellten Felds.
value	value	string	Der Wert ist die Base64 des QrCode-Bilds.

QrCodeOptions

Name	Pfad	Typ	Beschreibung
error_correction_level	error_correction_level	ECCLevelAPI	Fehlerkorrekturstufe für den QR-Code, der die Datenredundanz bestimmt. Optionen sind: L (Niedrig), M (Mittel), Q (Quartile) und H (Hoch). Höhere Stufen bieten mehr Fehlerresistenz. Der Standardwert ist "Q"
encoding	encoding	EciModeAPI	Gibt den Zeichencodierungsmodus für den QR-Codeinhalt an. Unterstützte Optionen sind: "Standard", "Iso8859_1", "Iso8859_2" und "Utf8". Der Standardwert ist "Standard"
pixels_per_module	pixels_per_module	integer	Gibt die Anzahl der Pixel pro Modul im QR-Code an. Eine höhere Zahl führt zu einem größeren und detaillierteren QR-Code. Der Standardwert ist "20". Mögliche Werte sind: 20 \| 30 \| 40 \| 50
add_margins	add_margins	boolean	Gibt an, ob Ruhezonen (Seitenränder) um den QR-Code gezeichnet werden sollen. Ruhige Zonen helfen Scannern, den QR-Code genauer zu erkennen und zu decodieren. Der Standardwert ist "true"

ECCLevelAPI

Fehlerkorrekturstufe für den QR-Code, der die Datenredundanz bestimmt. Optionen sind: L (Niedrig), M (Mittel), Q (Quartile) und H (Hoch). Höhere Stufen bieten mehr Fehlerresistenz. Der Standardwert ist "Q"

: string

EciModeAPI

Gibt den Zeichencodierungsmodus für den QR-Codeinhalt an. Unterstützte Optionen sind: "Standard", "Iso8859_1", "Iso8859_2" und "Utf8". Der Standardwert ist "Standard"

: string

QrCodeColor

Name	Pfad	Typ	Beschreibung
Punkte	dots	string	Stellt die dunkle Farbe dar, die für die Punkte im QR-Code verwendet wird. Der Standardwert ist "schwarz". z. B. "#000000"
Hintergrund	background	string	Stellt die Lichtfarbe dar, die für den Hintergrund des QR-Codes verwendet wird. Der Standardwert ist "weiß". z. B. "#ffffff"

QrCodeLogo

Name	Pfad	Typ	Beschreibung
Base64	base64	string	Ein optionales Symbol (Base64), das in der Mitte des QR-Codes platziert werden soll.
hide_background_dots	hide_background_dots	boolean	Die Hintergrundfarbe hinter dem Symbol, wenn ein Symbol bereitgestellt wird. Wenn keine Farbe bereitgestellt wird, wird transparenter Hintergrund implementiert.
Größe	size	integer	Die Größe des Symbols als Prozentsatz der Größe des QR-Codes, wenn ein Symbol angegeben wird. Der Standardwert ist "15". Mögliche Werte sind: 10 \| 15 \| 20 \| 25 \| 30 \| 35 \| 40

AddFieldResponse

Name	Pfad	Typ	Beschreibung
field_name	field_name	string	Name des im Dokument erstellten Felds.
created_on	created_on	string	Datum und Uhrzeit der Felderstellung.

ValidationRule

Mindestens eine Regel für die Überprüfung der Felder sind mögliche Werte "OBLIGATORISCH" oder "OPTIONAL".

: string

SignatureFieldResponse

Name	Pfad	Typ	Beschreibung
field_name	field_name	string	Name des im Dokument erstellten Felds.
created_on	created_on	string	Datum und Uhrzeit der Felderstellung.

UpdateQrCodeResponse

Name	Pfad	Typ	Beschreibung
value	value	string	Der Wert ist die Base64 des QrCode-Bilds.

FieldValidationValue

Name	Pfad	Typ	Beschreibung
required	required	boolean
rules	rules	array of FieldValidationValueRule

FieldValidationValueRule

Name	Pfad	Typ	Beschreibung
type	type	string	Gibt den Typ der Gültigkeitsprüfungsregel an, der derzeit immer auf EQUALS für Textfeld festgelegt ist.
value	value	string	Stellt den Wert dar, der für die Überprüfung verwendet wird.

PostProcessResponse

Name	Pfad	Typ	Beschreibung
enabled	enabled	boolean	True, wenn die Nachbearbeitung für das Paket aktiviert ist.
contacts	contacts	array of string	Liste der E-Mail-Adressen, an die die E-Mail gesendet wird, wenn der Workflow abgeschlossen ist.
recipients	recipients	array of PostProcessRecipientResponse	Liste der Namen und E-Mail-Adressen, an die die E-Mails gesendet werden, wenn die Nachbearbeitung nach Abschluss des Workflows ausgeführt wird.
message	message	string	Jede benutzerdefinierte Zeichenfolgennachricht, die an die Kontakte gesendet werden soll, wenn der Workflow abgeschlossen ist.
google_drive	google_drive	boolean	True, wenn das Hochladen von Google Drive für das Paket aktiviert ist. Dokumente werden nach Abschluss des Workflows auf Google Drive hochgeladen.
one_drive	one_drive	boolean	True, wenn ein Laufwerkupload für das Paket aktiviert ist. Dokumente werden auf ein Laufwerk hochgeladen, wenn der Workflow abgeschlossen ist.
Dropbox	dropbox	boolean	True, wenn das Hochladen von Ablage für das Paket aktiviert ist. Dokumente werden nach Abschluss des Workflows auf Google Drive hochgeladen.
workflow_recipients	workflow_recipients	boolean	True, wenn der Workflowabschlussbericht an alle Empfänger des Workflows gesendet werden soll, wenn die Nachbearbeitung ausgeführt wird. Der Standardwert ist „false“.
document_processing_report	document_processing_report	boolean	True, wenn das Senden des Dokumentverarbeitungsberichts (XML) für den Workflow aktiviert sein soll

PostProcessRecipientResponse

Name	Pfad	Typ	Beschreibung
Name	name	string
E-Mail	email	string

ZertifizierenResponse

Name	Pfad	Typ	Beschreibung
enabled	enabled	boolean	True, wenn Zertifizierungssignatureinstellungen für das Dokument aktiviert sind.
allowed_permissions	allowed_permissions	array of string	Berechtigungsstufe für das Dokument mit Zertifizierungssignatureinstellungen zertifizieren.
default_permission	default_permission	string

GroupMemberResponse

Name	Pfad	Typ	Beschreibung
user_email	user_email	string	E-Mail-Adresse des Gruppenmitglieds
user_name	user_name	string	Benutzername des Gruppenmitglieds

MitarbeiterResponse

Name	Pfad	Typ	Beschreibung
user_email	user_email	string	Benutzer-E-Mail
signing_order	signing_order	integer	Signierreihenfolge
guest_user	guest_user	boolean	Ist Gastbenutzer
email_language_code	email_language_code	string	E-Mail-Sprachcode
Erlaubnis	permission	WorkflowPermissionResponse
Erinnerung	reminder	ReminderResponse

WorkflowPermissionResponse

Name	Pfad	Typ	Beschreibung
print	print	boolean	True, wenn der Druck für diesen Empfänger zulässig ist.
Download	download	boolean	True, wenn der Download zulässig ist.
add_text	add_text	boolean	True, wenn textanmerkung für das Dokument zulässig ist.
change_recipients	change_recipients	boolean	True, wenn der Empfänger in der aktuellen Reihenfolge andere Empfänger im Workflow ändern kann, nachdem der Workflow freigegeben wurde.
add_attachment	add_attachment	boolean	True, wenn Anlagen und Zusammenführen von PDF-Dokumenten zulässig sind.
legal_notice	legal_notice	PermissionLegalNoticeResponse
Anhang	attachment	AttachmentPermissionResponse

AttachmentPermissionResponse

Name	Pfad	Typ	Beschreibung
enabled	enabled	boolean	Aktiviert

EnterpriseTemplateResponse

Name	Pfad	Typ	Beschreibung
id	id	integer	ID der Vorlage
Name	name	string	Name der Vorlage.
Öffentlich	public	boolean	Die Antwort ist "true", wenn die Unternehmensvorlage als öffentlich markiert ist. Andernfalls würde "false" zurückgegeben.
read_only	read_only	boolean	Antwort von "true", wenn die Vorlage schreibgeschützt ist und der Benutzer nach dem Anwenden dieser Vorlage keine Änderungen am Workflow vornehmen kann. Andernfalls "false".
description	description	string	Beschreibung der Vorlage
created_on	created_on	string	Datum und Uhrzeit der Erstellung der Vorlage
roles	roles	array of EnterpriseTemplateRole
Urkunden	documents	array of TemplateDocumentResponse

EnterpriseTemplateRole

Name	Pfad	Typ	Beschreibung
Name	name	string	Der Name der Unternehmensrolle, die dem Benutzer zugewiesen ist.
id	id	integer	DIE ID der Unternehmensrolle, die dem Benutzer zugewiesen ist.

TemplateDocumentResponse

Name	Pfad	Typ	Beschreibung
id	id	integer	ID des Vorlagendokuments
Name	name	string	Name des Vorlagendokuments.

Next_signer_email

Name	Pfad	Typ	Beschreibung
user_email	user_email	string	E-Mail-Adresse des nächsten Signierers.
user_name	user_name	string	Name des nächsten Signierers.

WorkflowRecipient

Name	Pfad	Typ	Beschreibung
order	order	integer	Reihenfolge des Empfängers im Workflow.
user_email	user_email	string	E-Mail-Adresse des Empfängers, wenn der Benutzer keine Gruppe ist.
user_name	user_name	string	Name des Empfängers, wenn der Benutzer keine Gruppe ist.
mobile_number	mobile_number	string	Mobiltelefonnummer
delivery_method	delivery_method	string	Übermittlungsmethode des Empfängers Mögliche Werte: E-Mail, SMS oder EMAIL_AND_SMS
user_photo_url	user_photo_url	string	API-Endpunkt für den Zugriff auf die Ressource, Dies wird nur für Haupt signierer bereitgestellt. z.B. null für group/delegator/gatekeeper usw. Diese URL stellt nicht sicher, dass das Signiererbild vorhanden ist. Wenn das Bild vorhanden ist, wird es durch Drücken der definierten URL bereitgestellt, andernfalls handelt es sich um eine leere Zeichenfolge.
group_name	group_name	string	Gruppenname des Empfängers, wenn der Empfänger eine Gruppe ist.
group_members	group_members	array of GroupMemberResponse	Eine Liste der E-Mail-Adressen der Gruppenmitglieder, wenn der Empfänger eine Gruppe ist.
Delegatee	delegatee	string	Delegieren Sie die E-Mail-Adresse, wenn der Empfänger keine Gruppe ist.
delegatee_name	delegatee_name	string	Der Name des Delegatenbenutzers, wenn der Empfänger keine Gruppe ist.
role	role	string	Workflowrolle, in der der Empfänger hinzugefügt wurde. Diese Rolle ist nicht die Unternehmensrolle. Mögliche Werte sind "SIGNER", "REVIEWER","CARBON_COPY" und "EDITOR".
Grund	reason	string	Grund, der vom Benutzer beim Ablehnen, Genehmigen oder Übermitteln eines Dokuments bereitgestellt wird.
process_status	process_status	string	Dokumentverarbeitungsstatus für den Empfänger. Mögliche Werte sind "UN_PROCESSED", "IN_PROGRESS", "SIGNED", "REVIEW", "DECLINED", "EDITED" oder "INVALID".
processed_on	processed_on	string	Datum und Uhrzeit, zu der das Dokument verarbeitet wurde.
processed_as	processed_as	string	Der Benutzer kann das Feld als MITARBEITER, DELEGATOR, GROUP_MEMBER oder BESITZER verarbeitet haben.
processed_by	processed_by	string	E-Mail-Adresse des Benutzers, der das Dokument verarbeitet hat.
Platzhalter	placeholder	string	Platzhaltertext, wenn der Empfänger ein Platzhalter ist
signing_order	signing_order	integer	Reihenfolge, in der der Workflow von den Empfängern signiert wird. Diese Signierreihenfolge ist wichtig, wenn der Workflowtyp auf "CUSTOM" festgelegt ist.
user_national_id	user_national_id	string	Nationale Identitätsnummer des Benutzers. Dies hilft, den Benutzer im Workflow zu identifizieren.
guest_user	guest_user	boolean	Gest-Benutzer
email_language_code	email_language_code	string	E-Mail-Sprachcode
electronic_seal	electronic_seal	ElectronicSealRecipient
Gatekeeper	gatekeepers	WorkflowGatekeeperResponse

WorkflowGatekeeperResponse

Name	Pfad	Typ	Beschreibung
emails	emails	array of WorkflowGatekeeperUserResponse	Getekeeper

WorkflowGatekeeperUserResponse

Name	Pfad	Typ	Beschreibung
user_email	user_email	string

EnterpriseAccessResponse

Name	Pfad	Typ
Authentifizierung	authentication	EnterpriseAuthenticationResponse
authentication_signing	authentication_signing	EnterpriseAuthenticationSigningResponse
access_duration	access_duration	PermissionAccessDurationResponse

EnterpriseAuthenticationResponse

Name	Pfad	Typ	Beschreibung
enabled	enabled	boolean	True, wenn die Authentifizierung für das Paket aktiviert ist.
password	password	AccessSecurityPasswordResponse
sms_otp	sms_otp	EnterpriseAccessSecuritySmsOtpResponse
totp	totp	TotpPermissionResponse

EnterpriseAccessSecuritySmsOtpResponse

Name	Pfad	Typ	Beschreibung
enabled	enabled	boolean	True, wenn die SMS OTP-Authentifizierung für das Paket aktiviert ist.
otp_length	otp_length	integer
retry_duration	retry_duration	integer
mobile_number	mobile_number	string	Mobiltelefonnummer des Empfängers. Mobiltelefonnummer ist erforderlich, um die SMS an den Empfänger für die Authentifizierung zu senden.

EnterpriseAuthenticationSigningResponse

Name	Pfad	Typ	Beschreibung
enabled	enabled	boolean	True, wenn die Authentifizierung für das Paket aktiviert ist.
sms_otp	sms_otp	EnterpriseAuthenticationSigningSmsOtpResponse
totp	totp	TotpPermissionResponse

EnterpriseAuthenticationSigningSmsOtpResponse

Name	Pfad	Typ	Beschreibung
otp_length	otp_length	integer
retry_duration	retry_duration	integer
mobile_number	mobile_number	string	Mobiltelefonnummer des Empfängers. Mobiltelefonnummer ist erforderlich, um die SMS an den Empfänger für die Authentifizierung zu senden.

GetPackageDetailsResponse

Name	Pfad	Typ	Beschreibung
Name	name	string	Name des Dokumentpakets.
owner	owner	DocumentOwner
read_only	read_only	boolean	True, wenn die angewendete Vorlage schreibgeschützt ist. Der Benutzer kann keine Änderungen vornehmen, wenn eine schreibgeschützte Vorlage angewendet wird.
document_status	document_status	string	Dokumentstatus für den aktuell angemeldeten Benutzer. Mögliche Werte sind "DRAFT", "INPROGRESS", "PENDING", "DECLINED" oder "COMPLETED".
Urkunden	documents	array of DocumentDetails

DocumentOwner

Name	Pfad	Typ	Beschreibung
Name	name	string	Name des Dokumentpaketbesitzers.
E-Mail	email	string	E-Mail des Besitzers des Dokumentpakets.

DocumentDetails

Name	Pfad	Typ	Beschreibung
id	id	integer	ID des neu erstellten Dokuments.
Name	name	string	Der Name des Dokuments.
uploaded_on	uploaded_on	string	Datum und Uhrzeit des Hochladens des Dokuments.
modified_on	modified_on	string	Datum und Uhrzeit der letzten Änderung des Dokuments.
Größe	size	integer	Größe des Dokuments in Byte.
type	type	string	Typ des Dokuments, z. B. "PDF".
source	source	string	Gibt an, wo das Dokument hochgeladen wurde, z. B. "Meine App".

TemplateResponse

Name	Pfad	Typ	Beschreibung
template_id	template_id	integer	Die ID der Vorlage wird hier zurückgegeben.
template_name	template_name	string	Name der Vorlage.
template_public	template_public	boolean	Die Antwort ist "true", wenn die Unternehmensvorlage als öffentlich markiert ist. Andernfalls würde "false" zurückgegeben.
read_only	read_only	boolean	Antwort von "true", wenn die Vorlage schreibgeschützt ist und der Benutzer nach dem Anwenden dieser Vorlage keine Änderungen am Workflow vornehmen kann. Andernfalls "false".
created_on	created_on	string	Datum und Uhrzeit der Erstellung der Vorlage
description	description	string	Beschreibung der Vorlage
Unternehmen	enterprise	boolean	True, wenn der Benutzer zu einem Unternehmen gehört.
Urkunden	documents	array of TemplateDocumentResponse
smart_form	smart_form	TemplateSmartFormResponse

TemplateSmartFormResponse

Name	Pfad	Typ	Beschreibung
active_count	active_count	integer	Aktive Anzahl
total_count	total_count	integer	Total

StartWorkflowResponse

Name	Pfad	Typ	Beschreibung
package_id	package_id	integer	Paket-ID des soeben freigegebenen Pakets. Im Fall der individuellen Freigabe werden mehr als ein Paket erstellt und für die Empfänger freigegeben. DIE API gibt ein Array von Paketen zusammen mit IDs neu erstellter Dokumente zurück.
Urkunden	documents	array of integer	Array von Dokument-IDs, die teil des Pakets vor der Freigabe waren.

WorkflowDetailsResponse

Name	Pfad	Typ	Beschreibung
package_id	package_id	integer	Paket-ID des Dokumentpakets.
package_name	package_name	string	Name des Dokumentpakets.
shared_package	shared_package	boolean	Freigegebenes Paket
package_owner	package_owner	string	E-Mail-Adresse des Besitzers des Dokumentpakets.
"owner_name"	owner_name	string	Name des Dokumentpaketbesitzers.
package_status	package_status	string	Dokumentstatus für den aktuell angemeldeten Benutzer. Mögliche Werte sind "DRAFT", "INPROGRESS", "PENDING", "DECLINED", "APPROVED", "UPDATED" oder "COMPLETED".
folder	folder	string	Der Name des Ordners, der das Dokumentpaket enthält.
folder_id	folder_id	integer	ID des Ordners, der das Dokumentpaket enthält.
Gatekeeper	gatekeeper	boolean
next_signer	next_signer	string	Der Name des nächsten Signierers, wenn sich das Dokument im freigegebenen Zustand befindet.
next_signer_email	next_signer_email	array of Next_signer_email	Ein Objekt, das den Benutzernamen und die E-Mail-Adresse der nächsten Signierer enthält. Bei der Gruppenanmeldung enthält sie eine Liste der E-Mail-Adressen aller Gruppenmitglieder.
uploaded_on	uploaded_on	string	Datum und Uhrzeit des Hochladens des Dokuments.
modified_on	modified_on	string	Datum und Uhrzeit der letzten Änderung des Dokuments.
Arbeitsablauf	workflow	WorkflowResponse
Urkunden	documents	array of WorkflowDocumentsResponse	Liste der Dokumente, die im Paket hochgeladen werden.
Nutzer	users	array of WorkflowUserResponse	Empfängerliste für den Workflow.

WorkflowResponse

Name	Pfad	Typ	Beschreibung
workflow_type	workflow_type	string	Der Workflowtyp enthält vier Typen von Workflows, die in der Anwendung unterstützt werden. Mögliche Werte sind "SERIAL", "PARALLEL", "INDIVIDUAL" und "CUSTOM".
continue_on_decline	continue_on_decline	boolean	"True", wenn der Workflow auch dann fortgesetzt werden muss, wenn ein Empfänger seine Aufgabe abgelehnt hat.
workflow_status	workflow_status	string	Der Verarbeitungsstatus des Workflows, mögliche Werte sind "ENTWURF", "IN_PRGORESS" und "ABGESCHLOSSEN".
workflow_mode	workflow_mode	string	Der Workflowmodus enthält drei Typen von Workflowmodi, die in der Anwendung unterstützt werden. Mögliche Werte sind "ONLY_ME", "ME_AND_OTHERS" und "ONLY_OTHERS"
message	message	string	Jede benutzerdefinierte Zeichenfolgennachricht, die vom Dokumentbesitzer an den gesamten Empfänger des Workflows gesendet werden soll.
read_only	read_only	boolean	Wenn eine Vorlage, die auf die Dokumente in diesem Workflow angewendet wurde, schreibgeschützt oder gesperrt ist, ist der Workflow schreibgeschützt. SigningHub ermöglicht es den Endbenutzern nicht, Änderungen an diesem Workflow im Entwurfszustand vorzunehmen, und dieser Workflow soll freigegeben werden, wie er ist.
post_process	post_process	PostProcessResponse
comments	comments	boolean	Kommentare

WorkflowDocumentsResponse

Name	Pfad	Typ	Beschreibung
document_id	document_id	integer	ID des Dokuments.
document_name	document_name	string	Name des Dokuments.
document_type	document_type	string	Ursprüngliche Dokumenterweiterung, als das Dokument vor der Konvertierung in die PDF hochgeladen wurde.
document_order	document_order	integer	Reihenfolge des Dokuments im Dokumentpaket.
document_source	document_source	string	Quelle des Dokuments, aus dem das Dokument hochgeladen wurde.
update_required	update_required	boolean	True, wenn das Dokument aktualisiert werden muss
document_height	document_height	integer	Höhe des PDF-Dokuments.
document_width	document_width	integer	Breite des PDF-Dokuments.
document_pages	document_pages	integer	Gesamtanzahl der Seiten im Dokument.
created_on	created_on	string	Das Datum und die Uhrzeit, zu dem das Dokument hochgeladen wurde.
modified_on	modified_on	string	Das Datum und die Uhrzeit, zu dem das Dokument zuletzt geändert wurde.
form_fields	form_fields	boolean	True, wenn das Dokument Formularfelder enthält.
template	template	DocumentsTemplateResponse
Zertifizieren	certify	CertifyResponse
lock_form_fields	lock_form_fields	boolean	True, wenn das Dokument so festgelegt ist, dass die Formularfelder mit der letzten digitalen Signatur im Dokument gesperrt werden.
gesperrt	locked	boolean
has_signed_signature_fields	has_signed_signature_fields	boolean	Pdf-Dokumentmetainformationen: true, wenn pdf-Dokument signierte Signaturfelder enthält
Anlagen	attachments	boolean	True, wenn das Dokument Anlagen enthält.
conformance_level	conformance_level	string	Dokumentkonformitätsebene
document_size	document_size	integer	Dokumentgröße.
formatiert	formatted	boolean	Diese Eigenschaft ist für XML-Dokument vorgesehen, das entweder formatiert ist oder nicht.

DocumentsTemplateResponse

Name	Pfad	Typ	Beschreibung
template_id	template_id	integer	ID der Vorlage, die auf das Dokument angewendet wurde.
template_name	template_name	string	Der Name der Vorlage, die auf das Dokument angewendet wurde.
read_only	read_only	boolean	True, wenn die Vorlage schreibgeschützt konfiguriert ist. Nachdem eine schreibgeschützte Vorlage angewendet wurde, sollten keine Änderungen am Workflow vorgenommen werden.

WorkflowUserResponse

Name	Pfad	Typ	Beschreibung
order	order	integer	Reihenfolge des Empfängers im Workflow.
user_name	user_name	string	Der Name des Empfängers, wenn der Empfänger keine Gruppe ist. Wenn der Empfänger ein Platzhalter ist, enthält er den Namen des Platzhalters.
user_email	user_email	string	E-Mail-Adresse des Empfängers, wenn der Empfänger kein Gruppen- oder Platzhalter ist.
mobile_number	mobile_number	string	Mobiltelefonnummer
delivery_method	delivery_method	string	Übermittlungsmethode des Empfängers Mögliche Werte: E-Mail, SMS oder EMAIL_AND_SMS
user_photo_url	user_photo_url	string	API-Endpunkt für den Zugriff auf die Ressource, Dies wird nur für Haupt signierer bereitgestellt. z.B. null für group/delegator/gatekeeper usw. Diese URL stellt nicht sicher, dass das Signiererbild vorhanden ist. Wenn das Bild vorhanden ist, wird es durch Drücken der definierten URL bereitgestellt, andernfalls handelt es sich um eine leere Zeichenfolge.
group_name	group_name	string	Name der Gruppe, wenn der Empfänger eine Gruppe ist.
group_members	group_members	array of string	Liste aller E-Mail-Adressen und Namen der Benutzer.
Delegator	delegator	string	E-Mail-Adresse des Benutzers, der an diesen Empfänger delegiert wird.
Gatekeeper	gatekeeper	string	E-Mail-Adresse des Benutzers, der gatekeeper für diesen Empfänger ist.
Gatekeeper	gatekeepers	WorkflowGatekeeperResponse
role	role	string	Rolle des Empfängers, d. h. "SIGNER", "REVIEWER", "EDITOR","CARBON_COPY" oder "INPERSON_HOST".
process_status	process_status	string	Dokumentverarbeitungsstatus für den Empfänger. Mögliche Werte sind "UN_PROCESSED", "IN_PROGRESS", "SIGNED", "REVIEW", "DECLINED", "EDITED" oder "INVALID".
processed_on	processed_on	string	Datum und Uhrzeit, zu der das Dokument verarbeitet wurde.
processed_as	processed_as	string	Der Benutzer kann das Feld als MITARBEITER, DELEGATOR, GROUP_MEMBER oder BESITZER verarbeitet haben.
processed_by	processed_by	string	E-Mail-Adresse des Benutzers, der das Dokument verarbeitet hat.
Grund	reason	string	Grund, der vom Benutzer beim Ablehnen, Genehmigen oder Übermitteln eines Dokuments bereitgestellt wird.
Platzhalter	placeholder	string	Platzhaltertext, wenn der Empfänger ein Platzhalter ist.
Erlaubnis	permission	WorkflowPermissionResponse
authentications	authentications	AccessResponse
Erinnerung	reminder	ReminderResponse
signing_order	signing_order	integer	Reihenfolge, in der der Workflow von den Empfängern signiert wird. Diese Signierreihenfolge ist wichtig, wenn der Workflowtyp auf "CUSTOM" festgelegt ist.
user_national_id	user_national_id	string	Nationale Identitätsnummer des Benutzers. Dies hilft, den Benutzer im Workflow zu identifizieren.
guest_user	guest_user	boolean	Gest-Benutzer
email_language_code	email_language_code	string	E-Mail-Sprachcode
electronic_seal	electronic_seal	ElectronicSealRecipient

DocumentDetailsResponse

Name	Pfad	Typ	Beschreibung
document_id	document_id	integer	ID des neu erstellten Dokuments.
document_name	document_name	string	Der Name des Dokuments.
document_order	document_order	integer
document_type	document_type	string	Typ des Dokuments, z. B. "PDF".
document_width	document_width	integer	Breite des Dokuments im PDF-Format.
document_height	document_height	integer	Höhe des Dokuments im PDF-Format.
document_source	document_source	string	Gibt an, wo das Dokument hochgeladen wurde, z. B. "Meine App".
document_pages	document_pages	integer	Gesamtseiten des Dokuments.
form_fields	form_fields	boolean	True, wenn das Dokument Formularfelder enthält.
lock_form_fields	lock_form_fields	boolean	True, wenn das Sperren von Formularfeldern mit der letzten Signatur aktiviert ist.
uploaded_on	uploaded_on	string	Das Datum und die Uhrzeit des Hochladens des Dokuments.
modified_on	modified_on	string	Datum und Uhrzeit der letzten Änderung des Dokuments.
Zertifizieren	certify	DocumentCertifyResponse
template	template	DocumentTemplateResponse

DocumentCertifyResponse

Name	Pfad	Typ	Beschreibung
enabled	enabled	boolean	True, wenn die Zertifizierungssignatur für das Dokument aktiviert ist.
Erlaubnis	permission	string	Es handelt sich um die Zertifizierungsberechtigungen, die beim Erstellen der ersten Signatur auf das PDF-Dokument angewendet werden sollen. Die möglichen Werte sind "NO_CHANGES_ALLOWED", "FORM_FILLING_ALLOWED" und "FORM_FILLING_WITH_ANNOTATIONS_ALLOWED".

DocumentTemplateResponse

Name	Pfad	Typ	Beschreibung
template_name	template_name	string	Der Name der Vorlage, die auf das Dokument angewendet wurde.
read_only	read_only	boolean	True, wenn die angewendete Vorlage schreibgeschützt ist. Der Benutzer kann keine Änderungen vornehmen, wenn eine schreibgeschützte Vorlage angewendet wird.

AddAttachmentResponse

Name	Pfad	Typ	Beschreibung
attachment_id	attachment_id	integer	Anlagen-ID

GetAttachmentResponse

Name	Pfad	Typ	Beschreibung
attachment_id	attachment_id	integer	Anlagen-ID
attachment_name	attachment_name	string	Anlagenname

AddPackageResponse

Name	Pfad	Typ	Beschreibung
package_id	package_id	integer	Die Paket-ID, die später zum Freigeben, Herunterladen und Abrufen des Status des Dokuments verwendet werden soll.
workflow_mode	workflow_mode	string	Der Workflowmodus, der beim Hinzufügen des Pakets festgelegt wird.
workflow_type	workflow_type	string	Typ des Workflows. Mögliche Werte sind "SERIAL", "PARALLEL", "INDIVIDUAL" und "CUSTOM".

GetPackagesResponse

Name	Pfad	Typ	Beschreibung
package_id	package_id	integer	Paket-ID des Dokumentpakets.
package_name	package_name	string	Name des Dokumentpakets.
package_owner	package_owner	string	E-Mail-Adresse des Besitzers des Dokumentpakets.
"owner_name"	owner_name	string	Name des Dokumentpaketbesitzers.
shared_package	shared_package	boolean	Freigegebenes Paket
gatekeeper_package	gatekeeper_package	boolean	Gatekeeper-Paket
package_status	package_status	string	Dokumentstatus für den aktuell angemeldeten Benutzer. Mögliche Werte sind "DRAFT", "INPROGRESS", "PENDING", "DECLINED" oder "COMPLETED".
Erweiterung	extension	string	Dokumentpaketerweiterung
workflow_mode	workflow_mode	string	Workflowmodus
folder	folder	string	Der Name des Ordners, der das Dokumentpaket enthält.
folder_id	folder_id	integer	ID des Ordners, der das Dokumentpaket enthält.
ungelesen	unread	boolean	True, wenn das Dokument noch nicht vom Empfänger gelesen wird.
next_signer	next_signer	string	Der Name des nächsten Signierers, wenn sich das Dokument im freigegebenen Zustand befindet.
next_signer_email	next_signer_email	array of Next_signer_email	Ein Objekt, das den Benutzernamen und die E-Mail-Adresse der nächsten Signierer enthält. Bei der Gruppenanmeldung enthält sie eine Liste der E-Mail-Adressen aller Gruppenmitglieder.
uploaded_on	uploaded_on	string	Datum und Uhrzeit des Hochladens des Dokuments.
modified_on	modified_on	string	Datum und Uhrzeit der letzten Änderung des Dokuments.
access_duration	access_duration	RecipientAccessDurationDetails
Ablehnen	decline	RecipientDeclineDetails
Größe	size	integer	Größe des Dokuments in Byte.

RecipientAccessDurationDetails

Name	Pfad	Typ	Beschreibung
date_from	date_from	string	Startdatum/-uhrzeit für einen Empfänger für den Zugriff auf das Dokument
date_to	date_to	string	Enddatum/-uhrzeit für einen Empfänger für den Zugriff auf das Dokument

RecipientDeclineDetails

Name	Pfad	Typ	Beschreibung
Grund	reason	string	Definieren des Grunds für das Ablehnen von Dokumenten
auto_decline	auto_decline	boolean	Die Angabe des Dokuments wird manuell/automatisch abgelehnt.
declined_by	declined_by	DeclineByDetails

DeclineByDetails

Name	Pfad	Typ	Beschreibung
user_name	user_name	string	Name des Benutzers, der den Workflow abgelehnt hat
user_email	user_email	string	E-Mail-Adresse des Benutzers, der den Workflow abgelehnt hat

DocumentResponse

Name	Pfad	Typ	Beschreibung
package_name	package_name	string	Dokumentpaketname

UploadDocument

Name	Pfad	Typ	Beschreibung
documentId	documentId	integer	Diese Eigenschaft wird aus Gründen der Abwärtskompatibilität beibehalten und in späteren Versionen entfernt. Verwenden Sie stattdessen document_id.
documentid	documentid	integer	Die Dokument-ID, die später zum Freigeben, Herunterladen und Abrufen des Status des Dokuments verwendet werden soll. wird später entfernt, document_id verwendet wird.
document_id	document_id	integer	Die Dokument-ID, die später zum Freigeben, Herunterladen und Abrufen des Status des Dokuments verwendet werden soll.
document_name	document_name	string	Der Name des Dokuments.
document_order	document_order	integer	Dokumentreihenfolge im Paket
document_type	document_type	string	Typ des Dokuments, z. B. "PDF".
document_source	document_source	string	Gibt an, wo das Dokument hochgeladen wurde, z. B. "Meine App".
document_width	document_width	integer	Breite des Dokuments im PDF-Format.
document_height	document_height	integer	Höhe des Dokuments im PDF-Format.
document_pages	document_pages	integer	Gesamtseiten des Dokuments.
uploaded_on	uploaded_on	date-time	Das Datum und die Uhrzeit des Hochladens des Dokuments.
modified_on	modified_on	date-time	Datum und Uhrzeit der letzten Änderung des Dokuments.
lock_form_fields	lock_form_fields	boolean	True, wenn das Sperren von Formularfeldern mit der letzten Signatur aktiviert ist.
Zertifizieren	certify	CertifyPermissionResponse
document_size	document_size	integer	Hochgeladene Dokumentgröße in Byte
metadata	metadata	UploadDocumentMetaInfoDetail
package_name	package_name	string	Der Name des Dokumentpakets

ZertifizierenPermissionResponse

Name	Pfad	Typ	Beschreibung
enabled	enabled	boolean	True, wenn die Zertifizierungssignatur für das Dokument aktiviert ist.
allowed_permissions	allowed_permissions	array of string	Gruppe zulässiger Zertifizierungsberechtigungsstufen für das Dokument.
default_permission	default_permission	string	Ausgewählte Berechtigungsstufe für die Zertifizierungssignatureinstellungen.

UploadDocumentMetaInfoDetail

Name	Pfad	Typ	Beschreibung
Anlagen	attachments	boolean	true, wenn pdf-Dokument eine Anlage enthält
form_fields	form_fields	boolean	true, wenn im PDF-Dokument ein Formularfeld vorhanden ist
blank_signatures	blank_signatures	boolean	true, wenn das PDF-Dokument ein leeres Signaturfeld enthält
signed_signatures	signed_signatures	boolean	true, wenn das PDF-Dokument über ein signiertes Signaturfeld verfügt
Konformität	conformance	string	null/leer, wenn das Dokument keine Konformitätsstufe enthält, andernfalls die Bildung wie 1A, 1B usw.
gesperrt	locked	boolean	true, wenn das PDF-Dokument gesperrt ist
Zertifizieren	certify	string	ZertifizierenLevel des PDF-Dokuments. Mögliche Werte NotCertified, NoChangesAllowed, FormFilling, FormFillingAndAnnotations
qr_code	qr_code	boolean	"true", wenn das PDF-Dokument einen Qr-Code aufweist, andernfalls "false"

ZertifizierenPolicyResponse

Name	Pfad	Typ	Beschreibung
Zertifizieren	certify	CertifyPermissionResponse
lock_form_fields	lock_form_fields	boolean	True, wenn Formularfelder nach der letzten digitalen Signatur im aktuellen Dokument in der PDF-Datei gesperrt werden sollen.

VerificationResponse

Name	Pfad	Typ	Beschreibung
field_name	field_name	string	Name des Felds, für das die Überprüfung angefordert wurde.
signer_name	signer_name	string	Name des Signierers.
signature_status	signature_status	string	Wenn der Gesamtstatus der Signatur gültig ist oder nicht. Mögliche Werte sind "VALID" oder "INVALID".
signing_reason	signing_reason	string	Grund, der vom Benutzer beim Signieren des Felds bereitgestellt wird. Bei der Zeugensignierung würde der Grund für die benutzerdefinierte Signatur festgelegt werden.
signing_location	signing_location	string	Der vom Benutzer beim Signieren des Felds eingegebene Position.
contact_information	contact_information	string	Kontaktinformationen, die vom Benutzer beim Signieren des Felds eingegeben wurden.
signing_time	signing_time	string	Datum und Uhrzeit der Anmeldung im 8601-Format. Die Standardzeitzone von SH Admin wird die Uhrzeit befolgt.
Ltv	ltv	boolean	True, wenn die Signatur LTV ist.
Qualifizierte	qualified	boolean	True, wenn Signaturen qualifiziert sind.
zertifiziert	certified	boolean	True, wenn Signaturen zertifiziert sind.
certify_permission	certify_permission	string	Berechtigungsstufe für zertifizierte digitale Signatur.
timestamp_at	timestamp_at	string	Datum und Uhrzeit, zu dem die Signatur zeitstempelt wurde.
timestamp_authority	timestamp_authority	string	Autorität, mit der die Signatur zeitstempelt wurde.
subject_dn	subject_dn	string	Betreff DN aus dem Zertifikat, das beim Signieren des Felds verwendet wird.
issuer_dn	issuer_dn	string	Aussteller-DN aus dem Zertifikat, das beim Signieren des Felds verwendet wird.
cert_valid_from	cert_valid_from	string	Datum und Uhrzeit der Gültigkeit des Zertifikats.
cert_valid_to	cert_valid_to	string	Datum und Uhrzeit, zu der das Zertifikat gültig ist.
signature_type	signature_type	string	Der Typ der Signaturen, mögliche Werte sind "PADES_PART2" oder "PADES_PART4".
signature_algorithm	signature_algorithm	string	Signaturalgorithmus, der beim Signieren des Felds verwendet wird.
signature_application	signature_application	string	Anwendungsname, von dem aus das Feld signiert wurde.
signature_policy_id	signature_policy_id	integer	Signaturrichtlinien-ID.
signature_policy_uri	signature_policy_uri	string	Signaturrichtlinien-URI.
signer_photo	signer_photo	string	Base64-Bild des Avatars des Signierers.
signer_photo_url	signer_photo_url	string
signed_hash	signed_hash	string	Hash des Dokuments, das in der jeweiligen Signatur signiert wurde.
Bildschirm	display	string
page_number	page_number	integer	Seitenzahl des Signaturfelds
lei_number	lei_number	string	LEI-Nummer bei Verfügbarkeit in Zertifikat
lei_role	lei_role	string	LEI-Rolle, falls in Zertifikat verfügbar
Error_message	error_message	string	Es wird eine Fehlermeldung zurückgegeben, falls die Anwendung keine Überprüfungsergebnisse erhalten kann.

BulkSignResponse

Name	Pfad	Typ	Beschreibung
status	status	string
Transaktions-ID	transaction_id	string

BulkSignStatusResponse

Name	Pfad	Typ	Beschreibung
status	status	string
packages	packages	array of BulkSignPackagesStatus

BulkSignPackagesStatus

Name	Pfad	Typ	Beschreibung
id	id	integer
Name	name	string
status	status	string
Aktion	action	string	Erforderlicher Aktionsschlüssel ( falls vorhanden)
error	error	string
Prozentwert	percentage	integer
Urkunden	documents	array of BulkSignActionDocumentModel	Dokumente im aktuellen Paket

BulkSignActionDocumentModel

Name	Pfad	Typ	Beschreibung
id	id	integer
Felder	fields	array of BulkSignActionFieldModel

BulkSignActionFieldModel

Name	Pfad	Typ
Name	name	string
Hash	hash	string
hashing_algo	hashing_algo	string

SignDocumentResponse

Name	Pfad	Typ	Beschreibung
field_name	field_name	string	Name des Felds, für das die Überprüfung angefordert wurde.
status	status	string	Gibt den Status des Signaturfelds zurück. Werte sind SIGNED, PENDING. Status hilft bei eIDAS aktivierter remoteautorisierter Signierung. Wenn die Signieranforderung an mobile Geräte gesendet wird, steht der Status aus.
Transaktions-ID	transaction_id	string	Dieser Parameter wird beim RAS-Signieren verwendet.
Verifizierung	verification	VerificationResponse
authentication_access_token	authentication_access_token	string	Er enthält die OIDC-id_token, wenn der Benutzer über OIDC authentifiziert wird.

AutoPlaceFieldsResponse

Name	Pfad	Typ	Beschreibung
field_name	field_name	string	Name des Felds, das automatisch von der API generiert wurde.

ContactResponse

Name	Pfad	Typ	Beschreibung
id	id	integer	id des Kontakts.
user_name	user_name	string	Benutzername des Kontakts.
user_email	user_email	string	E-Mail-Adresse des Kontakts.
mobile_number	mobile_number	string	Mobiltelefonnummer des Kontakts.
Unternehmen	enterprise	boolean	True, wenn Kontakt Enterprise ist.
user_national_id	user_national_id	string	Nationale Identitätsnummer des Kontakts
created_on	created_on	string	DateTime, wenn kontakt hinzugefügt wird.

WorkSpaceMembers

Name	Pfad	Typ	Beschreibung
Name	name	string	Name des Arbeitsbereichsmitglieds
E-Mail	email	string	E-Mail-Adresse des Arbeitsbereichsmitglieds

WorkSpaceResponse

Name	Pfad	Typ	Beschreibung
id	id	integer	ID des freigegebenen Speicherplatzes
Name	name	string	Name des freigegebenen Leerraums
owner	owner	WorkSpaceOwner
members	members	array of WorkSpaceMembers	Mitglieder des freigegebenen Raums

WorkSpaceOwner

Name	Pfad	Typ	Beschreibung
Name	name	string	Name des Arbeitsraumbesitzers
E-Mail	email	string	E-Mail-Adresse des Besitzers des Arbeitsbereichs

UploadDocumentLibraryResponse

Name	Pfad	Typ	Beschreibung
document_id	document_id	integer	ID des neu erstellten Dokuments.
document_name	document_name	string	Der Name des Dokuments.
document_size	document_size	integer	Hochgeladene Dokumentgröße in Byte
document_order	document_order	integer	Reihenfolge des Dokuments
document_type	document_type	string	Typ des Dokuments, z. B. "PDF".
document_source	document_source	string	Gibt an, wo das Dokument hochgeladen wurde, z. B. "Meine App".
document_width	document_width	integer	Breite des Dokuments im PDF-Format.
document_height	document_height	integer	Höhe des Dokuments im PDF-Format.
document_pages	document_pages	integer	Gesamtseiten des Dokuments.
uploaded_on	uploaded_on	date-time	Das Datum und die Uhrzeit des Hochladens des Dokuments.
modified_on	modified_on	date-time	Datum und Uhrzeit der letzten Änderung des Dokuments.
form_fields	form_fields	boolean	True, wenn das Dokument Formularfelder enthält.
lock_form_fields	lock_form_fields	boolean	True, wenn das Sperren von Formularfeldern mit der letzten Signatur aktiviert ist.
Zertifizieren	certify	UploadDocumentLibraryCertifyResponse
template	template	UploadDocumentLibraryTemplateResponse
package_name	package_name	string	Paketname
metadata	metadata	UploadDocumentMetaInfoDetail

UploadDocumentLibraryCertifyResponse

Name	Pfad	Typ	Beschreibung
enabled	enabled	boolean	True, wenn die Zertifizierungssignatur für das Dokument aktiviert ist.
allowed_permissions	allowed_permissions	array of string	Gruppe zulässiger Zertifizierungsberechtigungsstufen für das Dokument.
default_permission	default_permission	string	Ausgewählte Berechtigungsstufe für die Zertifizierungssignatureinstellungen.
Erlaubnis	permission	string	Es handelt sich um die Zertifizierungsberechtigungen, die beim Erstellen der ersten Signatur auf das PDF-Dokument angewendet werden sollen. Die möglichen Werte sind "NO_CHANGES_ALLOWED", "FORM_FILLING_ALLOWED" und "FORM_FILLING_WITH_ANNOTATIONS_ALLOWED".

UploadDocumentLibraryTemplateResponse

Name	Pfad	Typ	Beschreibung
template_name	template_name	string	Der Name der Vorlage, die auf das Dokument angewendet wurde.
read_only	read_only	boolean	True, wenn die angewendete Vorlage schreibgeschützt ist. Der Benutzer kann keine Änderungen vornehmen, wenn eine schreibgeschützte Vorlage angewendet wird.

WorkflowHistoryResponse

Name	Pfad	Typ	Beschreibung
package_id	package_id	integer	ID des Pakets, für das der Workflowverlauf angefordert wird.
package_name	package_name	string
package_owner	package_owner	string	E-Mail-Adresse des Paketbesitzers.
"owner_name"	owner_name	string	Name des Paketbesitzers.
package_status	package_status	string	Status des Pakets/Dokuments mit dem aktuell angemeldeten Benutzer. Mögliche Werte sind "DRAFT", "INPROGRESS", "PENDING", "DECLINED", "APPROVED", "UPDATED" oder "COMPLETED".
next_signer	next_signer	string	Name des nächsten Empfängers.
next_signer_email	next_signer_email	array of Next_signer_email	Objekt mit Name und E-Mail-Adresse des nächsten Empfängers.
Urkunden	documents	array of WorkflowDocumentsResponse
Handlungen	actions	array of DocumentLogsActions

DocumentLogsActions

Name	Pfad	Typ	Beschreibung
log_id	log_id	integer	ID einer Aktion, die für das Dokument ausgeführt wurde.
date_time	date_time	string	Datum und Uhrzeit der Ausführung der Aktion.
action_type	action_type	string
user_email	user_email	string	E-Mail des Benutzers, der die Aktion ausgeführt hat.
user_name	user_name	string	Der Name des Benutzers, der die Aktion ausgeführt hat.
enterprise_name	enterprise_name	string	Der Name von Enterprise, zu dem der Benutzer gehört. Wenn der Benutzer nicht zu einem Unternehmen gehört, ist dieses Element nicht vorhanden.
Informationen	information	DocumentLogsActionsInformation

DocumentLogsActionsInformation

Name	Pfad	Typ	Beschreibung
type	type	string	Die Art der zusätzlichen Informationen zur Aktion, z. B. "SIGNING_METHOD", was bedeutet, welche Signaturmethode der Benutzer zum Signieren des Dokuments verwendet hat.
value	value	string	Der Wert der zusätzlichen Informationen zur Aktion, z. B. "LOCAL", was bedeutet, dass der Benutzer das Dokument mit lokal gehaltenen Anmeldeinformationen signiert hat.

UpdateCollaboratorResponse

Name	Pfad	Typ	Beschreibung
user_email	user_email	string	Benutzer-E-Mail
signing_order	signing_order	integer	Signierreihenfolge
guest_user	guest_user	boolean	Ist Gastbenutzer
email_language_code	email_language_code	string	E-Mail-Sprachcode

CollaboratorGroupResponse

Name	Pfad	Typ	Beschreibung
Erlaubnis	permission	WorkflowPermissionResponse
Erinnerung	reminder	ReminderResponse
signing_order	signing_order	integer	Signierreihenfolge

CollaboratorPlaceholderResponse

Name	Pfad	Typ	Beschreibung
Erlaubnis	permission	WorkflowPermissionResponse
Erinnerung	reminder	ReminderResponse
signing_order	signing_order	integer	Signierreihenfolge

FieldsResponse

Name	Pfad	Typ	Beschreibung
Signatur	signature	array of DigitalSignatureFieldResponse	Eine Liste aller digitalen Signaturen im Dokument.
hand_signature	hand_signature	array of HandSignatureFieldResponse
electronic_signature	electronic_signature	array of ElectronicSignatureFieldResponse
Initialen	initials	array of InitialFieldResponse
in_person_signature	in_person_signature	array of object
Elemente	in_person_signature	object
Text	text	array of TextFieldResponse
radio	radio	array of RadioFieldResponse
checkbox	checkbox	array of CheckboxFieldResponse
Dropdown	dropdown	array of DropdownFieldResponse
Listbox	listbox	array of ListBoxFieldResponse
qrcode	qrcode	array of QrCodeResponse
Anhang	attachment	array of AttachmentFieldResponse
Kommentar	comment	array of CommentFieldResponse
unique_identifier	unique_identifier	array of UniqueIdentifierFieldResponse

DigitalSignatureFieldResponse

Name	Pfad	Typ	Beschreibung
order	order	integer	Reihenfolge des Empfängers, dem dieses Feld zugewiesen ist. Wenn das Feld keiner Person zugewiesen ist, ist der Wert null.
display_order	display_order	integer	Anzeigereihenfolge entsprechend dem SigningHub-Viewer.
field_name	field_name	string	Eindeutiger Bezeichner des Felds.
page_no	page_no	integer	Seitenzahl des Dokuments, auf dem das Feld vorhanden ist.
Eingebettet	embedded	boolean	True, wenn das Feld Teil des PDF-Dokuments ist.
type	type	string	Wenn feld zugewiesen ist oder nicht, werden mögliche Werte ZUGEWIESEN, UN_ASSIGNED, SIGNED, LOGGED_IN_USER, HIDDEN und PLACEHOLDER.
process_status	process_status	string	Gibt an, ob das Feld verarbeitet wird. Mögliche Werte sind UN_PROCESSED, PROCESSED.
processed_on	processed_on	string	Datum, zu der das Dokument verarbeitet wird.
processed_as	processed_as	string	Benutzer, der das Feld als MITARBEITER, DELEGATEE, GROUP_MEMBER oder BESITZER verarbeitet hat.
created_on	created_on	string	Datum, zu dem das Feld hinzugefügt wird
processed_by	processed_by	string	E-Mail-Adresse des Benutzers, der das Feld verarbeitet hat.
dimensions	dimensions	FieldDimenssionResponse
Verifizierung	verification	VerificationResponse
Nid	nid	string
Bildschirm	display	string	Gibt den Sichtbarkeitswert des Felds für digitale Signaturen zurück, mögliche Werte sind "VISIBLE" und "INVISIBLE".
level_of_assurance	level_of_assurance	array of string
Authentifizierung	authentication	FieldAuthentication

FieldDimenssionResponse

Name	Pfad	Typ	Beschreibung
field	field	FieldResponse
Seite	page	PageResponse

FieldResponse

Name	Pfad	Typ	Beschreibung
x	x	double	Linke Position des Felds in Pixel.
y	y	double	Oberste Position des Felds in Pixel.
width	width	double	Breite des Felds in Pixel.
height	height	double	Höhe des Felds in Pixel.

PageResponse

Name	Pfad	Typ	Beschreibung
width	width	float	Breite der Seite, auf der das Feld in der PDF-Datei platziert wird.
height	height	float	Höhe der Seite, auf der das Feld in der PDF-Datei platziert wird.

FieldAuthentication

Name	Pfad	Typ	Beschreibung
enabled	enabled	boolean	True, wenn Authentifizierungen für die elektronischen Signaturfelder aktiviert sind.
sms_otp	sms_otp	AccessSecuritySmsOtpResponse
totp	totp	AccessSecurityTOTPResponse

AccessSecurityTOTPResponse

Name	Pfad	Typ	Beschreibung
enabled	enabled	boolean	True, wenn die TOTP-Authentifizierung für das Paket aktiviert ist.

HandSignatureFieldResponse

Name	Pfad	Typ	Beschreibung
order	order	integer	Reihenfolge des Empfängers, dem dieses Feld zugewiesen ist. Wenn das Feld keiner Person zugewiesen ist, ist der Wert null.
display_order	display_order	integer	Anzeigereihenfolge entsprechend dem SigningHub-Viewer.
field_name	field_name	string	Eindeutiger Bezeichner des Felds.
page_no	page_no	integer	Seitenzahl des Dokuments, auf dem das Feld vorhanden ist.
Eingebettet	embedded	boolean	True, wenn das Feld Teil des PDF-Dokuments ist.
type	type	string	Wenn feld zugewiesen ist oder nicht, werden mögliche Werte ZUGEWIESEN, UN_ASSIGNED, SIGNED, LOGGED_IN_USER, HIDDEN und PLACEHOLDER.
process_status	process_status	string	Gibt an, ob das Feld verarbeitet wird. Mögliche Werte sind UN_PROCESSED, PROCESSED.
processed_on	processed_on	string	Datum, zu der das Dokument verarbeitet wird.
processed_as	processed_as	string	Benutzer, der das Feld als MITARBEITER, DELEGATEE, GROUP_MEMBER oder BESITZER verarbeitet hat.
processed_by	processed_by	string	E-Mail-Adresse des Benutzers, der das Feld verarbeitet hat.
dimensions	dimensions	FieldDimenssionResponse
Nid	nid	string

ElectronicSignatureFieldResponse

Name	Pfad	Typ	Beschreibung
order	order	integer	E-Mail-Adresse des Benutzers, der das Feld verarbeitet hat.
display_order	display_order	integer	Anzeigereihenfolge entsprechend dem SigningHub-Viewer.
field_name	field_name	string	Eindeutiger Bezeichner des Felds.
page_no	page_no	integer	Seitenzahl des Dokuments, auf dem das Feld vorhanden ist.
Eingebettet	embedded	boolean	True, wenn das Feld Teil des PDF-Dokuments ist.
type	type	string	Wenn feld zugewiesen ist oder nicht, werden mögliche Werte ZUGEWIESEN, UN_ASSIGNED, SIGNED, LOGGED_IN_USER, HIDDEN und PLACEHOLDER.
process_status	process_status	string	Gibt an, ob das Feld verarbeitet wird. Mögliche Werte sind UN_PROCESSED, PROCESSED.
processed_on	processed_on	string	Datum, zu der das Dokument verarbeitet wird.
processed_as	processed_as	string	Benutzer, der das Feld als MITARBEITER, DELEGATEE, GROUP_MEMBER oder BESITZER verarbeitet hat.
processed_by	processed_by	string	E-Mail-Adresse des Benutzers, der das Feld verarbeitet hat.
dimensions	dimensions	FieldDimenssionResponse
signature_sub_type	signature_sub_type	string	Der Untertyp der Signatur kann eine ZEUGEN-Signatur sein. Wenn Zeugensignaturen im Serviceplan aktiviert sind, werden E-Signatur-Felder mit einem gemeinsamen Zertifikat signiert, das von allen Benutzern im Dienstplan gemeinsam genutzt wird. Mögliche Werte sind ZEUGEN oder NONE.
Authentifizierung	authentication	FieldAuthentication
Verifizierung	verification	VerificationResponse
Nid	nid	string
Bildschirm	display	string	Gibt den Sichtbarkeitswert des elektronischen Signaturfelds zurück, mögliche Werte sind "VISIBLE" und "INVISIBLE".

InitialFieldResponse

Name	Pfad	Typ	Beschreibung
order	order	integer	Reihenfolge des Empfängers, dem dieses Feld zugewiesen ist. Wenn das Feld keiner Person zugewiesen ist, ist der Wert null.
display_order	display_order	integer	Anzeigereihenfolge entsprechend dem SigningHub-Viewer.
field_name	field_name	string	Eindeutiger Bezeichner des Felds.
page_no	page_no	integer	Seitenzahl des Dokuments, auf dem das Feld vorhanden ist.
process_status	process_status	string	Gibt an, ob das Feld verarbeitet wird. Mögliche Werte sind UN_PROCESSED, PROCESSED.
processed_on	processed_on	string	Datum, zu der das Dokument verarbeitet wird.
processed_as	processed_as	string	Benutzer, der das Feld als MITARBEITER, DELEGATEE, GROUP_MEMBER oder BESITZER verarbeitet hat.
processed_by	processed_by	string	E-Mail-Adresse des Benutzers, der das Feld verarbeitet hat.
dimensions	dimensions	FieldDimenssionResponse
Eingebettet	embedded	boolean	True, wenn das Feld Teil des PDF-Dokuments ist.

TextFieldResponse

Name	Pfad	Typ	Beschreibung
required	required	boolean	True, wenn feld erforderlich in pdf
order	order	integer	Reihenfolge des Empfängers, dem dieses Feld zugewiesen ist. Wenn das Feld keiner Person zugewiesen ist, ist der Wert null.
tab_order	tab_order	integer	Aktivierreihenfolge im PDF-Dokument
display_order	display_order	integer	Anzeigereihenfolge entsprechend dem SigningHub-Viewer.
field_name	field_name	string	Eindeutiger Bezeichner des Felds.
page_no	page_no	integer	Seitenzahl des Dokuments, auf dem das Feld vorhanden ist.
Eingebettet	embedded	boolean	True, wenn das Feld Teil des PDF-Dokuments ist.
type	type	string	Der Typ des Textfelds, mögliche Werte sind "TEXT", "NAME", "COMPANY", "JOBTITLE", "EMAIL", "DATE".
value	value	string	Wert des Felds. Für typ = DATE oder format_type = DATE wird erwartet, dass der Wert dem ISO 8601-Format entspricht. Nach dem Format JJJJ-MM-DD hh:mm:ss +00. Da die Werte für Datumsfelder gelten, können Clientanwendungen JJJJ-MM-DD senden und hh:mm:ss +00 ignorieren. Wenn der Wert nicht im richtigen Format ist, wird ein Fehler zurückgegeben.
read_only	read_only	boolean	True, wenn das Feld schreibgeschützt im PDF-Dokument markiert ist.
validation_rule	validation_rule	string	Mindestens eine Regel für die Überprüfung der Felder, mögliche Werte sind "OBLIGATORISCH" oder "OPTIONAL".
Validierung	validation	FieldValidationValue
visible	visible	boolean	True, wenn das Feld im PDF-Dokument nicht ausgeblendet ist.
Mehrzeile	multiline	boolean	True, wenn das Feld mehrere Zeilen im PDF-Dokument ist.
Schriftart	font	FontResponse
Maximallänge	max_length	integer	Die maximale Inhaltslänge darf im Feld ausgefüllt werden.
format_type	format_type	string	Wenn das Feld ein Textfeld ist, kann es verschiedenen Eingabetypen entsprechen. Mögliche Werte sind ALPHANUMERIC, NUMBER, TEXT, EMAIL, TIME oder DATE.
Platzhalter	placeholder	string	Platzhaltertext für das Textfeldfeld.
format	format	string	Textformat des Felds. Wird nur für das Datumstypfeld verwendet. Mögliche Werte sind m/d m/d/yy m/d/jjjj mm/tt/jj mm/tt/jjjj mm/jj mm/jjjj d-mmm d-mmm-yyy d-mmm-jjjj tt-mmm-yyy tt-mmm-yyyyy yy-mm-dd yyyy-mm-dd mmm-yy mmm-jjjj mmmm-jj mmmm-jjjj mmmm d, jjjj tt/mm/jj ddmmmyyyy
color	color	string	Farbe des Texts in den Formularfeldern.
Randfarbe	border_color	string	Rahmenfarbe des Formularfelds.
Quickinfo	tooltip	string	QuickInfo des Formularfelds.
field_rotation	field_rotation	integer	Felddrehung
ausrichten	align	string	Textausrichtung für das Formularfeld. Mögliche Werte sind "RIGHT", "LEFT", "CENTER" oder "JUSTIFY"
dimensions	dimensions	FieldDimenssionResponse

RadioFieldResponse

Name	Pfad	Typ	Beschreibung
required	required	boolean	True, wenn feld erforderlich in pdf
order	order	integer	Reihenfolge des Empfängers, dem dieses Feld zugewiesen ist. Wenn das Feld keiner Person zugewiesen ist, ist der Wert null.
tab_order	tab_order	integer	Aktivierreihenfolge im PDF-Dokument.
display_order	display_order	integer	Anzeigereihenfolge entsprechend dem SigningHub-Viewer.
field_name	field_name	string	Eindeutiger Bezeichner des Felds.
page_no	page_no	integer	Seitenzahl des Dokuments, auf dem das Feld vorhanden ist.
Eingebettet	embedded	boolean	True, wenn das Feld Teil des PDF-Dokuments ist.
type	type	string
value	value	boolean	Wert des Felds.
read_only	read_only	boolean	True, wenn das Feld im PDF-Dokument schreibgeschützt markiert ist.
validation_rule	validation_rule	string	Mindestens eine Regel für die Überprüfung der Felder sind mögliche Werte "OBLIGATORISCH" oder "OPTIONAL".
radio_group_name	radio_group_name	string	Der Gruppenname, zu dem das Feld gehört.
überprüft	checked	boolean	True, wenn das Feld ausgewählt ist
visible	visible	boolean	True, wenn das Feld im PDF-Dokument nicht ausgeblendet ist.
dimensions	dimensions	FieldDimenssionResponse
color	color	string	Farbe des Texts in den Formularfeldern.
Randfarbe	border_color	string	Rahmenfarbe des Formularfelds.
Quickinfo	tooltip	string	QuickInfo des Formularfelds.
field_rotation	field_rotation	integer	Felddrehung

CheckboxFieldResponse

Name	Pfad	Typ	Beschreibung
required	required	boolean	True, wenn feld erforderlich in pdf
order	order	integer	Reihenfolge des Empfängers, dem dieses Feld zugewiesen ist. Wenn das Feld keiner Person zugewiesen ist, ist der Wert null.
tab_order	tab_order	integer	Aktivierreihenfolge im PDF-Dokument
display_order	display_order	integer	Anzeigereihenfolge entsprechend dem SigningHub-Viewer.
field_name	field_name	string	Eindeutiger Bezeichner des Felds.
page_no	page_no	integer	Seitenzahl des Dokuments, auf dem das Feld vorhanden ist.
Eingebettet	embedded	boolean	True, wenn das Feld Teil des PDF-Dokuments ist.
type	type	string
value	value	boolean	Wert des Felds.
read_only	read_only	boolean	True, wenn das Feld schreibgeschützt im PDF-Dokument markiert ist.
überprüft	checked	boolean	True, wenn das Feld ausgewählt ist.
visible	visible	boolean	True, wenn das Feld im PDF-Dokument nicht ausgeblendet ist.
validation_rule	validation_rule	string	Mindestens eine Regel für die Überprüfung der Felder sind mögliche Werte "OBLIGATORISCH" oder "OPTIONAL".
dimensions	dimensions	FieldDimenssionResponse
color	color	string	Farbe des Texts in den Formularfeldern.
Randfarbe	border_color	string	Rahmenfarbe des Formularfelds.
Quickinfo	tooltip	string	QuickInfo des Formularfelds.
field_rotation	field_rotation	integer	Felddrehung

DropdownFieldResponse

Name	Pfad	Typ	Beschreibung
required	required	boolean	True, wenn feld erforderlich in pdf
order	order	integer	Reihenfolge des Empfängers, dem dieses Feld zugewiesen ist. Wenn das Feld keiner Person zugewiesen ist, ist der Wert null.
tab_order	tab_order	integer	Aktivierreihenfolge im PDF-Dokument.
display_order	display_order	integer	Anzeigereihenfolge entsprechend dem SigningHub-Viewer.
field_name	field_name	string	Eindeutiger Bezeichner des Felds.
page_no	page_no	integer	Seitenzahl des Dokuments, auf dem das Feld vorhanden ist.
Eingebettet	embedded	boolean	True, wenn das Feld Teil des PDF-Dokuments ist.
validation_rule	validation_rule	string	Mindestens eine Regel für die Überprüfung der Felder sind mögliche Werte "OBLIGATORISCH" oder "OPTIONAL".
read_only	read_only	boolean	True, wenn das Feld schreibgeschützt im PDF-Dokument markiert ist.
value	value	string	Wert des Felds .
Optionen	choices	array of string	Auswahlmöglichkeiten, die für die Dropdownliste verfügbar sind, um einen Wert auszuwählen.
visible	visible	boolean	True, wenn das Feld im PDF-Dokument nicht ausgeblendet ist.
dimensions	dimensions	FieldDimenssionResponse
Schriftart	font	FontResponse
color	color	string	Farbe des Texts in den Formularfeldern.
Randfarbe	border_color	string	Rahmenfarbe des Formularfelds.
Quickinfo	tooltip	string	QuickInfo des Formularfelds.
field_rotation	field_rotation	integer	Felddrehung

ListBoxFieldResponse

Name	Pfad	Typ	Beschreibung
order	order	integer	Reihenfolge des Empfängers, dem dieses Feld zugewiesen ist. Wenn das Feld keiner Person zugewiesen ist, ist der Wert null.
tab_order	tab_order	integer	Aktivierreihenfolge im PDF-Dokument.
display_order	display_order	integer	Anzeigereihenfolge entsprechend dem SigningHub-Viewer.
field_name	field_name	string	Eindeutiger Bezeichner des Felds.
page_no	page_no	integer	Seitenzahl des Dokuments, auf dem das Feld vorhanden ist.
Eingebettet	embedded	boolean	True, wenn das Feld Teil des PDF-Dokuments ist.
validation_rule	validation_rule	string	Mindestens eine Regel für die Überprüfung der Felder sind mögliche Werte "OBLIGATORISCH" oder "OPTIONAL".
read_only	read_only	boolean	True, wenn das Feld schreibgeschützt im PDF-Dokument markiert ist.
value	value	string	Wert des Felds.
Optionen	choices	array of string	Auswahlmöglichkeiten, die für die Dropdownliste verfügbar sind, um einen Wert auszuwählen.
visible	visible	boolean	True, wenn das Feld im PDF-Dokument nicht ausgeblendet ist.
dimensions	dimensions	FieldDimenssionResponse
Schriftart	font	FontResponse
color	color	string	Farbe des Texts in den Formularfeldern.
Randfarbe	border_color	string	Rahmenfarbe des Formularfelds.
Quickinfo	tooltip	string	QuickInfo des Formularfelds.
field_rotation	field_rotation	integer	Felddrehung

FontResponse

Name	Pfad	Typ	Beschreibung
Name	name	string	Schriftartname für das Textfeld. Bei benutzerdefinierten Feldern unterstützt SigningHub nur "COURIER", "HELVETICA". Bei vorhandenen Feldern in einer PDF-Datei kann der Schriftwert alles sein, was in der PDF-Datei festgelegt wird.
Größe	size	integer	Schriftgrad für das Textfeld.
embedded_size	embedded_size	double	Schriftgrad im ursprünglichen PDF-Dokument.

QrCodeResponse

Name	Pfad	Typ	Beschreibung
field_name	field_name	string	Eindeutiger Bezeichner des Felds.
type	type	string	Feldtyp PDF_FIELD_TYPE wie QR
page_no	page_no	integer	Seitenzahl des Dokuments, auf dem das Feld vorhanden ist.
value	value	string	QrCode generiert base64 wird im Entwurfsmodus bereitgestellt
dimensions	dimensions	FieldDimenssionResponse
Daten	data	string	Die nur-Text-Daten, die im QR-Code codiert werden sollen. Der Standardwert ist die URL, die für den Zugriff auf das zugehörige Dokument generiert wird. z. B. {base_url}/document/{document_unique_id}
options	options	QrCodeOptions
color	color	QrCodeColor
Logo	logo	QrCodeLogo

AttachmentFieldResponse

Name	Pfad	Typ	Beschreibung
order	order	integer	Reihenfolge des Empfängers, dem dieses Feld zugewiesen ist.
display_order	display_order	integer	Anzeigereihenfolge entsprechend dem SigningHub-Viewer.
field_name	field_name	string	Eindeutiger Bezeichner des Felds.
page_no	page_no	integer	Seitenzahl des Dokuments, auf dem das Feld vorhanden ist.
process_status	process_status	string	Gibt an, ob das Feld verarbeitet wird. Mögliche Werte sind UN_PROCESSED, PROCESSED.
processed_on	processed_on	string	Datum, zu der das Dokument verarbeitet wird.
processed_as	processed_as	string	Benutzer, der das Feld als MITARBEITER, DELEGATEE, GROUP_MEMBER oder BESITZER verarbeitet hat.
processed_by	processed_by	string	E-Mail-Adresse des Benutzers, der das Feld verarbeitet hat.
attachmentRefId	attachmentRefId	integer	Attachmet-Referenz-ID
Hinweis	note	string	Attachmet-Notiz nur im Fall der Anlagenregel "OBLIGATORISCH"
validation_rule	validation_rule	ValidationRule	Mindestens eine Regel für die Überprüfung der Felder sind mögliche Werte "OBLIGATORISCH" oder "OPTIONAL".
dimensions	dimensions	FieldDimenssionResponse

CommentFieldResponse

Name	Pfad	Typ	Beschreibung
id	id	integer	Kommentarfeld-ID
page_no	page_no	integer	Seitenzahl des Dokuments, auf dem das Feld vorhanden ist.
unread_count	unread_count	integer	Ungelesene Kommentare
privat	private	boolean	Privat
recipients	recipients	array of CommentFieldRecipientResponse	Empfänger
dimensions	dimensions	FieldDimenssionResponse

UniqueIdentifierFieldResponse

Name	Pfad	Typ	Beschreibung
field_name	field_name	string	Eindeutiger Bezeichner des Felds.
value	value	string	Wert des Felds.
page_no	page_no	integer	Seitenzahl des Dokuments, auf dem das Feld vorhanden ist.
Schriftart	font	FontResponse
dimensions	dimensions	FieldDimenssionResponse

CommentFieldRecipientResponse

Name	Pfad	Typ	Beschreibung
user_name	user_name	string	Benutzername
user_email	user_email	string	Benutzer-E-Mail

Objekt

Dies ist der Typ „Objekt“.