OCocrolus
Book Queries

Book status

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 and Document Statuses.

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

Query parameters

book_uuidstring uuid

The unique identifier of the <glossary:Book> whose status you want to retrieve. Mutually exclusive with book_pk.

pkstring

Unique primary key (pk) of the <glossary:Book> whose status you want to retrieve. Mutually exclusive with book_uuid.

Response

Success

statusinteger

A numerical code that indicates the status of the request.

messagestring

A textual description that indicates details about this response's status.

Example response

{
  "status": 200,
  "response": {
    "pk": 34251191,
    "id": 34251191,
    "uuid": "9ef345ab-33fe-4f0d-ad63-27c47f6419b3",
    "name": "Example Book",
    "owner_email": "email@address.com",
    "is_public": true,
    "is_shared_or_public_book": true,
    "created": "2023-05-30T16:15:14Z",
    "created_ts": "2023-05-30T16:15:13Z",
    "book_class": "COMPLETE",
    "book_status": "VERIFIED",
    "docs": [
      {
        "pk": 55877634,
        "id": 55877634,
        "uuid": "de548ffc-5df5-4bb4-b14a-42eb27c34364",
        "name": "paystubexample.pdf(0)",
        "pages": 1,
        "md5": "88e004f15a4ca3dc057a0baf8dcd8774",
        "status": "VERIFICATION_COMPLETE",
        "document_class": "COMPLETE",
        "mixed_uploaded_doc_pk": 11565050,
        "rejection_reason": "INVALID DOCUMENT",
        "rejection_reason_description": "The document could not be processed."
      }
    ],
    "mixed_docs": [
      {
        "pk": 11565050,
        "id": 11565050,
        "uuid": "a27ffbf5-7137-4a71-b1a9-65e256838cfb",
        "name": "paystubexample.pdf",
        "md5": "88e004f15a4ca3dc057a0baf8dcd8774",
        "pages": 1,
        "status": "COMPLETED"
      }
    ]
  },
  "message": "OK"
}

Changes