Freigeben über

Legalesign (Vorschau)

Entwickelt für Compliance-fokussierte Rechts- und Betriebsteams, verknüpft legalesign es Connector Microsoft Power Platform mit dem Legalesign eSignature, um Dokument- und Empfängerworkflows auszulösen, Erinnerungen zu senden, PDFs abzurufen und Oberflächenformulardaten anzuzeigen. Erfordert ein aktives Legalesign-Abonnement, das für die API-Verwendung genehmigt wurde.

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

Dienstleistung Class Regions
Copilot Studio Premium Alle Power Automate-Regionen mit Ausnahme der folgenden Bereiche:
     - US Government (GCC)
     - US Government (GCC High)
     - China Cloud betrieben von 21Vianet
     - US Department of Defense (DoD)
Logik-Apps Norm Alle Logik-Apps-Regionen mit Ausnahme der folgenden Bereiche:
     – Azure Government-Regionen
     - Azure China-Regionen
     - US Department of Defense (DoD)
Power Apps Premium Alle Power Apps-Regionen mit Ausnahme der folgenden:
     - US Government (GCC)
     - US Government (GCC High)
     - China Cloud betrieben von 21Vianet
     - US Department of Defense (DoD)
Power Automate Premium Alle Power Automate-Regionen mit Ausnahme der folgenden Bereiche:
     - US Government (GCC)
     - US Government (GCC High)
     - China Cloud betrieben von 21Vianet
     - US Department of Defense (DoD)
Kontakt
Name API-Unterstützung
URL https://legalesign.com/contact/
Email sales@legalesign.com
Connectormetadaten
Herausgeber Legale Zuweisung
Weitere Informationen zu Legalesign https://docs.microsoft.com/connectors/legalesign
Webseite https://legalesign.com
Datenschutzrichtlinie https://legalesign.com/opn/privacy/
Kategorien Inhalt und Dateien; Produktivität

Legalesign eSignature REST Connector

Die Legalesign-REST-API unterstützt eSignature-Workflows. Dieser Connector bietet vollständigen API-Zugriff und Echtzeittrigger und ermöglicht eine nahtlose Integration mit Microsoft Power Automate, Logic Apps und verwandten Plattformen.

Voraussetzungen

Um zu beginnen, benötigen Sie ein Legalesign-Konto und API-Schlüssel: 1. Registrieren Sie sich für eine kostenlose Testversion. 2. Erstellen Sie eine Gruppe (eine einzelne Umgebung, z. B. eine für die Entwicklung und eine andere für die Produktion). 3. Fordern Sie einen API-Schlüssel an, indem Sie ein Supportticket erstellen. Schließen Sie Ihren Anwendungsfall, Ihr Unternehmen und Ihre Rolle ein, damit Support Ihre Identität überprüfen kann. 4. Melden Sie sich nach der Überprüfung beim API-Dashboard an, um Ihren Schlüssel abzurufen.

Einsatz

Neue Konten beginnen im Sandkastenmodus mit den folgenden Einschränkungen: • Dokumente können nur an Test-E-Mail-Adressen gesendet werden, die Sie im API-Dashboard konfigurieren. • Anforderungen werden auf 100/Minute gedrosselt.

Wenn Sie bereit sind, live zu gehen, erstellen Sie ein Supportticket , um Ihr Konto von Sandkasten zu Produktion zu wechseln. Zu diesem Zeitpunkt werden die Einschränkungen aufgehoben. Ausführliche Informationen finden Sie im Bereitstellungshandbuch .

Auslöser

Der Connector unterstützt zwei Echtzeittrigger:

  • Dokumentereignisse (z. B. erstellt, abgelehnt, signiert, endgültige PDF erstellt)
  • Empfängerereignisse (z. B. abgeschlossen, abgelehnt, E-Mail geöffnet, unzustellbarkeit, gesendete Erinnerungen)

Sie können alle Dokumente oder Empfänger des Filters nach Gruppe oder Ereignistyp empfangen. Alle zugeordneten Legalesign-Webhooks können im API-Dashboard verwaltet und überwacht werden.

Operationen

Legalesign-REST-API-Vorgänge werden unterstützt. Am häufigsten ist das Herunterladen einer signierten PDF-Datei, das Verwalten von Vorlagen, Dokumenten, Empfängern und Feldplatzierung. Die vollständige API-Dokumentation finden Sie in der vollständigen Spezifikation.

In Legalesign wird ein hochgeladenes Dokument als "Vorlage" bezeichnet. Wenn eine Vorlage an einen oder mehrere Empfänger gesendet wird, wird sie zu einem "Dokument". Normalerweise laden Sie eine Vorlage hoch, stellen ihren Bezeichner wieder her, und senden Sie sie dann an einen oder mehrere Empfänger.

Zu den allgemeinen Vorgängen gehören:

Vorlagen

  • Create PDF template – Hochladen einer Vorlage (beliebiger Dateityp, z. B. PDF, Word oder Bild).
  • Get PDF embeddable link – ein 1-Use-Link zum Anzeigen des Vorlagen-Editors für einen Benutzer

Dokumente

  • Location to download PDF - gibt die PDF-Binärdatei eines signierten Dokuments zurück.
  • Create signing document - Senden eines Dokuments (Auswählen einer Vorlage und Empfänger)
  • Void/archive signing document - Verhindern, dass ein Dokument signiert wird
  • Permanently delete signing document - Entfernen eines Dokuments für immer

