Skip to main content
GET
Check signing status

Authorizations

Authorization
string
header
required

Organization API key (format atlas_sk_...), passed as a bearer token or the x-api-key header. Created and revoked in the dashboard (Better Auth api-key plugin); shown in full only once and stored hashed.

Path Parameters

id
string
required

Envelope id

Minimum string length: 1

Response

Current signing progress

envelopeId
string
required
status
enum<string>
required
Available options:
draft,
detecting,
review,
in_progress,
completed,
declined,
voided,
expired
detectionStatus
enum<string>
required
Available options:
none,
running,
succeeded,
failed
terminal
boolean
required
currentParticipantId
string | null
required
participants
object[]
required
signedCount
integer
required
Required range: x >= 0
totalParticipants
integer
required
Required range: x >= 0
lastEventAt
string<date-time> | null
required
summary
string
required
documentReceived
boolean