Skip to main content
GET
/
document
/
get
Get Document
curl --request GET \
  --url https://api.stax.ai/document/get \
  --cookie authToken=
{
  "success": true,
  "doc": {
    "_id": "<string>",
    "team": "<string>",
    "stack": "<string>",
    "name": "<string>",
    "originalName": "<string>",
    "format": "<string>",
    "download": "<string>",
    "thumbnail": "<string>",
    "source": "<string>",
    "sourceUrl": "<string>",
    "provider": {},
    "importKey": "<string>",
    "pages": [
      "<string>"
    ],
    "rotations": {},
    "aspects": {},
    "job": {
      "upload": "<string>",
      "working": true,
      "worker": "<string>",
      "status": "<string>",
      "success": true,
      "error": "<string>",
      "read": {
        "operationUrls": [
          "<string>"
        ],
        "fetchTime": "2023-11-07T05:31:56Z"
      },
      "rc": {
        "preproc": "<string>",
        "sort": "<string>",
        "postproc": "<string>"
      }
    },
    "urgent": true,
    "deadline": "2023-11-07T05:31:56Z",
    "flagged": true,
    "pinned": true,
    "flags": [
      {
        "timestamp": "2023-11-07T05:31:56Z",
        "title": "<string>",
        "description": "<string>",
        "level": "info",
        "pages": [
          123
        ]
      }
    ],
    "reviewed": true,
    "archived": true,
    "assignee": "<string>",
    "sharing": {
      "public": true,
      "protected": {
        "emails": [
          "<string>"
        ],
        "teams": [
          "<string>"
        ],
        "password": "<string>"
      },
      "access": [
        {
          "email": "<string>",
          "usage": 123
        }
      ]
    },
    "checksum": "<string>",
    "metadata": [
      {
        "key": "<string>",
        "value": "<string>",
        "expression": "<string>",
        "class": "<string>",
        "tags": [
          123
        ],
        "pages": [
          123
        ],
        "ref": "<string>",
        "confidence": 123
      }
    ],
    "fillable": {
      "enabled": true,
      "fields": [
        {
          "key": "<string>",
          "required": true,
          "hint": "<string>",
          "dataType": "textbox",
          "fontSize": 123,
          "page": 123,
          "x": 123,
          "y": 123,
          "width": 123,
          "height": 123
        }
      ],
      "recipients": [
        {
          "document": "<string>",
          "email": "<string>",
          "name": "<string>",
          "sentOn": "2023-11-07T05:31:56Z",
          "viewedOn": "2023-11-07T05:31:56Z",
          "filledOn": "2023-11-07T05:31:56Z"
        }
      ]
    },
    "keywords": [
      "<string>"
    ],
    "bounds": [
      {
        "label": "<string>",
        "data": {},
        "page": 123,
        "x": 123,
        "y": 123,
        "width": 123,
        "height": 123
      }
    ],
    "tables": [
      {
        "raw": true,
        "title": "<string>",
        "lastModified": "2023-11-07T05:31:56Z",
        "createdON": "2023-11-07T05:31:56Z",
        "page": 123,
        "x": 123,
        "y": 123,
        "width": 123,
        "height": 123,
        "headers": [
          "<string>"
        ],
        "tags": [
          {
            "row": 123,
            "col": 123,
            "key": "<string>"
          }
        ],
        "rows": [
          {
            "x": 123,
            "y": 123,
            "width": 123,
            "height": 123,
            "page": 123,
            "cells": [
              {
                "x": 123,
                "y": 123,
                "width": 123,
                "height": 123,
                "text": "<string>",
                "confidence": 123
              }
            ],
            "class": "<string>",
            "classConfidence": 123
          }
        ]
      }
    ],
    "split": [
      {
        "pages": [
          123
        ],
        "toNext": true,
        "name": "<string>"
      }
    ],
    "notes": [
      {
        "page": 123,
        "thread": [
          {
            "text": "<string>",
            "user": "<string>",
            "timestamp": "2023-11-07T05:31:56Z"
          }
        ],
        "tags": [
          "<string>"
        ],
        "x": 123,
        "y": 123
      }
    ],
    "canvas": {},
    "bulk": true,
    "original": "<string>",
    "splitFrom": "<string>",
    "attachments": [
      {
        "filename": "<string>",
        "document": "<string>",
        "filepath": "<string>"
      }
    ],
    "time": [
      {
        "event": "<string>",
        "stamp": "2023-11-07T05:31:56Z",
        "user": "<string>"
      }
    ],
    "viewed": {},
    "sync": [
      {
        "user": "<string>",
        "key": "<string>",
        "path": "<string>",
        "override": true,
        "error": "<string>",
        "step": "<string>",
        "job": "<string>",
        "isSynced": true,
        "queuedOn": "2023-11-07T05:31:56Z",
        "syncedOn": "2023-11-07T05:31:56Z"
      }
    ],
    "receivedOn": "2023-11-07T05:31:56Z",
    "lastModified": "2023-11-07T05:31:56Z",
    "nextStack": "<string>",
    "sender": "<string>"
  },
  "statement": {
    "_id": "<string>",
    "team": "<string>",
    "plan": "<string>",
    "account": "<string>",
    "planId": "<string>",
    "accountNumber": "<string>",
    "document": "<string>",
    "pageCount": 123,
    "duplicates": [
      "<string>"
    ],
    "creator": "<string>",
    "planYear": 123,
    "periodStart": "2023-11-07T05:31:56Z",
    "periodEnd": "2023-11-07T05:31:56Z",
    "months": [
      "<string>"
    ],
    "beginningBalance": 123,
    "endingBalance": 123,
    "reconciles": true,
    "tx": {
      "deposits": 123,
      "withdrawals": 123,
      "income": 123,
      "fees": 123,
      "transfers": 123,
      "purchases": 123,
      "sales": 123,
      "reinvestments": 123,
      "other": 123,
      "accrued": 123,
      "gain_loss": 123,
      "rollovers": 123,
      "forfeiture": 123,
      "loanPayments": 123,
      "newLoans": 123,
      "loanInterest": 123
    },
    "diff": {
      "deposits": 123,
      "withdrawals": 123,
      "income": 123,
      "fees": 123,
      "loanPayments": 123,
      "transfers": 123,
      "rollovers": 123,
      "reinvestments": 123,
      "other": 123,
      "gain_loss": 123,
      "accrued": 123,
      "purchases": 123,
      "sales": 123
    },
    "errors": [
      "<string>"
    ],
    "confidence": {},
    "ref": {},
    "participant": "<string>",
    "moneyType": "<string>",
    "confirmed": true,
    "clientConfirmed": true,
    "accepted": {},
    "history": [
      {
        "user": "<string>",
        "timestamp": "2023-11-07T05:31:56Z",
        "changes": [
          {
            "field": "<string>",
            "from": "<string>",
            "to": "<string>"
          }
        ]
      }
    ],
    "createdOn": "2023-11-07T05:31:56Z",
    "lastModified": "2023-11-07T05:31:56Z",
    "classifying": true
  },
  "pages": [
    "<string>"
  ],
  "downloadUrl": "<string>",
  "wordsUrl": "<string>",
  "words": [
    {}
  ]
}

Authorizations

authToken
string
cookie
required

Cookie-based authentication using userId and authToken cookies

Query Parameters

docId
string

Document ID MongoDB ObjectId

minimal
boolean

Return minimal document data

presigned
boolean

Return presigned URLs for pages and download

fields
string

Comma-separated list of fields to return

disableReview
boolean
statement
boolean

Include TPA statement information

Response

Document information

success
boolean
doc
object
statement
object
pages
string[]

Presigned URLs for pages (if presigned=true)

downloadUrl
string<uri>

Presigned download URL (if presigned=true)

wordsUrl
string<uri>

Presigned words index URL (if presigned=true)

words
object[]

Word index data