Empfänger (Signierer)

  • Send signer reminder email – Den Empfänger daran erinnern, Ihr Dokument abzuschließen
  • Get signer rejection reason - Wenn das Dokument abgelehnt wird, lesen Sie, warum

Feldplatzierung

Legalesign verfügt über ein erweitertes Formularsystem mit Feldern. Wenn Sie über Unterzeichner verfügen, muss jeder Unterzeichner mindestens ein Signaturfeld aufweisen.

Es gibt vier Möglichkeiten zum Definieren von Feldern in Ihrer Vorlage:

  1. Hochladen einer PDF mit eingebetteten Feldern (automatisch konvertiert von Legalesign).
  2. Verwenden Sie Legalesign-Texttags.
  3. Definieren Sie x/y-Koordinaten.
  4. Verwenden Sie den Legalesign-Formular-Editor (über den Einbettungslink oder die Web-App).

Klicken Sie hier für den Leitfaden

Abfragen und Support

Melden Sie sich für zusätzliche Support- oder Abfragen bei Ihrem Legalesign-Konto an, und erstellen Sie ein Supportticket.

Erstellen einer Verbindung

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

Vorgabe

Anwendbar: Alle Regionen

Parameter zum Erstellen einer Verbindung.

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

Name Typ Description Erforderlich
API-Schlüssel securestring Die api_key für diese API Richtig

Drosselungsgrenzwerte

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

Aktionen

Abrufen von Anlagen

Anlagen auflisten.
Abrufen von Dokumenten

Auflisten nicht archivierter Signaturdokumente.
Abrufen von Dokumentfeldern

Die Felder aus dem Dokument.
Abrufen von Empfängerformularfeldern

Gibt die Formularfelder eines bestimmten Empfängers zurück.
Anlage abrufen

Rufen Sie eine Anlage ab.
Benutzer abrufen

Abrufen von Benutzerdetails.
Dokument abrufen

Gibt ein bestimmtes Dokument zurück.
Dokument endgültig löschen

Löscht Daten und Dateien endgültig.
Dokument senden

Senden Sie ein Dokument zur Signatur oder Genehmigung.
E-Mail senden einer Empfängererinnerung

Senden Sie einem Empfänger eine Erinnerungs-E-Mail.
Empfänger abrufen

Abrufen des Status und der Details eines einzelnen Empfängers.
Empfängerlink abrufen

Einverknüpfung für Empfänger zum Signieren von Seiten.
Grund zur Ablehnung des Empfängers abrufen

Gibt den Grund für das Ablehnen eines Dokuments zurück.
Gruppen abrufen

Auflisten von Gruppen, zu der der API-Benutzer gehört.
Herunterladen des Dokumentüberwachungsprotokolls

PDF nur des Dokumentüberwachungsprotokolls.
Link zum Einbetten von PDF abrufen

Zurückgeben eines einmaligen Links zum Einbetten eines PDF-Editors.
Löschen einer Anlage

Löschen einer Anlage.
Mitglied einer Gruppe

Details eines bestimmten Benutzers innerhalb einer Gruppe.
Mitglieder von Gruppen

Auflistungen aller Mitglieder Ihrer Gruppen.
PDF-Anlage hochladen

Speichern Sie eine PDF-Datei, um eine E-Mail-Adresse eines Empfängers anzufügen.
PDF herunterladen

Rufen Sie den Entwurf oder die endgültige PDF für ein Signaturdokument ab, je nach Status. Beachten Sie, dass eine Antwort von 200 oder 302 möglich ist.
PDF-Vorlage abrufen

Details zu einer bestimmten PDF-Vorlage
PDF-Vorlage hochladen

Laden Sie ein PDF-Dokument hoch, das Sie senden möchten, um signiert zu werden.
PDF-Vorlagen abrufen

PDF-Vorlagen auflisten
Ungültiges Dokument und Archivdokument

Legt ein Dokument mit Dem Status 40 fest , entfernt und archiviert es.

Abrufen von Anlagen

Vorgangs-ID:
GetAttachments

Anlagen auflisten.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Gruppen-ID
 group string

Filtern nach einer bestimmten Gruppe.
Abfragegrenzwert
 limit integer

Wird mit Offset verwendet, um Ergebnisse zu durchlaufen.
Abfrageoffset
 offset integer

Wird mit Limit verwendet, um Ergebnisse zu durchlaufen.

Gibt zurück

Anlagenauflistung

Body
AttachmentListResponse

Abrufen von Dokumenten

Vorgangs-ID:
GetDocuments

Auflisten nicht archivierter Signaturdokumente.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Gruppen-ID
 group True string

Filtern nach einer bestimmten Gruppe, erforderlich.
Einschließen archivierter Dokumente
 archived string

Filter auf archivierten Status, Standard ist nicht archiviert, verwenden Sie den Wert in diesem Parameter, um alle Dokumente abzufragen.
Nach Empfänger-E-Mail filtern
 email string

Nach Empfänger-E-Mail filtern.
Abfragegrenzwert
 limit integer

Länge des zurückzugebenden Datasets. Wird mit Offsetabfrage verwendet, um Ergebnisse zu durchlaufen.
Abfrageoffset
 offset integer

