Changed

• Updating document fields is now atomic: either all fields are updated or none are, so partial updates no longer leave documents in an inconsistent state. On success, the endpoint now returns 204 No Content instead of 200 OK — update any clients that rely on parsing the response payload.

PATCH /public/v1/documents/{id}/fields

• ⚠️ removed the success response with the status 200
• added the success response with the status 204

Added

• Added a new endpoint to retrieve notarization requests, enabling you to programmatically fetch details about notarization processes.

  GET /public/v2/notary/notarization-requests

  • endpoint added

Changed

• Enhanced the notarization request creation endpoint with new error responses, providing clearer feedback with 400 Bad Request and 401 Unauthorized statuses for invalid requests or authentication issues.

  POST /public/v2/notary/notarization-requests

  • added the non-success response with the status 400
  • added the non-success response with the status 401

Added

• Added endpoint to update document fields, allowing programmatic modification of individual field values within a document.

PATCH /public/v1/documents/{id}/fields

• endpoint added

Added

• Added endpoint to retrieve a single user's details, so you can fetch user information for a specific user through the API

GET /public/v1/users/{user_id}

• endpoint added

We’ve enhanced our Field Tags capabilities to provide more flexibility when building your documents. Previously, radio buttons were always required, and the optional * modifier was unsupported.

We are excited to share that radio buttons now fully support the optional modifier (*), allowing recipients to leave these fields unselected if desired!

With this update, the current limitations when working with radio buttons have been updated to the following:

• Radio button options within the same block must be on the same page.
• Preselection of options is not supported.
• Different blocks require unique IDs.
• Values for radio button options must be unique.
• Each document can have a minimum of two and a maximum of 50 radio button options.

📚 Documentation: For more details, check out our updated guide on How to Add Field Tags to Documents.

Added

• Beta document endpoints let you pull the full document text in plain text or Markdown, and request summaries at three levels (detailed, short, or headline). When content or a summary is still being prepared, the API responds with 202 and a Retry-After hint so clients can poll safely. Successful responses include ETag and Vary so caches stay correct when you change format or type.

GET /public/beta/documents/{document_id}/content

• endpoint added

GET /public/beta/documents/{document_id}/summary

• endpoint added

Added

• Enhanced notarization request details to include termination information. You can now retrieve details and reasons for a notarization session's termination, providing more comprehensive insights into session outcomes.

GET /public/v2/notary/notarization-requests/{session_request_id}

• added the optional property 'termination_details' to the response with the '200' status
• added the optional property 'termination_reason' to the response with the '200' status

Added

Added endpoint to programmatically delete documents (bulk), enabling you to manage and remove documents via the API.

Enhanced markdown document creation with fields_mapping property, allowing custom field mapping when uploading markdown content via the API.

DELETE /public/v1/documents

• endpoint added

POST /public/v1/documents?upload-markdown

• added the new optional request property 'data/fields_mapping'

Added

• Added a new endpoint to create documents by uploading Markdown content, enabling you to programmatically generate rich-text documents from Markdown.

[Beta] POST /public/v1/documents?upload-markdown

• endpoint added

Changed

• Implemented minimum value constraints for document field layout properties (offset_x, offset_y, height, width) to ensure valid positioning and sizing when programmatically updating document fields.

POST /public/v1/documents/{id}/fields

• ⚠️ the 'fields/items/layout/position/offset_x' request property's min was set to '0.00'
• ⚠️ the 'fields/items/layout/position/offset_y' request property's min was set to '0.00'
• ⚠️ the 'fields/items/layout/style/height' request property's min was set to '0.00'
• ⚠️ the 'fields/items/layout/style/width' request property's min was set to '0.00'

Changed

• Increased the maximum length for email reminder subject lines, allowing you to create more descriptive and comprehensive subjects for your document reminders.

POST /public/v1/documents/{document_id}/send-reminder

• ⚠️ the 'result/items/email_customization/subject' response property's maxLength was increased from '300' to '512' for the response status '200'
• the 'reminders/items/email_customization/subject' request property's maxLength was increased from '300' to '512'