Signatures (app routes)

Void an envelope

A draft or an envelope out for signature: nobody can sign it any more. { "reason": "…" } is recorded in the evidence trail. Needs a key minted with destructive actions allowed. Emits firme.envelope.voided.

post/api/v1/firme/{id}/void

Request

  • Base URL: https://api.custodo.ai
  • URL: https://api.custodo.ai/api/v1/firme/{id}/void
  • Auth: HTTP bearer

Path parameters

idstring uuid required

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

reasonstring

Response

Voided.

oktrue required

Changes

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