Offset vom Anfang des Datasets. Wird mit der Einschränkungsabfrage verwendet, um das Dataset zu durchlaufen.
Nach Dokumentstatus filtern
 status integer

Filtert nach Dokumentstatus.
Entfernen von Empfängern aus der Antwort
 nosigners string

Fügen Sie Wert 1 hinzu, um Empfängerinformationen für eine schnellere Abfrage zu entfernen.
Filtern nach erstellung nach diesem Datum
 created_gt date-time

Filtern Sie nach diesen Dokumenten, die nach einer bestimmten Zeit erstellt wurden.
Nach diesem Datum nach Änderung filtern
 modified_gt date-time

Filtern Sie nach diesen Dokumenten, die nach einer bestimmten Zeit geändert wurden.

Gibt zurück

Dokumentauflistungen

Body
DocumentListResponse

Abrufen von Dokumentfeldern

Vorgangs-ID:
GetDocumentFields

Die Felder aus dem Dokument.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Dokument-ID
 docId True uuid

Dokument-ID

Gibt zurück

Name Pfad Typ Beschreibung
array of object

Liste der Dokumentfelder
element_type
 element_type string

Elementtyp
Fieldorder
 fieldorder integer

Feldreihenfolge
label
 label string

Etikett
label_extra
 label_extra string

Zusätzliche Beschriftung
Unterzeichner
 signer integer

Recipient
Staat
 state boolean
Validierung
 validation integer

Überprüfungs-ID
value
 value string

Wert

Abrufen von Empfängerformularfeldern

Vorgangs-ID:
GetSignerFields

Gibt die Formularfelder eines bestimmten Empfängers zurück.

Parameter

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

Empfänger-ID

Gibt zurück

Name Pfad Typ Beschreibung
array of object
label
 label string

Etikett
label_extra
 label_extra string

Zusätzliche Beschriftung
Staat
 state boolean

Staat
Fieldorder
 fieldorder integer

Feldreihenfolge
value
 value string

Wenn es sich bei dem Feld um eine Signierdatei handelt, handelt es sich bei diesem Wert um eine kurzlebige Download-URL.

Anlage abrufen

Vorgangs-ID:
GetAttachment

Rufen Sie eine Anlage ab.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Anlagen-ID
 attachId True uuid

Anlagen-ID

Gibt zurück

Element anfügen.

Body
AttachmentResponse

Benutzer abrufen

Vorgangs-ID:
GetUser

Abrufen von Benutzerdetails.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Benutzer-ID
 userId True uuid

Benutzer-ID

Gibt zurück

Details des Benutzers.

Body
UserDetailResponse

Dokument abrufen

Vorgangs-ID:
GetDocument

Gibt ein bestimmtes Dokument zurück.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Dokument-ID
 docId True uuid

Dokument-ID

Gibt zurück

Dokumentdetails

Body
DocumentResponseDetail

Dokument endgültig löschen

Vorgangs-ID:
DeleteDocument

Löscht Daten und Dateien endgültig.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Dokument-ID
 docId True uuid

Dokument-ID

Dokument senden

Vorgangs-ID:
PostDocument

Senden Sie ein Dokument zur Signatur oder Genehmigung.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Gruppe
 group True string

Gruppenressourcen-URI
Name
 name True string

Angeben des Namens des Dokuments
PDF-Vorlage
 templatepdf True string

Die hochgeladene PDF zum Senden.
E-Mail
 email True email

Email
Vorname
 firstname True string

Vorname
Nachname
 lastname True string

Nachname
attachments
 attachments array of string

Liste der Anlagenressourcen-URIs.
expires
 expires date-time

ISO8601 formierten Datetime, bei Verwendung auf TZ des Absenders oder der Zeitzone festgelegt
message
 message string

Ihre persönliche Nachricht für die Partei, die in der Mitte der Gruppen-E-Mail-Vorlage eingegeben wurde. Verwenden Sie den Namen einer gespeicherten E-Mail-Vorlage, die von einem Hashsymbol verwendet wird, um diese Vorlage zu verwenden. Wenn mehrere Vorlagen mit demselben Namen vorhanden sind, wird die zuletzt geänderte Vorlage ausgewählt.
Vorname
 firstname string

Vorname
Nachname
 lastname string

Nachname
E-Mail
 email True email

Email
include_link
 include_link boolean

Fügen Sie einen Link zu den Signaturseiten ein, über die ein Prüfer signieren kann
SMS
 sms string

Verwenden Sie internationale Formatnummer, um die SMS-Überprüfung hinzuzufügen. Erforderlich, wenn ein Zeugen oder ein zeugener Signierer.
subject
 subject string

Betreffzeile für ausgehende E-Mails
timezone
 timezone string

TZ des Signierers muss als TZ pro Zeitzonenum gültig sein (siehe User for timezoneenum details). Wenn leer die tz des Absenders verwendet.
Signaturtyp
 signature_type integer

Verwenden Sie 4, um Ihre ausgeführte PDF-Zertifizierung zu erhalten. Empfohlen. Standardwert ist 1 (verwendet einen Sha256-Hash für die Dokumentintegrität).
PDF anfügen
 append_pdf boolean

Fügen Sie Die Validierungsinformationen für legale Zeichen an die endgültige PDF an.
auto_archive
 auto_archive boolean

Senden Sie das Archiv bald nach der Signierung. Hält web app unübersichtlich
Verwenden von Legalesign-E-Mails
 do_email boolean

