Read one envelope (status)
Polling snapshot: the same current record or collection as the corresponding read endpoint, including its state and progress. List filters, defaults and pagination also apply here. This is not an event history or a changes-since feed. Poll at a sensible interval (start with 30 seconds), respect Retry-After on 429 and stop when the required terminal state is reached.
One envelope with every recipient, their role, whether they have signed and when. detailed adds the evidence trail — the hash-chained record of every view, signature and decline, which is what makes the signature provable — and evidence_check, the chain verified link by link on the server. For the PDF itself, or the «Attestazione di firma», use firme_download_link.
Examples
- Who has not signed the Rossi contract yet? GET /api/v1/rest/firme/envelopes/11111111-2222-4333-8444-555555555555/status
Request
- Base URL: https://api.custodo.ai
- URL: https://api.custodo.ai/api/v1/rest/firme/envelopes/{id}/status
- Auth: HTTP bearer
Path parameters
Query parameters
concise (default) returns the fields you need to answer a question; detailed adds related records and costs more context.
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.
Response
Done. data is the tool’s own answer.
Changes
No recorded changes to this operation across all 1 revision of this API.