Sign in

v1

latestOpenAPI 3.0.02026-07-2482421001.1 KB
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

Query parameters

pkstring

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

doc_uuidstring

Unique identifier of the <glossary:Document> whose status you want to retrieve. Mutually exclusive with pk.

mixed_doc_uuidstring

Unique identifier of the Mixed <glossary:Document> whose status you want to retrieve.

Response

Success

OR

Example response

{
  "status": 200,
  "response": {
    "pk": 19111111,
    "uuid": "8701g05d-12g6-gdh3-91qx-3dhuv3x10004",
    "name": "679d4571-a611-46a5-bcf1-31d887bf27e6/4ec2e06a-3ca9-4700-94bb-782e14f2db5a/fd874fe0-56c3-4d5b-9d47-5846820f775e/4000006015/4ec2e06a-3ca9-4700-94bb-782e14f2db5a/2b572e6e-ca5a-43ec-8f9e-2e0d8995e8f1",
    "page_count": 5,
    "checksum": "b487b957febad33fff22211111110c000",
    "document_status": "COMPLETED",
    "book_pk": 27777777,
    "book_uuid": 27777777,
    "docs": [
      {
        "pk": 48888881,
        "name": "666a444a-o666-66k5-ka12-66d667ja66e6/aec2e19a-7dq9-3922-00aa-999jj5h1eckq/kl9011440-12c3-1d1b-8x71-903713jk110s/5551113678/6dc3dp6k-1xa2-8123-19cv-903j20dgqw1k/3c692r1e-xk0a-78hj-0f8j-1kpf1111h6h2(0,1)",
        "uuid": "23a1ca82-6b29-45ea-8295-cb3d048fe108",
        "pages": 2,
        "md5": "cd14444dee00aa006a0d555555b99ae0",
        "status": "VERIFICATION_COMPLETE\""
      }
    ]
  },
  "message": "OK"
}