Verwenden Sie legaleSign-E-Mails, um Benachrichtigungs-E-Mails zu senden. Wenn "false" alle E-Mails unterdrückt.
CC nach Abschluss
 cc_emails string

Durch Trennzeichen getrennte Zeichenfolge von E-Mail-Adressen, die über das Signieren oder Ablehnen benachrichtigt werden.
Konvertieren leerer Absenderfelder in erste Empfängerfelder
 convert_sender_to_signer boolean

Wenn absenderfelder leer bleiben, konvertieren Sie sie in Felder für den ersten Empfänger.
PDF-Kennwort
 pdf_password string

Legen Sie ein Kennwort fest. Muss ascii-codiert sein, müssen Sie auch signature_type auf 4 festlegen und eine pdf_password_type auswählen.
PDF-Kennworteinstellungen
 pdf_password_type integer

1 zum Speichern des Kennworts, 2 zum Löschen aus unseren Datensätzen nach der endgültigen Unterzeichnung.
pdftext
 pdftext object

Weisen Sie den Feldern des PDF-Absenders Werte zu, verwenden Sie die Feldbezeichnung der Vorlage oder deren uuid als Objektschlüssel. Siehe templatepdf/:id/fields/and filter for element_type="admin", to get relevant fields with their label or uuid. Siehe auch strict_fields.
Umleitungs-URL
 redirect string

URL zum Senden des Signierers nach dem Signieren (anstelle der Downloadseite). Ihre URL enthält Abfrageparameter mit ID- und Statusinformationen wie folgt: YOUR-URL?signer=[signer_uid]&doc=[doc_id]&group=[group_id]&signer_state=[signer_status]&doc_state=[doc_status]
Erinnerungszeitplan
 reminders string

Setzen Sie "Standard" ein, wenn Sie den Standarderinnerungszeitplan in der Gruppe verwenden möchten (wechseln Sie zu Web App, um den Standardzeitplan festzulegen)
Zurücksenden von Signierlinks
 return_signer_links boolean

Zurückgeben von Dokumentverknüpfungslinks für Signierer im Antworttext.
Sequenzierung senden
 signers_in_order boolean

Benachrichtigen Sie Die Anmelder in ihrer Reihenfolge. Wenn "False" alle simulatan benachrichtigt werden.
Signiertext
 signertext object

Fügen Sie benutzerdefinierte Platzhalter zu Signierfeldern hinzu. Verwenden Sie Feldbeschriftungen oder uuid als Schlüssel im Objekt (als PDF-Text). Siehe templatepdf/:id/fields/and filter for element_type = "text" to get relevant fields with their labels or uuid.
Erzwingen der Feldüberprüfung
 strict_fields boolean

Pdftext schlägt Überprüfungen im Hintergrund fehl, und legen Sie "true" fest, um zu überprüfen.
Ihre Referenz
 tag string

Tag
Ihre Referenz
 tag1 string

Tag
Ihre Referenz
 tag2 string

Tag
user
 user string

Weisen Sie einem anderen Benutzer in der Gruppe Dokumente zu.

E-Mail senden einer Empfängererinnerung

Vorgangs-ID:
PostSignerReminder

Senden Sie einem Empfänger eine Erinnerungs-E-Mail.

Parameter

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

Empfänger-ID
Text
 text string

Benutzerdefinierter Nachrichtentext

Empfänger abrufen

Vorgangs-ID:
GetRecipient

Abrufen des Status und der Details eines einzelnen Empfängers.

Parameter

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

Empfänger-ID

Gibt zurück

Empfängerdetails

Body
SignerResponse
Vorgangs-ID:
GetSignerLink

Einverknüpfung für Empfänger zum Signieren von Seiten.

Parameter

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

Empfänger-ID

Grund zur Ablehnung des Empfängers abrufen

Vorgangs-ID:
GetSignerRejection

Gibt den Grund für das Ablehnen eines Dokuments zurück.

Parameter

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

Empfänger-ID

Gibt zurück

Name Pfad Typ Beschreibung
status
 status integer

Empfängerstatues.
Grund
 reason string

Grund ablehnen.

Gruppen abrufen

Vorgangs-ID:
GetGroups

Auflisten von Gruppen, zu der der API-Benutzer gehört.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Abfrageoffset
 offset integer

Offset vom Anfang des Datasets. Wird mit der Einschränkungsabfrage verwendet, um das Dataset zu durchlaufen.
Abfragegrenzwert
 limit integer

Länge des zurückzugebenden Datasets. Wird mit Offsetabfrage verwendet, um Ergebnisse zu durchlaufen.

Gibt zurück

Gruppenauflistung

Body
GroupListResponse

Herunterladen des Dokumentüberwachungsprotokolls

Vorgangs-ID:
GetDocumentAuditLog

PDF nur des Dokumentüberwachungsprotokolls.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Dokument-ID
 docId True uuid

Dokument-ID

Gibt zurück

response
file
Vorgangs-ID:
GetPdfTemplateEditLink

Zurückgeben eines einmaligen Links zum Einbetten eines PDF-Editors.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
PDF-ID
 pdfId True string

Legen Sie die hochgeladene PDF-ID fest.
Ausblenden der Feldauflistung von gerenderter Seite
 hide_sender_fields boolean

