REST API Änderungsprotokoll

Änderungen an der REST API v1 (/api/v1/).

---

2026

2026-08-26

TemplatePDF-Ressource — Neuer Endpunkt: GET /api/v1/templatepdf/{pdfId}/preview/ — liefert eine PDF-Vorschau für die angegebene Vorlage.

2026-08-14

Element-/Feld-Ressource — GET /api/v1/document/{id}/fields/ — hinzugefügter Abfrage-Filterparameter element_type. Siehe Dokumentfelder abrufen.

2026-07-02

TemplatePDF-Ressource — Neuer Endpunkt: GET /api/v1/templatepdf/{id}/component-token/ — liefert ein Viewer-Komponententoken zum Einbetten der PDF-Viewer-Komponente.

2026-07-01

Signer-Ressource — Neuer Endpunkt: GET /api/v1/signer/{id}/component-token/ — liefert ein Komponententoken zum Einbetten der Signatur-Komponente. Erfordert einen nicht-legacy API-Schlüssel und die Gruppe muss für die Komponentennutzung aktiviert sein.

2026-05-20

Dokument-Ressource — Signierer-Signierlinks, die in der API-Antwort zurückgegeben werden, werden nun als Legacy-Format-Links erhalten, um Abwärtskompatibilität bei Batch-/Lobby-Signaturen zu gewährleisten.

2026-04-28

Authentifizierung — Ein neues API-Schlüsselschema ist jetzt verfügbar. Bestehende Schlüssel funktionieren weiterhin. Entwicklern wird dringend empfohlen, ein Upgrade durchzuführen — siehe developer.legalesign.com für Details.

2026-01-21

TemplatePDF-Ressource — DELETE /api/v1/templatepdf/{id}/delete/ — Löschung für sichere Löschung aktualisiert. Gibt einen Fehler zurück, wenn sie fehlschlägt (z. B. wenn Aufbewahrungsrichtlinie eine sekundäre Genehmigung erfordert).

2026-01-06–07

Dokument-Ressource — Hinzugefügtes boolesches Feld append_history zur Dokument-Sende- und Detailantwort. Wenn true, wird die Signaturhistorie-Seite an das abgeschlossene PDF angefügt (entspricht dem bestehenden Verhalten von append_pdf).

Veraltet: Die Felder sign_mouse, sign_type, sign_upload in der Dokument-Ressource sind veraltet und werden in einer zukünftigen Version entfernt.

---

2025

2025-12-18–19

Dokument-Ressource — Hinzugefügter Parameter skip für Signierer beim Senden eines Dokuments. Setzt man skip: true auf eine Signierer-Position, wird dieser Empfänger beim Senden ausgelassen. Zeugen nach einem übersprungenen Signierer werden ebenfalls automatisch übersprungen.

2025-10-30

Dokument-Ressource — Erstellung der Aufbewahrungsrichtlinie wurde vom API-Senden in den Signaturfluss verschoben.

2025-10-08

• Dokument-Ressource — Antwort auf GET /api/v1/document/{id}/ enthält nun ein signer_objects-Array neben dem bestehenden signers-Array. Jedes Objekt enthält: firstname, lastname, email, tel, status, order, resource_uri, role, uuid.
• Signer-Ressource — Das Feld role wurde zur Signierer-Antwort hinzugefügt ("signer", "approver" oder "witness").

2025-09-26

• Dokument-Ressource — DELETE /api/v1/document/{id}/ — optionaler Abfrageparameter email=1 hinzugefügt, um Benachrichtigungs-E-Mails bei Löschung zu senden.
• TemplatePDF-Ressource — Parameter hide_sender_fields zum PDF-Bearbeitungs-Endpunkt hinzugefügt.
• Element-/Feld-Ressource — pdftext- und signertext-Nachschlagen akzeptieren jetzt UUID zusätzlich zum Bezeichnernamen.
• Signer-Ressource — Feld uuid zum Signierer-Antwortobjekt hinzugefügt.

2025-09-04

Dokument-Ressource — Wird beim Senden keine Nachricht angegeben, wird jetzt automatisch die Standardnachrichtenvorlage der Gruppe verwendet.

2025-08-22

Dokument-Ressource — Beim Senden eines Dokuments wird die Quell-PDF nun vom Template in den Dokumentdatensatz kopiert.

2025-06-10

TemplatePDF-Ressource — Neuer Endpunkt: POST /api/v1/templatepdf/{id}/archive/ — archiviert ein Template-PDF.

---

2024

2024-10-17

Dokument-Ressource — Entfernt den veralteten Signierer-Parameter append_to. Dieser Parameter hatte keine Wirkung und wurde entfernt.

2024-08-21

• Benutzer-Ressource — API-erstellte Benutzer erhalten jetzt ein dauerhaftes Passwort (kein temporäres, das zurückgesetzt werden muss).
• Dokument-Ressource — Admin-Element-Signer-Werte werden für Signierer-Index 0 korrekt behandelt.

2024-08-20

• Dokument-Ressource — Die Parameter convert_sender_to_signer und strict_fields akzeptieren jetzt true/"true"/1 (zuvor nur boolesches True).
• Signer-/Element-Ressource — Das Feld signer ist jetzt nullable; Elemente mit element_type: "admin" standardmäßig Signierer 0.
• Rollen — API-Rollen werden jetzt mit der Console nach Dokumenterstellung synchronisiert.
• Fehlermeldungen — Verbesserte Fehler bei fehlendem Organisationslink für Benutzer.

