---
title: "Retrieve Mixed Document status"
method: GET
path: "/v1/document/mixed/status"
tags: ["File Queries"]
---

# Retrieve Mixed Document status

`GET /v1/document/mixed/status`

## Request

- Base URL: `https://api.ocrolus.com`
- URL: `https://api.ocrolus.com/v1/document/mixed/status`
- Auth: OAuth 2
  - Client credentials
  - Token URL: `https://auth.ocrolus.com/oauth/token`

Retrieve the status of a Mixed Document using it's <<glossary:PK>> or UUID.

---

To learn more about the different processing statuses of an uploaded <<glossary:Document>>, [view our guide](https://docs.ocrolus.com/docs/document-status).

## Query parameters

- `pk` integer
- `doc_uuid` string: UUID of the Mixed Document whose status you want to retrieve. Equivalent to `mixed_doc_uuid` — either may be used. If both are provided, `mixed_doc_uuid` takes precedence. Mutually exclusive with `pk`.
- `mixed_doc_uuid` string: UUID of the Mixed Document whose status you want to retrieve. Equivalent to `doc_uuid` — either may be used. If both are provided, this parameter takes precedence. Mutually exclusive with `pk`.

## Response `200`

Success

- object
  - `status` integer: A numerical code that indicates the status of the request.
  - `response` object: An object received from the server that potentially contains data.
    - `pk` integer: Primary key of the Mixed Document.
    - `uuid` string: UUID of the Mixed Document.
    - `name` string: Name of the Mixed Document.
    - `page_count` integer: Total number of pages in the Mixed Document.
    - `checksum` string: MD5 checksum of the Mixed Document.
    - `document_status` 'CLASSIFIED' | 'VERIFYING' | 'COMPLETED' | 'REJECTED' | 'PROCESSING': Current processing status of the Mixed Document. The `docs` and `pages` array of objects are included in the response only when `document_status` is `COMPLETED`. Possible values: - `CLASSIFIED`: The Mixed Document has been classified but not yet verified. - `VERIFYING`: The Mixed Document is currently being verified. - `COMPLETED`:Processing is complete. `docs` and `pages` are included in the response only when `document_status` is `COMPLETED`. - `REJECTED`: The Mixed Document was rejected and could not be processed. - `PROCESSING`: The Mixed Document is being processed. Any other underlying processing state is also reported as `PROCESSING`.
    - `book_pk` integer: Primary key of the <<glossary:Book>> this Mixed Document belongs to.
    - `book_uuid` string: UUID of the <<glossary:Book>> this Mixed Document belongs to.
    - `docs` object[]: An array of Documents extracted from this Mixed Document. Present only when `document_status` is `COMPLETED`.
      - `pk` integer: Primary key of the Document.
      - `name` string: Name of the Document.
      - `uuid` string: UUID of the Document.
      - `pages` integer: Number of pages in the Document.
      - `md5` string: MD5 checksum of the Document.
      - `status` string: Processing status of the Document.
      - `rejection_reason` string: The reason the Document was rejected. Present only when `status` is `REJECTED`. This field is omitted entirely from the object when the Document has not been rejected. It is never returned as `null`; its absence indicates the Document was not rejected.
    - `pages` object[]: An array of page-level classification results. Present only when `document_status` is `COMPLETED`.
      - `page_idx` integer: Zero-based index of the page within the Mixed Document.
      - `doc_type` string: Classified document type for this page.
  - `message` string: A textual description that indicates details about this response's status.

## Other responses

- `400`: Client Errors
- `500`: Internal server error

---

[API](https://skmtc.dev/ocrolus/apis/file-queries.md) - [All operations](https://skmtc.dev/ocrolus/apis/file-queries/llms.txt) - [OpenAPI document](https://skmtc.dev/ocrolus/apis/file-queries/revisions/059a7de3f2d9?raw)