Feldauflistung von gerenderter Seite ausblenden.
Hexcode ohne Hashsymbol für Hintergrundfarbe
 css_body_backgroundcolor string

Verwenden Sie Hexcode ohne Hashsymbol, um die Hintergrundfarbe zu ändern.

Löschen einer Anlage

Vorgangs-ID:
DeleteAttachment

Löschen einer Anlage.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Anlagen-ID
 attachId True uuid

Id anfügen

Mitglied einer Gruppe

Vorgangs-ID:
GetMember

Details eines bestimmten Benutzers innerhalb einer Gruppe.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Member-ID
 memberId True uuid

Member-ID

Gibt zurück

Body
MemberResponse

Mitglieder von Gruppen

Vorgangs-ID:
GetMembers

Auflistungen aller Mitglieder Ihrer Gruppen.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Gruppen-ID
 group string

Filtern nach einer bestimmten Gruppe
Abfragegrenzwert
 limit integer

Wird mit Offset verwendet, um Ergebnisse zu durchlaufen.
Abfrageoffset
 offset integer

Wird mit Limit verwendet, um Ergebnisse zu durchlaufen.

Gibt zurück

Body
MemberListResponse

PDF-Anlage hochladen

Vorgangs-ID:
PostAttachment

Speichern Sie eine PDF-Datei, um eine E-Mail-Adresse eines Empfängers anzufügen.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
group
 group True string

Gruppenressourcen-URI
pdf_file
 pdf_file True byte

Base64-codierte PDF-Dateidaten, maximale Größe ist standardmäßig eine Gruppeneinstellung, 5 MB.
filename
 filename True string

Einfacher alphanumerischer Name, der .pdf
user
 user string

Einem anderen Benutzer zuweisen.
Beschreibung
 description string

PDF herunterladen

Vorgangs-ID:
GetDocumentPdf

Rufen Sie den Entwurf oder die endgültige PDF für ein Signaturdokument ab, je nach Status. Beachten Sie, dass eine Antwort von 200 oder 302 möglich ist.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Dokument-ID
 docId True uuid

Dokument-ID

Gibt zurück

response
file

PDF-Vorlage abrufen

Vorgangs-ID:
GetPdfTemplate

Details zu einer bestimmten PDF-Vorlage

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
HOCHGELADENe PDF-ID
 pdfId True uuid

HOCHGELADENe PDF-ID

Gibt zurück

Vorlagendetails

Body
TemplatePdfResponse

PDF-Vorlage hochladen

Vorgangs-ID:
PostPdfTemplate

Laden Sie ein PDF-Dokument hoch, das Sie senden möchten, um signiert zu werden.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Archiv beim Senden
 archive_upon_send boolean

Legen Sie "true" fest, wenn dieser Upload nur für eine Verwendung vorgesehen ist.
Gruppe
 group True string

Geben Sie die Gruppe an, an der diese Verwendet werden soll.
PDF-Datei
 pdf_file True byte

Base64-codierte PDF-Dateidaten.
Prozesstags
 process_tags boolean

Wenn die Datei Texttags enthält, konvertieren Sie sie in Felder.
Title
 title string

Benennen Sie diesen Datensatz, verwendet den Dateinamen, wenn sie nicht verwendet wird.
Benutzer
 user string

Zuweisen zu Gruppenmitglied, wenn kein API-Benutzer.

PDF-Vorlagen abrufen

Vorgangs-ID:
GetPdfTemplates

PDF-Vorlagen auflisten

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Gruppen-ID
 group string

Kann vollständig resource_uri oder nur id sein.
Abfragegrenzwert
 limit integer

Länge des zurückzugebenden Datasets. Wird mit Offsetabfrage verwendet, um Ergebnisse zu durchlaufen.
Abfrageoffset
 offset integer

Offset vom Anfang des Datasets. Wird mit der Einschränkungsabfrage verwendet, um das Dataset zu durchlaufen.

Gibt zurück

Vorlagenauflistungen

Body
TemplatePdfListResponse

Ungültiges Dokument und Archivdokument

Vorgangs-ID:
UpdateArchiveDocument

Legt ein Dokument mit Dem Status 40 fest , entfernt und archiviert es.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Dokument-ID
 docId True uuid

Dokument-ID
Benachrichtigungs-E-Mail an Empfänger senden
 email string

Wenn "true" oder "1" festgelegt ist, werden die Empfänger benachrichtigt, dass das Dokument ungültig ist.

Trigger

Document-Ereignis

Trigger für ein Dokumentereignis
Empfängerereignis

Trigger für den Zeitpunkt, an dem ein Empfängerereignis auftritt

Document-Ereignis

Vorgangs-ID:
DocumentTrigger

Trigger für ein Dokumentereignis

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
eventFilter
 eventFilter True string

Ereignisfilter
group
 group string

Gruppenfilter

Gibt zurück

Name Pfad Typ Beschreibung
Ausgabe
 version string

Version
Objekt
 object string

Object
tag1
 data.tag1 string

Tag
recipients
 data.recipients array of object

Empfänger
Universelle eindeutige Kennung (UUID)
 data.recipients.uuid string

Empfänger-ID
E-Mail
 data.recipients.email string

E-Mail-Adresse des Empfängers
order
 data.recipients.order integer

Bestellnummer des Empfängers
status
 data.recipients.status integer

Empfängerstatus
Nachname
 data.recipients.lastname string

