OCocrolus
File Queries

Retrieve Mixed Document status

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.

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

Query parameters

pkinteger

Unique primary key <glossary:PK> of the Mixed Document whose status you want to retrieve. Mutually exclusive with doc_uuid / mixed_doc_uuid.

doc_uuidstring

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_uuidstring

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

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": 10891054,
    "uuid": "428110d2-ed77-44de-88bb-18003cfc10e6",
    "name": "Bank_Statement_Example.pdf",
    "page_count": 4,
    "checksum": "04d43e916a001c96c7349e8ff850238c",
    "document_status": "COMPLETED",
    "book_pk": 28741420,
    "book_uuid": "ffb922fb88f14702a4d36a4d64a18013",
    "docs": [
      {
        "pk": 50867394,
        "name": "Bank_Statement_Example.pdf(0,1,2,3)",
        "uuid": "30021344-a56d-4037-a6f3-d453444edae2",
        "pages": 4,
        "md5": "04d43e916a001c96c7349e8ff850238c",
        "status": "VERIFICATION_COMPLETE",
        "rejection_reason": "INVALID DOCUMENT"
      }
    ],
    "pages": [
      {
        "doc_type": "BANK_STATEMENT"
      }
    ]
  },
  "message": "OK"
}

Changes

No recorded changes to this operation across all 1 revision of this API.