ATatlaswork
envelopes

Check signing status

Changed on

Returns lightweight participant progress and a human-readable lifecycle summary. Deferred-upload drafts also report whether document bytes have arrived.

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

Request

  • Base URL
    https://api.atlaswork.ai
  • URL
    https://api.atlaswork.ai/api/v1/envelopes/{id}/status
  • Auth
    • HTTP bearer
    • or HTTP bearer

Path parameters

idstring required

Envelope id

Response

Current signing progress

envelopeIdstring required
status'draft' | 'detecting' | 'review' | 'in_progress' | 'completed' | 'declined' | 'voided' | 'expired' required
detectionStatus'none' | 'running' | 'succeeded' | 'failed' | 'skipped' required
terminalboolean required
currentParticipantIdstring nullable required
signedCountinteger required
totalParticipantsinteger required
lastEventAtstring date-time nullable required
summarystring required
documentReceivedboolean

Changes

  • d3b4f91b9bb2Revision changes
    • warning

      added the new skipped enum value to the response property for the response status