Nachname des Empfängers
roleText
 data.recipients.roleText string

Text der Empfängerrolle
Vorname
 data.recipients.firstname string

Vorname des Empfängers
statusText
 data.recipients.statusText string

EmpfängerstatusText
resourceUri
 data.recipients.resourceUri string

Empfängerressourcen-URI
rejectReason
 data.recipients.rejectReason string

rejectReason
groupResourceUri
 data.groupResourceUri string

Gruppenressourcen-URI
statusText
 data.statusText string

Dokumentstatustext
name
 data.name string

Dokumentname
tag
 data.tag string

Tag
resourceUri
 data.resourceUri string

Ressourcen-URI
Universelle eindeutige Kennung (UUID)
 data.uuid string

Dokument-ID
Tag2
 data.tag2 string

Tag2
group
 data.group string

Gruppe
status
 data.status integer

Belegstatus
erstellt
 created integer

Erstellt
id
 id string

Tat
Ereignis
 event string

Event

Empfängerereignis

Vorgangs-ID:
RecipientTrigger

Trigger für den Zeitpunkt, an dem ein Empfängerereignis auftritt

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
eventFilter
 eventFilter True string

Ereignisfilter
group
 group string

Gruppenfilter

Gibt zurück

Name Pfad Typ Beschreibung
Ausgabe
 version string

Version
Objekt
 object string

Object
tag
 data.tag string

Tag
tag1
 data.tag1 string

Tag1
Tag2
 data.tag2 string

Tag2
Universelle eindeutige Kennung (UUID)
 data.uuid string

Empfänger-ID
E-Mail
 data.email string

Email
group
 data.group string

Gruppe
order
 data.order integer

Bestellung
status
 data.status integer

Der Status
Dokument
 data.document string

Dokument
Nachname
 data.lastname string

Nachname
roleText
 data.roleText string

Rollentext
Vorname
 data.firstname string

Vorname
statusText
 data.statusText string

Statustext
emailBounce
 data.emailBounce integer

E-Mail hat unzustellbarkeit
resourceUri
 data.resourceUri string

Empfängerressourcen-URI
Name des Dokuments
 data.documentName string

Dokumentname
rejectReason
 data.rejectReason string

Grund ablehnen
groupResourceUri
 data.groupResourceUri string

Gruppenressourcen-URI
emailBounceMessage
 data.emailBounceMessage string

E-Mail-Unzustellbarkeitsnachricht
documentResourceUri
 data.documentResourceUri string

Dokumentressourcen-URI
erstellt
 created integer

Erstellt
id
 id string

ID
Ereignis
 event string

Event

Definitionen

PermissionsEnum

Berechtigungsoptionen

Berechtigungsoptionen

integer

ListMeta

Metainformationen zur Auflistung.

Name Pfad Typ Beschreibung
Grenze
 limit integer

Maximale Anzahl von Objekten.
nächster
 next string

URL für die nächste Gruppe von Objekten.
offset
 offset integer

Anzahl der Elemente vom Anfang des Resultsets.
vorhergehend
 previous string

URL für vorherigen Satz von Objekten.
total_count
 total_count integer

Gesamtanzahl der Objekte.

GroupListResponse

Gruppenauflistung

Name Pfad Typ Beschreibung
meta
 meta ListMeta

Metainformationen zur Auflistung.
Objekte
 objects array of object
erstellt
 objects.created date-time

Erstellt
is_active
 objects.is_active boolean

Active
geändert
 objects.modified date-time

Geändert
name
 objects.name string

Name
public_name
 objects.public_name string

Öffentlicher Name
resource_uri
 objects.resource_uri string

Ressourcen-URI
Nacktschnecke
 objects.slug string

Eindeutiger Name
user
 objects.user string

Creator-Ressourcen-URI
xframe_allow
 objects.xframe_allow boolean

Einbettungssignierung zulassen
xframe_allow_pdf_edit
 objects.xframe_allow_pdf_edit boolean

Einbettungsbearbeitung zulassen

TemplatePdfListResponse

Vorlagenauflistungen

Name Pfad Typ Beschreibung
meta
 meta ListMeta

Metainformationen zur Auflistung.
Objekte
 objects array of TemplatePdfResponse

TemplatePdfResponse

Vorlagendetails

Name Pfad Typ Beschreibung
erstellt
 created date-time

Erstellt
group
 group string

Gruppen-URI
geändert
 modified date-time

Geändert
Parteien
 parties string

JSON-Zeichenfolgenarray von Dokumentparteien.
page_count
 page_count integer

Seitenanzahl
resource_uri
 resource_uri string

Ressourcen-URI
signer_count
 signer_count integer

Anzahl der Signierer
title
 title string

Title
user
 user string

Ressourcen-URI des Erstellers
Universelle eindeutige Kennung (UUID)
 uuid uuid

PDF-ID
gültig
 valid boolean

Kann gesendet werden (wenn Felder nicht überprüft werden).

DocumentListResponse

Dokumentauflistungen

Name Pfad Typ Beschreibung
meta
 meta ListMeta

Metainformationen zur Auflistung.
Objekte
 objects array of object

Dokumente
archiviert
 objects.archived boolean

Archived
auto_archive
 objects.auto_archive boolean

Archiv nach dem Senden.
cc_emails
 objects.cc_emails string

