The designed e-signature API surface for M20 — 28 operations organized into 5 functional areas. The document side (contracts, fields), the delivery side (recipients and sign order), the signer side (the tokenized e-sign session), and the evidence behind every executed e-signature. The module’s database schema ships today; its stored-procedure layer is being built against exactly this surface. Skim any area below.
Everything is POST + JSON body — no verb quirks. The builder side works on contracts, fields, and recipients; the signer side runs on tokenized links with no account required; evidence endpoints hand back what a lawyer would ask for. Every operation shares the request/response envelope used everywhere else in the CleenUI API.
The document itself — a PDF in blob storage plus a status that derives from its recipients: Draft, Sent, Partially Signed, Fully Executed, with Voided and Expired kept distinct. Templates are contracts with a flag; clone records lineage, so any executed contract traces back to the template it came from.
/contract/contract/saveSave a contract: name, description, source PDF./contract/contract/detailGet one contract with its fields, recipients, and status./contract/contract/filterGet a page of contracts — the working list, or templates only./contract/contract/cloneCopy a contract; the clone records its lineage back to the source./contract/contract/sendCreate tokenized signing links and send the contract to its recipients./contract/contract/voidVoid a sent contract./contract/contract/inactivateRetire a contract from the working list without deleting it./contract/contract/reactivateBring an inactivated contract back to the working list./contract/contract/downloadDownload the PDF — the executed document once fully signed./contract/contract/deleteDelete a contract. Executed signatures are never deleted.The drag-and-drop builder’s unit: one placed box with a type (one of twelve), a page, geometry, and the recipient who must fill it. Required and read-only flags, tab order, format masks, and default values for pre-filling from consumer data. Values store typed — string, date, boolean, decimal — one row per field per recipient.
/contract/field/savePlace, size, or reassign a field: type, page, position, recipient./contract/field/detailGet one field with its geometry and settings./contract/field/filterGet every field on one contract./contract/field/deleteDelete a field./contract/field/value/saveSave what a recipient entered in a field — typed, not stringly./contract/field/value/filterGet the entered values of one contract.Who signs, and in what order. A recipient is a platform party or just a name and an email — outside counsel signs without an account. Sign order is the whole parallel-vs-sequential mechanism: empty means everyone at once, numbered means recipients unlock in sequence, shared numbers sign together.
/contract/recipient/saveAdd or update a signer: party or name + email, and their sign order./contract/recipient/detailGet one recipient with their sent / viewed / signed state./contract/recipient/filterGet the recipients of one contract, in sign order./contract/recipient/deleteRemove a recipient from an unsent contract./contract/recipient/resendRe-deliver a signing link; the resend count is recorded.The signer’s side, opened from a tokenized link — no login, no account. The session walks the recipient through their assigned fields only; required fields gate the finish. The final completion flips the contract Fully Executed and notifies consumers — an M19 engagement goes Active the same moment.
/contract/sign/detailOpen a signing session from a tokenized link — the recipient’s fields only./contract/sign/field-value/saveSave one field at a time as the signer works through the document./contract/sign/signature/saveAdopt and apply an e-signature — drawn, typed, or uploaded./contract/sign/declineDecline to sign, with a reason./contract/sign/completeFinish signing; the last recipient flips the contract Fully Executed.The e-signing act is evidence, not form data. Every e-signature records how the mark was made, the IP address and user agent it came from, which version of the consent text the signer accepted, and a SHA-256 hash of the exact bytes signed. The audit trail covers everything else that happened to the contract.
/contract/signature/filterGet the signature evidence of a contract: type, IP, user agent, consent version, document hash./contract/history/filterGet the full audit trail of a contract.Book a 30-minute review and we’ll trace any operation end to end — from React component to stored procedure — using your team’s actual use case.