---
title: "Get Document Status"
method: GET
path: "/api/v1/documents/{document_id}"
tags: ["v1", "documents"]
---

# Get Document Status

`GET /api/v1/documents/{document_id}`

## Request

- Base URL: `https://zsign.io` (the document declares no server; this is the origin it was published from)
- URL: `https://zsign.io/api/v1/documents/{document_id}`
- Auth: HTTP bearer

Envelope status: document, signing session, per-recipient progress,
and — once completed — the completed_document_id to pass to
GET /api/v1/documents/{completed_document_id}/download.

`?override_send_invite=true` evaluates each recipient's can_remind with
the manual-remind override applied, matching what the Remind Recipient
action would allow on an invite-suppressed envelope.

## Path parameters

- `document_id` string, required

## Query parameters

- `override_send_invite` boolean

## Response `200`

Successful Response

- AgentEnvelopeStatus: GET /api/v1/documents/{document_id} — sent envelope or unsent draft. Draft-only extras (`parsed_fields`, `recipients`, `sent`) stay unset on sent envelopes so `response_model_exclude_unset` keeps the historical wire shape. Drafts set them explicitly, including `session` / `completed_document_id` as null.
  - `document_id` string, uuid, required
  - `name` string, nullable
  - `filename` string, required
  - `status` string, required
  - `created_at` string, date-time, nullable
  - `session` AgentEnvelopeSession
    - `session_id` string, uuid, required
    - `status` string, required
    - `expires_at` string, date-time, nullable
    - `completed_at` string, date-time, nullable
    - `revision_of` string, uuid, nullable
    - `recipients` AgentEnvelopeRecipient[], required
      - `recipient_id` string, uuid, required
      - `name` string, required
      - `email` string, required
      - `status` string, required
      - `signed_at` string, date-time, nullable
      - `can_remind` boolean, required
      - `change_request` AgentEnvelopeChangeRequest
        - `reason` string, nullable
        - `comments` AgentEnvelopeChangeRequestComment[], required
          - `page` integer, required
          - `field_id` string, nullable
          - `field_label` string, nullable
          - `x` number, nullable
          - `y` number, nullable
          - `width` number, nullable
          - `height` number, nullable
          - `anchor_text` string, nullable
          - `text` string, required
          - `created_at` string, date-time, required
        - `at` string, date-time, nullable
  - `completed_document_id` string, uuid, nullable
  - `metadata` object, nullable
  - `documents` EnvelopeDocumentOut[]
    - `id` string, required
    - `name` string, required
    - `filename` string, required
    - `page_start` integer, required
    - `page_count` integer, required
    - `position` integer, required
  - `parsed_fields` object[], nullable
  - `recipients` object[], nullable
  - `sent` boolean, nullable

## Other responses

- `422`: Validation Error

---

[API](https://skmtc.dev/zsign/apis/zsign-api.md) · [All operations](https://skmtc.dev/zsign/apis/zsign-api/llms.txt) · [OpenAPI document](https://skmtc.dev/zsign/apis/zsign-api/revisions/a674ac4137ba?raw)