Leum gu prìomh susbaint

REST API Changelog

Changes to the REST API v1 (/api/v1/).

2026​

2026-07-02​

TemplatePDF resource — New endpoint: GET /api/v1/templatepdf/{id}/component-token/ — returns a viewer component token for embedding the PDF viewer component.

2026-07-01​

Signer resource — New endpoint: GET /api/v1/signer/{id}/component-token/ — returns a component token for embedding the signing component. Requires a non-legacy API key and the group must be enabled for component use.

2026-05-20​

Document resource — Signer sign links returned in the API response are now preserved as legacy-format links for backwards compatibility when using batch/lobby signing.

2026-04-28​

Authentication — A new API key scheme is now available. Existing keys continue to work. Developers are strongly recommended to upgrade — see developer.legalesign.com for details.

2026-01-21​

TemplatePDF resource — DELETE /api/v1/templatepdf/{id}/delete/ — deletion updated for secure deletion. Returns an error if fails (e.g. retention policy requires secondary approval).

2026-01-06–07​

Document resource — Added append_history boolean field to document send and detail response. When true, the signing history page is appended to the completed PDF (mirrors the existing append_pdf behaviour).

Deprecated: sign_mouse, sign_type, sign_upload fields on the document resource are deprecated and will be removed in a future release.

2025​

2025-12-18–19​

Document resource — Added skip parameter for signers when sending a document. Setting skip: true on a signer position omits that recipient from the send. Witnesses following a skipped signer are also skipped automatically.

2025-10-30​

Document resource — Retention policy creation moved from API send to the signing flow.

2025-10-08​

  • Document resource — GET /api/v1/document/{id}/ response now includes a signer_objects array alongside the existing signers array. Each object contains: firstname, lastname, email, tel, status, order, resource_uri, role, uuid.
  • Signer resource — role field added to signer response ("signer", "approver", or "witness").

2025-09-26​

  • Document resource — DELETE /api/v1/document/{id}/ — added optional email=1 query parameter to send notification emails on deletion.
  • TemplatePDF resource — hide_sender_fields parameter added to PDF edit endpoint.
  • Element/Field resource — pdftext and signertext lookups now accept UUID in addition to label name.
  • Signer resource — uuid field added to signer response object.

2025-09-04​

Document resource — When no message is provided on send, the group's default message template is now used automatically.

2025-08-22​

Document resource — When sending a document, the source PDF is now copied from the template to the document record.

2025-06-10​

TemplatePDF resource — New endpoint: POST /api/v1/templatepdf/{id}/archive/ — archives a template PDF.

2024​

2024-10-17​

Document resource — Removed deprecated append_to signer parameter. This parameter had no effect and has been removed.

2024-08-21​

  • User resource — API-created users are now assigned a permanent password (not a temporary one requiring reset).
  • Document resource — Admin element signer values handled correctly for signer index 0.

2024-08-20​

  • Document resource — convert_sender_to_signer and strict_fields parameters now accept true/"true"/1 (previously only boolean True).
  • Signer/Element resource — signer field is now nullable; element_type: "admin" elements default to signer 0.
  • Roles — API roles now sync with the console after document creation.
  • Error messages — Improved error when user has no organisation link.

2024-08-19​

Group (Tab) resource — POST /api/v1/group/ — name is now the only required field. xframe_allow is now an optional parameter.

2024-07-16​

Document resource — cc parameter now accepts the value "default" to use the group's default CC email list.

2024-06-14​

Document resource — Added pdf_password and pdf_password_type fields to document detail response.

2024-02-20​

TemplatePDF resource — GET /api/v1/templatepdf/{id}/ (PDF download) — added returnAsJson query parameter to return the PDF as a base64-encoded JSON response instead of a file download.

2024-02-09​

TemplatePDF resource — Fixed typo in returnAsJson response: documet_uri → document_uri.

2024-01-26​

TemplatePDF resource — POST /api/v1/templatepdf/ — added optional returnAsJson query parameter. When set, the response body includes { resource: { uid, status_uri, document_uri } } instead of an empty 201.

2024-01-21​

Document resource — Performance improvement: GET /api/v1/document/ upgraded (faster count query).

2023​

2023-09-27​

Document resource — GET /api/v1/document/ — added two new query filter parameters:

  • created_gt — filter documents created after a given datetime (ISO 8601)
  • modified_gt — filter documents modified after a given datetime (ISO 8601)

Pagination next/previous URLs now correctly include all active filter parameters.

2023-08-08​

Document resource — GET /api/v1/document/ — added sentUserId filter parameter.

2023-07-07​

User resource — Admin users can now create sub-users via the API.

2023-05-31​

Document resource — Witnesses are no longer included in the default reminder recipient list.

2023-04-17​

  • Signer resource — Added rejection_reason field to signer response.
  • Naming — Consistency fixes on field naming across the API.

2023-03-02​

Webhooks — callback_url field maximum length extended from 200 to 500 characters.

2023-01-17​

Document resource — Added tag2 and tag3 fields (in addition to existing tag/tag1) to document send and response.

2022​

2022-11-14–15​

Document resource — Increased maximum number of fields allowed per document.

2022-11-02–03​

Webhooks — Added new webhook event types. Updated usercallback items.

2022-09-09​

Document resource — Added message_template request parameter to specify a message template when sending.

2022-05-12​

Element/Field resource — Added no_pdf field: option to mark a field so it does not render on the final PDF.

2022-04-20​

  • Document resource — role is no longer required in the signer dict when sending a document using a TemplatePDF.
  • Error reporting — Improved error response messages across the API.

2022-04-06​

Element/Field resource — Added regex validation type (validation type 93) for field values.

2022-02-24​

Element/Field resource — Added label_extra field.

2022-02-22​

TemplatePDF resource — Added force_download option on PDF draft retrieval.

2022-02-17​

Document resource — Added reviewers support when sending a document.

2022-02-15​

Document resource — Added honorifics field support on document POST.

2021​

2021-11-30​

Document resource — New endpoint: GET /api/v1/document/{id}/auditlog/ — returns the audit log for a document.

2021-10-31​

Document resource — GET /api/v1/document/ response now includes a tag field.

2021-10-30​

Document resource — GET /api/v1/document/ response now includes a location field.

2021-10-28​

Document resource — Added field validation support when sending documents via API.

2021-10-27​

Document resource — New endpoint: GET /api/v1/document/{id}/fields/ — returns field data for a document.

2021-10-25​

Document resource — Added bundle support. Added convert_sender_to_signer parameter when sending a document.

2021-08-17​

TemplatePDF resource — Added archive_upon_send field to the template PDF resource fields list.

Air ùrachadh mu dheireadh air

Export This Article

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