2024-08-19

Gruppen-(Tab)-Ressource — POST /api/v1/group/ — name ist jetzt das einzige erforderliche Feld. xframe_allow ist jetzt ein optionaler Parameter.

2024-07-16

Dokument-Ressource — Der cc-Parameter akzeptiert jetzt den Wert "default", um die Standard-CC-Mailadresse der Gruppe zu verwenden.

2024-06-14

Dokument-Ressource — Hinzugefügte Felder pdf_password und pdf_password_type in der Dokument-Detailantwort.

2024-02-20

TemplatePDF-Ressource — GET /api/v1/templatepdf/{id}/ (PDF-Download) — hinzugefügter Abfrageparameter returnAsJson, um das PDF als base64-kodierte JSON-Antwort statt als Dateidownload zurückzugeben.

2024-02-09

TemplatePDF-Ressource — Tippfehler in returnAsJson-Antwort behoben: documet_uri → document_uri.

2024-01-26

TemplatePDF-Ressource — POST /api/v1/templatepdf/ — optionaler Abfrageparameter returnAsJson hinzugefügt. Wenn gesetzt, enthält der Antwortkörper { resource: { uid, status_uri, document_uri } } anstelle eines leeren 201-Status.

2024-01-21

Dokument-Ressource — Leistungsverbesserung: GET /api/v1/document/ optimiert (schnellere Zählabfrage).

---

2023

2023-09-27

Dokument-Ressource — GET /api/v1/document/ — zwei neue Abfrage-Filterparameter hinzugefügt:

• created_gt — Filtert Dokumente, die nach einem bestimmten Datum/Uhrzeit erstellt wurden (ISO 8601)
• modified_gt — Filtert Dokumente, die nach einem bestimmten Datum/Uhrzeit geändert wurden (ISO 8601)

Die Pagination-URLs next/previous enthalten nun korrekt alle aktiven Filterparameter.

2023-08-08

Dokument-Ressource — GET /api/v1/document/ — hinzugefügter Filterparameter sentUserId.

2023-07-07

Benutzer-Ressource — Admin-Benutzer können nun Sub-User über die API erstellen.

2023-05-31

Dokument-Ressource — Zeugen werden nicht mehr in der Standard-Empfängerliste für Erinnerungen aufgenommen.

2023-04-17

• Signer-Ressource — Feld rejection_reason zur Signierer-Antwort hinzugefügt.
• Benennung — Konsistenzkorrekturen bei der Feldbenennung in der gesamten API.

2023-03-02

Webhooks — Maximale Länge des Feldes callback_url von 200 auf 500 Zeichen erhöht.

2023-01-17

Dokument-Ressource — Hinzugefügte Felder tag2 und tag3 (zusätzlich zu vorhandenem tag/tag1) für Dokument-Sendung und -Antwort.

---

2022

2022-11-14–15

Dokument-Ressource — Erhöhte maximale Anzahl erlaubter Felder pro Dokument.

2022-11-02–03

Webhooks — Neue Webhook-Ereignistypen hinzugefügt. Aktualisierte usercallback-Einträge.

2022-09-09

Dokument-Ressource — Hinzugefügter Anforderungsparameter message_template zum Angeben einer Nachrichtenvorlage beim Senden.

2022-05-12

Element-/Feld-Ressource — Hinzugefügtes Feld no_pdf: Option, ein Feld zu kennzeichnen, damit es im finalen PDF nicht gerendert wird.

2022-04-20

• Dokument-Ressource — role ist im Signierer-Dict beim Senden eines Dokuments über ein TemplatePDF nicht mehr erforderlich.
• Fehlermeldungen — Verbesserte Fehlermeldungen in der gesamten API.

2022-04-06

Element-/Feld-Ressource — Hinzugefügter Validierungstyp regex (Validierungstyp 93) für Feldwerte.

2022-02-24

Element-/Feld-Ressource — Hinzugefügtes Feld label_extra.

2022-02-22

TemplatePDF-Ressource — Hinzugefügte Option force_download beim Abruf von PDF-Entwürfen.

2022-02-17

Dokument-Ressource — Hinzugefügte Unterstützung für reviewers beim Senden eines Dokuments.

2022-02-15

Dokument-Ressource — Hinzugefügte Unterstützung für das Feld honorifics beim Dokument-POST.

---

2021

2021-11-30

Dokument-Ressource — Neuer Endpunkt: GET /api/v1/document/{id}/auditlog/ — liefert das Audit-Log für ein Dokument.

2021-10-31

Dokument-Ressource — Antwort auf GET /api/v1/document/ enthält jetzt ein Feld tag.

2021-10-30

Dokument-Ressource — Antwort auf GET /api/v1/document/ enthält jetzt ein Feld location.

2021-10-28

Dokument-Ressource — Unterstützung für Feldvalidierung beim Versenden von Dokumenten über die API hinzugefügt.

2021-10-27

Dokument-Ressource — Neuer Endpunkt: GET /api/v1/document/{id}/fields/ — liefert Felddaten für ein Dokument.

2021-10-25

Dokument-Ressource — Bundle-Unterstützung hinzugefügt. Parameter convert_sender_to_signer beim Senden eines Dokuments hinzugefügt.

2021-08-17

TemplatePDF-Ressource — Feld archive_upon_send zur Liste der Felder der Template-PDF-Ressource hinzugefügt.