REST API Änderungsprotokoll

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

---

2026

2026-07-02

TemplatePDF-Ressource — Neuer Endpunkt: GET /api/v1/templatepdf/{id}/component-token/ — gibt ein Viewer-Komponententoken zurück, um die PDF-Viewer-Komponente einzubetten.

2026-07-01

Signer-Ressource — Neuer Endpunkt: GET /api/v1/signer/{id}/component-token/ — gibt ein Komponententoken zum Einbetten der Signaturkomponente zurück. Erfordert einen nicht-veralteten API-Schlüssel und die Gruppe muss für die Komponentenverwendung aktiviert sein.

2026-05-20

Dokument-Ressource — Signer-Signatur-Links, die in der API-Antwort zurückgegeben werden, werden jetzt als Links im Legacy-Format zur Abwärtskompatibilität bei der gleichzeitigen/Lobby-Signatur erhalten.

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 wurde für sichere Löschung aktualisiert. Gibt einen Fehler zurück, wenn sie fehlschlägt (z.B. wenn die Aufbewahrungsrichtlinie eine sekundäre Genehmigung erfordert).

2026-01-06–07

Dokument-Ressource — Boolean-Feld append_history wurde zur Dokument-Senden- und Detailantwort hinzugefügt. Wenn true, wird die Signaturhistorienseite an das fertige PDF angehängt (spiegelt das bestehende append_pdf Verhalten wider).

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 — Parameter skip für Signierende beim Versenden eines Dokuments hinzugefügt. Wenn skip: true an einer Signiererposition gesetzt wird, wird dieser Empfänger beim Versand ausgelassen. Zeugen, die einem ausgelassenen Signierer folgen, werden ebenfalls automatisch ausgelassen.

2025-10-30

Dokument-Ressource — Erstellung der Aufbewahrungsrichtlinie wurde vom API-Versand in den Signaturprozess verlegt.

2025-10-08

• Dokument-Ressource — GET /api/v1/document/{id}/ Antwort enthält jetzt ein signer_objects Array zusätzlich zum bestehenden signers Array. Jedes Objekt enthält: firstname, lastname, email, tel, status, order, resource_uri, role, uuid.
• Signer-Ressource — Feld role 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-Bearbeitungsendpunkt hinzugefügt.
• Element/Feld-Ressource — pdftext und signertext Indizes akzeptieren nun UUID zusätzlich zum Bezeichnernamen.
• Signer-Ressource — Feld uuid zum Signierer-Antwortobjekt hinzugefügt.

2025-09-04

Dokument-Ressource — Wenn beim Versand keine Nachricht angegeben ist, wird jetzt automatisch die Standardnachrichtenvorlage der Gruppe verwendet.

2025-08-22

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

2025-06-10

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

---

2024

2024-10-17

Dokument-Ressource — Veralteter append_to Signiererparameter entfernt. Dieser Parameter hatte keine Wirkung und wurde entfernt.

2024-08-21

• User-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 Signiererindex 0 korrekt behandelt.

2024-08-20

• Dokument-Ressource — Parameter convert_sender_to_signer und strict_fields akzeptieren jetzt true/"true"/1 (zuvor nur boolean True).
• Signer/Element-Ressource — Feld signer ist jetzt nullable; element_type: "admin" Elemente standardmäßig auf Signierer 0.
• Rollen — API-Rollen werden nach Dokumenterstellung mit der Console synchronisiert.
• Fehlermeldungen — Verbesserte Fehlermeldung, wenn Benutzer keinen Organisationslink hat.

2024-08-19

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

2024-07-16

Dokument-Ressource — Parameter cc akzeptiert jetzt den Wert "default" zur Verwendung der Standard-CC-E-Mail-Liste der Gruppe.

2024-06-14

Dokument-Ressource — Felder pdf_password und pdf_password_type zur Dokument-Detailantwort hinzugefügt.

2024-02-20

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

2024-02-09

TemplatePDF-Ressource — Tippfehler in der returnAsJson Antwort korrigiert: 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 } } statt eines leeren 201.

2024-01-21

Dokument-Ressource — Leistungsverbesserung: GET /api/v1/document/ wurde aufgerüstet (schnellere Zählabfrage).

---

2023

2023-09-27

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

• created_gt — filtert Dokumente, die nach einem bestimmten Zeitpunkt erstellt wurden (ISO 8601)
• modified_gt — filtert Dokumente, die nach einem bestimmten Zeitpunkt geändert wurden (ISO 8601)

Paginierungs-next/previous URLs enthalten jetzt korrekt alle aktiven Filterparameter.

2023-08-08

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

2023-07-07

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

2023-05-31

Dokument-Ressource — Zeugen sind nicht mehr in der Standardliste der Erinnerungsempfänger enthalten.

2023-04-17

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

2023-03-02

Webhooks — Maximale Länge des Feldes callback_url wurde von 200 auf 500 Zeichen erweitert.

2023-01-17

Dokument-Ressource — Felder tag2 und tag3 (zusätzlich zu bestehenden tag/tag1) zum Dokument-Senden und Antwort hinzugefügt.

---

2022

2022-11-14–15

Dokument-Ressource — Maximale Anzahl der Felder pro Dokument wurde erhöht.

2022-11-02–03

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

2022-09-09

Dokument-Ressource — Anforderungsparameter message_template hinzugefügt, um eine Nachrichtenvorlage beim Versand anzugeben.

2022-05-12

Element/Feld-Ressource — Feld no_pdf hinzugefügt: Option, ein Feld so zu markieren, dass es im endgültigen PDF nicht gerendert wird.

2022-04-20

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

2022-04-06

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

2022-02-24

Element/Feld-Ressource — Feld label_extra hinzugefügt.

2022-02-22

TemplatePDF-Ressource — Option force_download bei PDF-Entwurfabruf hinzugefügt.

2022-02-17

Dokument-Ressource — Unterstützung für reviewers beim Senden eines Dokuments hinzugefügt.

2022-02-15

Dokument-Ressource — Unterstützung für honorifics Feld beim Dokument-POST hinzugefügt.

---

2021

2021-11-30

Dokument-Ressource — Neuer Endpunkt: GET /api/v1/document/{id}/auditlog/ — gibt das Auditlog eines Dokuments zurück.

2021-10-31

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

2021-10-30

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

2021-10-28

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

2021-10-27

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

2021-10-25

Dokument-Ressource — Unterstützung für bundle hinzugefügt. Parameter convert_sender_to_signer beim Versenden eines Dokuments hinzugefügt.

2021-08-17

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