Zum Hauptinhalt springen

REST API Änderungsprotokoll

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

2027​

2027-10-27​

TemplatePDF-Ressource — POST /api/v1/templatepdf/{pdfId}/preview/ ersetzt GET zum Erzeugen von PDF-Vorschauen mit vorausgefüllten Absenderfeldern. GET bleibt weiterhin unterstützt.

2026​

2026-08-26​

TemplatePDF-Ressource — Neuer Endpunkt: GET /api/v1/templatepdf/{pdfId}/preview/ — gibt eine PDF-Vorschau für das angegebene Template zurück.

2026-08-14​

Element/Feld-Ressource — GET /api/v1/document/{id}/fields/ — hinzugefügter element_type Abfragefilterparameter. Siehe Get Document Fields.

2026-07-02​

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

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-legacy API-Schlüssel und die Gruppe muss zur Komponentennutzung aktiviert sein.

2026-05-20​

Dokument-Ressource — Signierer-Signierlinks, die in der API-Antwort zurückgegeben werden, werden jetzt als Links im Legacy-Format für die Rückwärtskompatibilität bei Batch-/Lobby-Signaturen 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, falls fehlgeschlagen (z.B. bei Aufbewahrungsrichtlinie mit sekundärer Genehmigung).

2026-01-06–07​

Dokument-Ressource — Hinzugefügt wurde das boolesche Feld append_history bei Dokumentversand und Detailantwort. Wenn true, wird die Signierhistorie-Seite an das fertige PDF angehängt (entspricht dem bestehenden append_pdf-Verhalten).

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

2025​

2025-12-18–19​

Dokument-Ressource — skip Parameter für Signierer beim Senden eines Dokuments hinzugefügt. Durch Setzen von skip: true in einer Signiererposition wird dieser Empfänger beim Versand ausgelassen. Zeugen, die einem übersprungenen Signierer folgen, werden ebenfalls automatisch übersprungen.

2025-10-30​

Dokument-Ressource — Erstellung der Aufbewahrungsrichtlinie wurde vom API-Versand in den Signaturablauf verlagert.

2025-10-08​

  • Dokument-Ressource — Die 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 — role Feld wurde der 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 — hide_sender_fields Parameter zum PDF-Bearbeitungsendpunkt hinzugefügt.
  • Element/Feld-Ressource — pdftext und signertext Lookups akzeptieren nun UUID zusätzlich zum Labelnamen.
  • Signer-Ressource — uuid Feld dem Signierer-Antwortobjekt hinzugefügt.

2025-09-04​

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

2025-08-22​

Dokument-Ressource — Beim Versand eines Dokuments wird die Quell-PDF jetzt vom Template in den Dokumentdatensatz 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 Signierer-Parameter wurde entfernt. Dieser Parameter hatte keine Wirkung und wurde entfernt.

2024-08-21​

  • User-Ressource — API-erstellte Benutzer erhalten nun ein permanentes Passwort (kein temporäres, das zurückgesetzt werden muss).
  • Dokument-Ressource — Admin-Element-Signiererwerte werden für Signiererindex 0 korrekt behandelt.

2024-08-20​

  • Dokument-Ressource — convert_sender_to_signer und strict_fields Parameter akzeptieren jetzt true/"true"/1 (zuvor nur boolean True).
  • Signer/Element-Ressource — signer Feld ist jetzt nullable; element_type: "admin" Elemente defaulten auf Signierer 0.
  • Rollen — API-Rollen werden nach der Dokumenterstellung mit dem Console-Sync synchronisiert.
  • Fehlermeldungen — Verbesserter Fehler, wenn Benutzer keine Organisationsverknüpfung hat.

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 — cc Parameter akzeptiert jetzt den Wert "default", um die Standard-CC-E-Mail-Liste der Gruppe zu verwenden.

2024-06-14​

Dokument-Ressource — Hinzugefügt wurden die Felder pdf_password und pdf_password_type zur Dokumentdetailantwort.

2024-02-20​

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

2024-02-09​

TemplatePDF-Ressource — Tippfehler im returnAsJson Antwortfeld behoben: documet_uri → document_uri.

2024-01-26​

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

2024-01-21​

Dokument-Ressource — Leistungsverbesserung: GET /api/v1/document/ aktualisiert (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 Datum/Zeit erstellt wurden (ISO 8601)
  • modified_gt — filtert Dokumente, die nach einem bestimmten Datum/Zeit geändert wurden (ISO 8601)

Paginierungs-URLs next/previous 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 Sub-User via API erstellen.

2023-05-31​

Dokument-Ressource — Zeugen werden nicht mehr in der Standardliste der Erinnerungsempfänger berücksichtigt.

2023-04-17​

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

2023-03-02​

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

2023-01-17​

Dokument-Ressource — Felder tag2 und tag3 hinzugefügt (zusätzlich zu vorhandenen tag/tag1) beim Dokumentversand und der Antwort.

2022​

2022-11-14–15​

Dokument-Ressource — Maximale Anzahl zulässiger Felder pro Dokument erhöht.

2022-11-02–03​

Webhooks — Neue Webhook-Ereignistypen hinzugefügt. usercallback Items aktualisiert.

2022-09-09​

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

2022-05-12​

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

2022-04-20​

  • Dokument-Ressource — role ist beim Signierer-Dictionary beim Versenden eines Dokuments mit TemplatePDF nicht mehr erforderlich.
  • Fehlermeldungen — Verbesserte Fehlerantwortnachrichten über die API hinweg.

2022-04-06​

Element/Feld-Ressource — Validierungstyp regex (Typ 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 beim PDF-Entwurfabruf hinzugefügt.

2022-02-17​

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

2022-02-15​

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

2021​

2021-11-30​

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

2021-10-31​

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

2021-10-30​

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

2021-10-28​

Dokument-Ressource — Unterstützung für Feldvalidierung beim Versenden von Dokumenten via 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 Dokumentversand hinzugefügt.

2021-08-17​

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

Export This Article

Save a copy of this page as PDF or plain text.