Signatures

Prepare an envelope for signature

Creates a DRAFT envelope with its recipients. Nothing is sent until firme_send_envelope. The PDF is an Archivio document: pass its document_id (find it with documents_search) and its current version is signed, and the signed copy becomes its next version. A brand-new file goes into the Archivio first with documents_upload. source_sha256 names a PDF staged through the REST upload instead; with document_id too it must be that document’s current version. Only a PDF can be signed. Every envelope is a firma elettronica closed with a qualified electronic seal; there is no level to choose.

post/api/v1/rest/firme/envelopes

Request

  • Base URL: https://api.custodo.ai
  • URL: https://api.custodo.ai/api/v1/rest/firme/envelopes
  • Auth: HTTP bearer

Headers

X-Tenant-Idstring uuid

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.

Request body

titlestring required
document_idstring uuid

The Archivio document to sign: its current version is the PDF, and the signed copy becomes its next version.

source_sha256string

A PDF staged through POST /api/v1/firme/source, instead of a document.

source_filenamestring

Required with source_sha256; defaults to the document’s file name.

messagestring

Shown to the recipients.

routing'sequential' | 'parallel'

sequential invites signers one at a time, in order; parallel all at once.

archive_on_completeboolean

true files the signed PDF in the Archivio once everybody has signed; false keeps it in Firme only.

default_signature_fieldboolean

Put a signature box at the foot of the last page for every signer. Without it the first signature is a strip along the left edge of page 1 and later ones are invisible (they are in the file all the same).

mail_account_idstring uuid

The organisation mailbox the invitations, reminders and signed copy leave from (an id from email_list_accounts). Omit for the module default.

whatsapp_account_idstring uuid

The WhatsApp number the links, codes and copy are written from (an id from whatsapp_list_accounts). Omit to let the organisation pick.

Response

Done. data is the tool’s own answer.

oktrue required
dataunknown required

Changes

No recorded changes to this operation across all 1 revision of this API.