Create an envelope — and send it, with `send: true`
The PDF is sourceSha256 + sourceFilename (from POST /source), or an Archivio document: documentId alone signs its current version, and its signed copy becomes the document’s next version once everybody has signed. With both, the staged PDF must be that document’s current version (FIRME_SOURCE_NOT_DOCUMENT). Signers sign in order (routing: "sequential") or all at once; an address that is a member’s login is bound to that member, who signs in the app. inPerson signers draw their signature on a member’s phone. Without send the envelope is a draft nobody hears about. Signature boxes (signers[].fields, at most one per signer, type: "signature") are in PDF points (1/72 inch) of the page’s own user space: page from 1, x/y the box’s BOTTOM-LEFT corner, origin at the bottom-left of the page. A signer with no box signs invisibly, except the first signature on a document, which is drawn as a vertical strip along the left edge of page 1; defaultSignatureField: true puts a box at the foot of the last page instead.
Request
- Base URL: https://api.custodo.ai
- URL: https://api.custodo.ai/api/v1/firme
- Auth: HTTP bearer
Headers
The organisation to act in. An API key is bound to exactly one, so this is optional for a key and must match the one it was minted for.
A key of your own, scoped to your credential. Repeating the create with the same key and the same body answers the envelope the first attempt made — 200 instead of 201, with Idempotent-Replayed: true — and invites nobody again. The same key with a different body is a 409.
Request body
Response
An Idempotency-Key replay: the envelope the first attempt created.
Changes
No recorded changes to this operation across all 1 revision of this API.