Changelog

Changes to the API that an integration may notice, newest first.

2026-11-03: Signing process responses carry exactly the documented fields

Every endpoint that returns a signing process now returns exactly the SigningProcess schema from the reference: GET /signing-processes, GET /signing-processes/{id}, POST /signing-processes, POST /templates/{id}/start-signing, POST /templates/{id}/kiosk-session (in signingProcess), and the void, extend, contact correction, identity proof, approve and reject routes. Online form responses likewise return exactly the OnlineForm schema.

Now documented. These were already returned, so integrations that read them keep working:

  • metadata: the key/value pairs given at creation, unchanged.
  • fieldDefinitions: every field with its id, assignedSignerSlotId, type, label, page, position and size in PDF points (x, y, w, h, origin top-left) and required.
  • organizationId, and createdBy with the name and email of the member who started the process (null when an API key started it).
  • signerSlots[].locale.

No longer returned. These were never part of the reference and carried internal or sensitive data:

  • the embedded rows sourcePdfAsset, workingPdfAsset, finalPdfAsset and organization;
  • evidenceJson, formContentJson, lastAuditHash;
  • on signer slots: identitySnapshotJson, formSubmissionJson, formSubmissionSha256, createdAt, updatedAt;
  • on field definitions: signingProcessId, defaultValueJson, renderStyleJson, createdAt, updatedAt.

Where that information lives instead:

  • The asset ids stay on the process (sourcePdfAssetId, workingPdfAssetId, finalPdfAssetId, completionCertificatePdfAssetId).
  • The signed document and the completion certificate, which records the evidence, are available through GET /signing-processes/{id}/files once the process is completed.
  • The answers of an online form are on GET /online-forms/{id}, per signer slot.