eDocInk

Changelog

What changed for apps that integrate with eDocInk, newest first. Each entry gives the API version (info.version in /openapi.json), the SDK version that supports it, and what you need to do. Your app can also read these as notices: see "Staying current" in INTEGRATION_REQUIREMENTS.

Kinds: added (optional), needs upgrade (upgrade before using it), breaking (you must act by the deadline), deprecated, security.

API 1.7.0 · SDK 0.33.0-alpha.2

  • Added: Deprecation and Sunset headers. While an operation you call, or the SDK version your app reports, is being retired, every successful response carries Deprecation (RFC 9745), Sunset (RFC 8594) and a Link to the changelog, until the retirement date. The matching notice says what to do. Nothing is being retired today. No action needed; alert on Sunset if your HTTP stack can. SDK 0.33.0-alpha.2 carries the new contract; no code change, upgrade when convenient.

API 1.6.0 · SDK 0.33.0-alpha.1

  • Added: PDF documents in guest envelopes (SDK only). The SDK's envelope journal, receipts and evidence verification accept a PDF document ({title, sha256}, from an upload or a conversion). verifyGuestEnvelopeEvidence verifies every member and can re-check the PDF bytes. No server change. Optional.

API 1.6.0 · SDK 0.32.0-alpha.1

  • Added: notices and compatibility. GET /api/v1/notices, POST /api/v1/notices/{id}/acknowledge and GET /api/v1/compatibility; every successful response carries an eDocInk-Notices header while your app has unacknowledged notices. Any key may call them. SDK 0.32 reports its version as User-Agent: edocink-sdk/<version>, logs each new notice once, and adds notices(), acknowledgeNotice() and checkCompatibility(). Optional; nothing else changes.

2026-11-20 · API 1.5.0 · SDK 0.31.0-alpha.1 (engine fix)

  • Fixed: text bodies of 10,000 characters or fewer are prepared on the original 10,000-limit definition again, so SDKs 0.28 to 0.30 verify their evidence. Between 07:34 and 08:25 EST on 2026-11-20 every text request was prepared on the long definition; evidence for requests prepared in that window needs SDK 0.31.

2026-11-20 · API 1.5.0 · SDK 0.31.0-alpha.1

  • Needs upgrade: text documents up to 200,000 bytes. The body limit rises from 10,000 characters to 200,000 UTF-8 bytes. Evidence for a body over 10,000 characters verifies only on SDK 0.31.0-alpha.1 or later; upgrade before sending longer text. No database change.

2026-11-19 · API 1.4.0 · SDK 0.30.0-alpha.1

  • Added: document conversion. Word, OpenDocument, RTF, HTML, text and image files (up to 10 MiB) convert to PDF through /api/v1/document-conversions. Needs the documents:submit scope. Optional.

2026-11-19 · API 1.3.0 · SDK 0.29.0-alpha.1

  • Added: PDF documents. Upload a PDF (up to 10 MiB) and send it for signature; evidence binds the file by SHA-256 and length. Optional.

SDK upgrade details, including database steps, are in docs/UPGRADES.md in the SDK archive.

Something unclear or missing on this page? Suggest an improvement.