---
title: "Book status"
method: GET
path: "/v1/book/status"
tags: ["Book Queries"]
---

# Book status

`GET /v1/book/status`

## Request

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

This API retrieves the status of a <<glossary:Book>>.
--- Use this endpoint to retrieve details about a Book, including its current processing status and the status of each Document within it. Book status reflects the overall state of the Book across its processing life cycle,  while Document status reflects the individual processing stage of each Document uploaded to the Book. For more information, see [Book Statuses](doc:book-status-code) and [Document Statuses](doc:document-status).

## Query parameters

- `book_uuid` string, uuid
- `pk` string

## 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 <<glossary:Book>>.
    - `id` integer: ID of the <<glossary:Book>> (same as `pk`).
    - `uuid` string: UUID of the <<glossary:Book>>.
    - `name` string: Name of the <<glossary:Book>>.
    - `owner_email` string: Email of the <<glossary:Book>> owner.
    - `is_public` boolean: Whether the <<glossary:Book>> is public.
    - `is_shared_or_public_book` boolean: Whether the <<glossary:Book>> is shared or public.
    - `created` string: ISO timestamp when the <<glossary:Book>> was created.
    - `created_ts` string: ISO timestamp when the <<glossary:Book>> was created.
    - `book_class` 'COMPLETE' | 'INSTANT' | 'INSTANT_CLASSIFY_ONLY' | 'INSTANT_CLASSIFY_ISO_CAPTURE': The processing type of the Book.
    - `book_status` 'CREATED' | 'UPLOAD' | 'VERIFYING' | 'VERIFIED': Status of the <<glossary:Book>>.
    - `docs` object[]: An array of all the <<glossary:Document>>s uploaded to the <<glossary:Book>>.
      - `pk` integer: Primary key of the <<glossary:Document>>.
      - `id` integer: ID of the <<glossary:Document>> (same as `pk`).
      - `uuid` string: UUID of the <<glossary:Document>>.
      - `name` string: Name of the <<glossary:Document>>.
      - `pages` integer: Number of pages in the <<glossary:Document>>.
      - `md5` string: MD5 checksum of the <<glossary:Document>>.
      - `status` string: Processing status of the <<glossary:Document>>.
      - `document_class` 'COMPLETE' | 'INSTANT': Document class indicating the processing type of the document.
      - `image_group_pk` integer, nullable: Primary key of the image group associated with the <<glossary:Document>>.
      - `mixed_uploaded_doc_pk` integer, nullable: Primary key of the Mixed Document this <<glossary:Document>> was extracted from.
      - `rejection_reason` string: Rejection reason if the <<glossary:Document>> was rejected. Present only when `status` is `REJECTED`. This field is omitted entirely from the object when the document has not been rejected.
      - `rejection_reason_description` string: Detailed description of the rejection reason. Present only when `status` is `REJECTED`. Omitted entirely from the object when the document has not been rejected.
    - `mixed_docs` object[]: An array of all the Mixed Documents uploaded to the <<glossary:Book>>. A Mixed Document is a single or multipage PDF that contains more than one doc type. This array is optional and is only returned when the <<glossary:Book>> has Mixed Documents uploaded to it.
      - `pk` integer: Primary key of the Mixed Document.
      - `id` integer: ID of the Mixed Document (same as `pk`).
      - `uuid` string: UUID of the Mixed Document.
      - `name` string: Name of the Mixed Document.
      - `md5` string: MD5 checksum of the Mixed Document.
      - `pages` integer: Number of pages in the Mixed Document.
      - `status` string: Processing status of the Mixed Document. Same enum as the DOC object.
      - `image_group_pk` integer, nullable: Primary key of the image group associated with the Mixed Document.
      - `document_class` 'COMPLETE' | 'INSTANT': Document class indicating the processing type of the document.
      - `rejection_reason` string, nullable: Rejection reason if the Mixed Document was rejected. Unlike `docs[]`, this field is always present — it returns `null` when the document has not been rejected.
  - `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/book-queries.md) - [All operations](https://skmtc.dev/ocrolus/apis/book-queries/llms.txt) - [OpenAPI document](https://skmtc.dev/ocrolus/apis/book-queries/revisions/cbe5b52f5b26?raw)