Signatures (app routes)

Check signing progress without a webhook

Poll with an API key holding firme:read, or a signed-in session. Returns the envelope status and each recipient’s status, signing time, decline reason and processing state. completed means every signer has signed; declined, voided and expired are the other terminal states. Stop polling when terminal, unless waiting for hasCertificate. A signed artifact can exist while other signatures are pending. For the entire record use GET /firme/{id}; download via /firme/{id}/download?which=signed.

get/api/v1/firme/{id}/status

Request

  • Base URL: https://api.custodo.ai
  • URL: https://api.custodo.ai/api/v1/firme/{id}/status
  • 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.

Response

Current signing progress.

oktrue required

Changes

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