Durch Trennzeichen getrennte Listen-E-Mails an cc nach Abschluss.
erstellt
 objects.created date-time

Erstellt
do_email
 objects.do_email boolean

Verwenden Sie Legalesign-E-Mails.
download_final
 objects.download_final boolean

Kann nach Abschluss heruntergeladen werden.
group
 objects.group string

Gruppenressourcen-URI.
geändert
 objects.modified date-time

Geändert
name
 objects.name string

Dokumentname
pdftext
 objects.pdftext string

Absenderfeldwerte
umleiten
 objects.redirect string

URL zum Umleiten des Empfängers nach der Signatur
resource_uri
 objects.resource_uri string

Ressourcen-URI
return_signer_links
 objects.return_signer_links boolean

Hinzufügen von Empfängerlinks zur Antwort
Unterzeichner
 objects.signers array of array

Geschachtelte Arrays mit Anmeldedetails
items
 objects.signers array of

Enthält immer [Signierer-URI, Vorname, Nachname, E-Mail, SMS-Nummer, has_fields, Status, Signiererreihenfolge (0-indiziert)]
signers_in_order
 objects.signers_in_order integer

Simulatan oder sequenziell E-Mail-Empfänger
status
 objects.status DocumentStatusEnum

Dokumentstatusoptionen:

  • 10 - Anfangszustand, Signiererstatus auf gesendet/unsent überprüfen
  • 20 - Felder abgeschlossen
  • 30 - Signiert
  • 40 – Entfernt (vor der Signatur)
  • 50 - Abgelehnt
tag
 objects.tag string

Tag-Dokument
tag1
 objects.tag1 string

Tag-Dokument
Tag2
 objects.tag2 string

Tag-Dokument
template
 objects.template string

Vorlagenressourcen-URI bei Verwendung
templatepdf
 objects.templatepdf string

PDF-Vorlagenressourcen-URI
Text
 objects.text string

Text zum Signieren
user
 objects.user string

Creator-URI
Universelle eindeutige Kennung (UUID)
 objects.uuid uuid

Dokument-ID

DocumentStatusEnum

Dokumentstatusoptionen:

  • 10 - Anfangszustand, Signiererstatus auf gesendet/unsent überprüfen
  • 20 - Felder abgeschlossen
  • 30 - Signiert
  • 40 – Entfernt (vor der Signatur)
  • 50 - Abgelehnt

Dokumentstatusoptionen:

  • 10 - Anfangszustand, Signiererstatus auf gesendet/unsent überprüfen
  • 20 - Felder abgeschlossen
  • 30 - Signiert
  • 40 – Entfernt (vor der Signatur)
  • 50 - Abgelehnt
integer

SignerResponse

Empfängerdetails

Name Pfad Typ Beschreibung
Dokument
 document string

Dokument
E-Mail
 email string

E-Mail-Adresse des Empfängers
Vorname
 first_name string

Vorname des Empfängers
Nachname
 last_name string

Nachname des Empfängers
has_fields
 has_fields boolean

Empfänger hat Felder
order
 order integer

Empfängerbestellung
resource_uri
 resource_uri string

Empfängerressourcen-URI
status
 status SignerStatusEnum

Signierstatusoptionen:

  • 4 - Nicht gesendet
  • 5 - Geplanter Versand
  • 10 - gesendet
  • 15 - E-Mail geöffnet
  • 20 - besucht
  • 30 - Felder abgeschlossen
  • 35 - Felder mit vollständiger Ex-Signatur
  • 39 - Warten auf den Abschluss des Zeugen
  • 40 - signiert
  • 50 - heruntergeladen
  • 60 - abgelehnt

SignerStatusEnum

Signierstatusoptionen:

  • 4 - Nicht gesendet
  • 5 - Geplanter Versand
  • 10 - gesendet
  • 15 - E-Mail geöffnet
  • 20 - besucht
  • 30 - Felder abgeschlossen
  • 35 - Felder mit vollständiger Ex-Signatur
  • 39 - Warten auf den Abschluss des Zeugen
  • 40 - signiert
  • 50 - heruntergeladen
  • 60 - abgelehnt

Signierstatusoptionen:

  • 4 - Nicht gesendet
  • 5 - Geplanter Versand
  • 10 - gesendet
  • 15 - E-Mail geöffnet
  • 20 - besucht
  • 30 - Felder abgeschlossen
  • 35 - Felder mit vollständiger Ex-Signatur
  • 39 - Warten auf den Abschluss des Zeugen
  • 40 - signiert
  • 50 - heruntergeladen
  • 60 - abgelehnt
integer

DocumentResponseDetail

Dokumentdetails

Name Pfad Typ Beschreibung
archiviert
 archived boolean

Wird archiviert
auto_archive
 auto_archive boolean

Dokumentarchiv nach der Signatur senden.
cc_emails
 cc_emails string

Wer wird cc'd mit Absender bei der E-Mail-Benachrichtigung sein, wenn sie signiert ist
erstellt
 created date-time

Erstellt
do_email
 do_email boolean

Verwenden von Legalesign-E-Mails
download_final
 download_final boolean

Endgültige PDF steht zum Download zur Verfügung.
Fußzeile
 footer string

HTML-Dokumente – Text für Fußzeilen bei Verwendung
footer_height
 footer_height integer

HTMl-Dokumente - px Höhe der Fußzeile bei Verwendung
group
 group string

