API reference
Sign
Sign it. Keep the proof. Open the product
GET/v1/signOpen ↗
Signing for any document.
POST/v1/sign/requestsKey
Ask for a signature. Answers with the link to send the signer: the request travels sealed inside it, so nothing is stored.
| Body | |
|---|---|
document | { "html": "…" } — travels in the link; or { "sha256": "…", "url": "https://…" } for a document you host, such as a PDF |
title | what the signer sees it called |
signer | { "name": "the full name they must type", "email" | "mobile": "one you hold, for them to confirm" } — hashed on arrival |
consent | { "text", "version" } — the words they agree to; neutral words if left out |
expiresInDays | 1 to 30; 7 if left out |
returnUrl | https:// — where the signer goes afterwards, with ?sign=<evidence token>: a page here says it is signed and links there, naming its host. |
requireDrawn | true — the signer must draw their signature as well as type their name; if left out, your configuration’s signing.requireDrawn, or drawing is the signer’s choice |
POST/v1/sign/evidenceKey
Open the evidence token a signer brought back to your return address: the evidence, its seal, the check, and a certificate of signing to keep. Only the lender that asked can open it.
| Body | |
|---|---|
token | the sign= value |
POST/v1/sign/certificateKey
The certificate of signing as a PDF, to keep with the document: the drawn signature as drawn, the typed name, the fingerprints and the seal. Made only for evidence whose seal checks; answers application/pdf.
| Body | |
|---|---|
evidence | as returned |
seal | as returned |
POST/v1/sign/verifyKey
Check evidence and its seal, and the document if you send it: valid, or exactly why not, each reason with a code.
| Body | |
|---|---|
evidence | as returned |
seal | as returned |
document | { "html" } or { "sha256" } — optional |