Ressourcen-URI der Gruppe
has_fields
 has_fields boolean

Dokument verfügt über Felder
hash_value
 hash_value string

DIE SHA256-Prüfsumme des endgültigen Dokuments, verwenden Sie diese, um Ihren endgültigen PDF-Download zu überprüfen.
Überschrift
 header string

HTML-Dokumente – Text für Kopfzeile bei Verwendung
header_height
 header_height integer

HTMl-Dokumente – px Höhe der Kopfzeile bei Verwendung
geändert
 modified date-time

Geändert
name
 name string

Dokumentname
pdf_password
 pdf_password string

PDF-Kennwort
pdf_password_type
 pdf_password_type string

Wenn das PDF-Kennwort beibehalten wird
pdftext
 pdftext string

Dies ignorieren
umleiten
 redirect string

URL für die Empfängerumleitung nach der Signatur
resource_uri
 resource_uri string

Ressourcen-URI
return_signer_links
 return_signer_links boolean

Ignorieren
sign_mouse
 sign_mouse boolean

ignorieren
sign_time
 sign_time date-time

Signierzeit
sign_type
 sign_type boolean

Legacy
sign_upload
 sign_upload boolean

Legacy
signature_placement
 signature_placement integer

Legacy
signature_type
 signature_type integer

Legacy - immer 4
Unterzeichner
 signers array of array

Geschachtelte Arrays mit Anmeldedetails
items
 signers array of

Enthält immer [Signierer-URI, Vorname, Nachname, E-Mail, SMS-Nummer, has_fields, Status, Signiererreihenfolge (0-indiziert)]
signer_objects
 signer_objects array of object

Liste der Empfänger
E-Mail
 signer_objects.email string

Email
Vorname
 signer_objects.firstname string

Vorname
Nachname
 signer_objects.lastname string

Nachname
Telefon
 signer_objects.tel string

Tel.-Nummer
order
 signer_objects.order integer

Signierreihenfolge
resource_uri
 signer_objects.resource_uri string

Ressourcen-URI
role
 signer_objects.role string

Rolle
status
 signer_objects.status integer

Empfängerstatuscode
Universelle eindeutige Kennung (UUID)
 signer_objects.uuid string

Empfänger-ID
signers_in_order
 signers_in_order boolean

Simulatan oder sequenziell E-Mail-Empfänger
status
 status DocumentStatusEnum

Dokumentstatusoptionen:

  • 10 - Anfangszustand, Signiererstatus auf gesendet/unsent überprüfen
  • 20 - Felder abgeschlossen
  • 30 - Signiert
  • 40 – Entfernt (vor der Signatur)
  • 50 - Abgelehnt
tag
 tag string

Ihre Referenz
tag1
 tag1 string

Ihre Referenz
Tag2
 tag2 string

Ihre Referenz
template
 template string

Ressourcen-URI für Textvorlage bei Verwendung
templatepdf
 templatepdf string

Ressourcen-URI für PDF-Vorlage bei Verwendung
Text
 text string

Text für Dokument bei Verwendung
user
 user string

Benutzerressourcen-URI.
Universelle eindeutige Kennung (UUID)
 uuid uuid

Dokument-ID

MemberListResponse

Name Pfad Typ Beschreibung
meta
 meta ListMeta

Metainformationen zur Auflistung.
Objekte
 objects array of MemberResponse

MemberResponse

Name Pfad Typ Beschreibung
erstellt
 created date-time

Erstellt
group
 group string

Gruppenressourcen-URI
geändert
 modified date-time

Geändert
Erlaubnis
 permission PermissionsEnum

Berechtigungsoptionen
resource_uri
 resource_uri string

Ressourcen-URI
user
 user string

Benutzerressourcen-URI.

AttachmentResponse

Element anfügen.

Name Pfad Typ Beschreibung
erstellt
 created date-time

Erstellt
Beschreibung
 description string

Description
filename
 filename string

Dateiname
group
 group string

Gruppe
resource_uri
 resource_uri string

Ressourcen-URI anfügen
user
 user string

Benutzerressourcen-URI
Universelle eindeutige Kennung (UUID)
 uuid uuid

Id anfügen

AttachmentListResponse

Anlagenauflistung

Name Pfad Typ Beschreibung
meta
 meta ListMeta

Metainformationen zur Auflistung.
Objekte
 objects array of object

Auflistung
erstellt
 objects.created date-time

Erstellt
Beschreibung
 objects.description string

Description
filename
 objects.filename string

Dateiname
group
 objects.group string

Gruppe
resource_uri
 objects.resource_uri string

Ressourcen-URI
user
 objects.user string

Benutzerressourcen-URI
Universelle eindeutige Kennung (UUID)
 objects.uuid uuid

Id anfügen

UserDetailResponse

Details des Benutzers.

Name Pfad Typ Beschreibung
date_joined
 date_joined date-time

Beigetretenes Datum
E-Mail
 email email

Email
Vorname
 first_name string

Vorname
Gruppen
 groups array of string

Liste der Gruppen, der dieser Benutzer beigetreten ist.
last_login
 last_login date-time

Letzte Anmeldung
Nachname
 last_name string

Nachname
resource_uri
 resource_uri string

Ressourcen-URI
timezone
 timezone string

Zeitzone
username
 username string

Nutzername

file

Dies ist der grundlegende Datentyp "Datei".