---
title: "Async Analytics Result (Deprecated)"
method: GET
path: "/v1/book/analytics/async/result"
tags: ["Legacy Cash Flow Analytics (Deprecated)"]
deprecated: true
---

# Async Analytics Result (Deprecated)

`GET /v1/book/analytics/async/result`

## Request

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

> **Deprecated.**

Checks the status of an asynchronous analytics request, retrieving the results if they're ready.

---
> 🚧 We have a better version!
> This product was deprecated in December 2023 and has been superseded by our [new Analytics 2.0 offering](ref:book-summary), which we recommend for all new work.

> 📘 Multiple endpoints, one object
> This endpoint and [the synchronous version](ref:analytics) return analytics objects in the same format. The [XLSX endpoint](ref:analytics-excel) logically returns most of the same information, but does not use the same schema since JSON schemas don't apply to Excel files. You can find a detailed reference of the returned analytics object [here](doc:analytics-type).

## Query parameters

- `analytics_request_id` string, uuid, required

## Response `200`

Success

- object
  - `status` integer: Numerical code indicating the status of this request. Will be 200 for a successful response.
  - `message` string: A textual description that indicates details about this response's status. Will be "OK" for a successful request.
  - `response` object: Details about the asynchronous analytics request and its state. The key will be the value given in the `analytics_request_id` parameter.
    - `request_id` object: A unique identifier for this analytics request. Provide it to the [Result](ref:async-analytics-result) endpoint to retrieve the results.
      - `analytics_status` 'COMPLETED' | 'PROCESSING' | 'EXPIRED': The current state of the asynchronous analytics request. The possible values are defined as follows: - **`COMPLETED`:** The request has completed and the resulting analytics object is enclosed. - **`PROCESSING`:** The request is still being processed. Check back later. - **`EXPIRED`:** The request has been processed, and the window of time to retrieve the results has passed. If you still need the data returned by this request, submit a new one.
      - `analytics` BookAnalytics, nullable: Detailed analytics computed on the requested <<glossary:Book>>. All monetary amounts are given in USD.
        - `alt_lender_payments_by_month` unknown, required
        - `average_by_month` unknown, required
        - `average_daily_balance` string, required: The average daily ending balance (including weekends).
        - `average_daily_balance_by_month` unknown, required
        - `average_daily_balance_weekday` string, required: The average daily ending balance of weekdays.
        - `average_daily_balance_weekday_by_month` unknown, required
        - `average_deposit_by_month` unknown, required
        - `bank_accounts` BankAccountAnalytics[], required: List of Bank Account Level JSONs
          - `account_category` 'BUSINESS ACCOUNT' | 'PERSONAL ACCOUNT' | 'UNKNOWN', required: Indicates different categories of bank accounts captured from documents.
          - `account_holder` string, required: The name of the person or entity who owns this bank account.
          - `account_holders` string[]: This field will be a single-element array with the value given in `account_holder`.
          - `account_number` string, required: The captured number of this bank account.
          - `account_type` 'SAVINGS' | 'CHECKING' | 'CHECK CASHING HISTORY' | 'CREDITCARD' | 'IOLTA' | 'UNKNOWN', required: Bank account type indicates the different types of bank accounts captured from documents.
          - `activity_info` ActivityInfo, required: A series of date ranges indicating periods of activity and inactivity in a bank account.
            - `active` DatePartRange[], required: Series of date ranges during which this bank account shows activity.
              - …
            - `missing` DatePartRange[], required: Series of date ranges during which this bank account _does not_ show activity.
              - …
          - `alt_lender_payments_by_month` unknown, required
          - `alternative_lender_transactions` Transaction[], required: A list of all transactions to/from alternative lenders, including small business lenders, personal lenders, and mortgage players. This list also includes transactions relating to Merchant Cash Advance and Factoring, though these are separately filtered in unique lists for Merchant Cash Advance Transactions and Factoring Transactions.
            - `page_idx` integer, required: The page number of the original document from which this transaction was captured.
            - `bank_account_pk` integer, required: The primary key of the bank account from which this transaction was captured.
            - `amount` string, required: The amount of the credit or debit that this transaction represents. Will be in USD, and can be positive or negative.
            - `bbox` number[], required: The coordinates of the bounding box (i.e. rectangle) on the page from which this transaction was captured. Unit of measurement is in pixels, and the origin (`[0, 0]`) is in the top-left corner. The bounding box is encoded as `[x, y, x+w, y+h]`, where: - `x` is the horizontal position of the box, relative to the left of the page. - `y` is the vertical position of the bounding box, relative to the top of the page. - `w` is the width of the bounding box. - `h` is the height of the bounding box.
            - `txn_date` string, required: The date on which this transaction occurred. Given in `MM/DD/YYYY` format.
            - `page_doc_pk` integer, required: The unique identifier of the page from which this transaction was captured.
            - `pk` integer, required: The unique identifier of this particular transaction.
            - `uploaded_doc_pk` integer, required: The unique identifier of the document from which this transaction was captured.
            - `description` string, required: Details about the transaction that were captured from the original bank statement.
          - `atm_withdrawals_num` integer: Total number of all ATM withdrawals from the bank account
          - `atm_withdrawals_sum` string: The sum of all atm withdrawal amounts
          - `average_alt_lender_payments` string, required: Average monthly debits (i.e. payments) made to alternative lenders. Provides context into a customer's access to competitive financing as well as debt service requirements.
          - `average_by_month` unknown, required
          - `average_daily_balance` string, required: The average daily ending balance (including weekends).
          - `average_daily_balance_by_month` unknown, required
          - `average_daily_balance_weekday` string, required: The average daily ending balance of weekdays.
          - `average_daily_balance_weekday_by_month` unknown, required
          - `average_daily_cash_flow` string, required: Average daily net cash flow, where `Net Cash Flow = Credits - Debits`. Important to understand if the business is running a surplus or deficit and how much free cash flow may be available for servicing new debt.
          - `average_daily_cash_flow_weekday` string, required: Average daily net cash flow on weekdays, where `Net Cash Flow = Credits - Debits`. Important to understand if the business is running a surplus or deficit and how much free cash flow may be available for servicing new debt.
          - `average_deposit_by_month` unknown, required
          - `average_mca_payments` string, required: Average monthly debits (i.e. payments) made to merchant cash advance lenders. Provides context into a customer's access to competitive financing as well as debt service requirements.
          - `bank_name` string, required: Name of the bank which issued the bank statement.
          - `book_pk` integer, required: The unique identifier for the <<glossary:Book>> that was used to compute these analytics.
          - `branch_withdrawals_num` integer: Number of cash withdrawals from a physical location.
          - `branch_withdrawals_sum` string: Amount of branch cash withdrawals from a physical location.
          - `cash_balance_trend_30d` string, required: The normalized change in daily cash balance over time. Used to measure the change in cash balances for a business in different environments. ((Mean cash balance t-30 to t-16) - (Mean cash balance t-15 to t-1) ) / standard deviation of cash balance over t-30 to t-1
          - `cash_balance_trend_60d` string, required: The normalized change in daily cash balance over time. Used to measure the change in cash balances for a business in different environments. ((Mean cash balance t-60 to t-31) - (Mean cash balance t-30 to t-1) ) / standard deviation of cash balance over t-60 to t-1
          - `cash_balance_trend_90d` string, required: The normalized change in daily cash balance over time. Used to measure the change in cash balances for a business in different environments. ((Mean cash balance t-90 to t-46) - (Mean cash balance t-45 to t-1) ) / standard deviation of cash balance over t-90 to t-1
          - `cash_expense_days_by_month` unknown, required
          - `cash_flow_trend_30d` string, required: The normalized change in daily cash flow over time. Used to measure the change in profitability for a business in different environments. ((Mean cash flow t-30 to t-16) - (Mean cash flow t-15 to t-1) ) / standard deviation of cash flow over t-30 to t-1
          - `cash_flow_trend_60d` string, required: The normalized change in daily cash flow over time. Used to measure the change in profitability for a business in different environments. ((Mean cash flow t-60 to t-31) - (Mean cash flow t-30 to t-1) ) / standard deviation of cash flow over t-60 to t-1
          - `cash_flow_trend_90d` string, required: The normalized change in daily cash flow over time. Used to measure the change in profitability for a business in different environments. ((Mean cash flow t-90 to t-46) - (Mean cash flow t-45 to t-1) ) / standard deviation of cash flow over t-90 to t-1
          - `casino_lottery_num` integer: The number of credit transactions originating from casino or lottery winnings.
          - `casino_lottery_sum` string: The total amount of credit transactions originating from casino or lottery winnings.
          - `checks_highest_incidence` union[]: Most commonly occurring check amount and the number of such occurrences in form `[amount, num_occurences]`. If no checks were received in this bank statement, will have a value of `["0.00", 0]`.
            - union
              - …
          - `checks_num` integer: Number of checks
          - `credit_card_payments_num` integer: Number of Credit Card Payments
          - `credit_card_payments_sum` string: Amount of Credit Card Payments
          - `daily_balances` unknown, required
          - `daily_cash_flows` unknown, required
          - `daily_cash_flows_weekday` unknown
          - `debt_consolidator_txns` Transaction[], required: A list of all transactions to/from debt consolidation (refinancing) companies.
            - `page_idx` integer, required: The page number of the original document from which this transaction was captured.
            - `bank_account_pk` integer, required: The primary key of the bank account from which this transaction was captured.
            - `amount` string, required: The amount of the credit or debit that this transaction represents. Will be in USD, and can be positive or negative.
            - `bbox` number[], required: The coordinates of the bounding box (i.e. rectangle) on the page from which this transaction was captured. Unit of measurement is in pixels, and the origin (`[0, 0]`) is in the top-left corner. The bounding box is encoded as `[x, y, x+w, y+h]`, where: - `x` is the horizontal position of the box, relative to the left of the page. - `y` is the vertical position of the bounding box, relative to the top of the page. - `w` is the width of the bounding box. - `h` is the height of the bounding box.
            - `txn_date` string, required: The date on which this transaction occurred. Given in `MM/DD/YYYY` format.
            - `page_doc_pk` integer, required: The unique identifier of the page from which this transaction was captured.
            - `pk` integer, required: The unique identifier of this particular transaction.
            - `uploaded_doc_pk` integer, required: The unique identifier of the document from which this transaction was captured.
            - `description` string, required: Details about the transaction that were captured from the original bank statement.
          - `deposit_count` integer, required: The total number of credit transactions.
          - `deposit_max_by_month` unknown, required
          - `deposit_min_by_month` unknown, required
          - `deposit_sum` string, required: Sum of all credit transactions
          - `deposits_count_by_month` unknown, required
          - `deposits_sum_by_month` unknown, required
          - `equipment_lease_payments_num` integer: Number of outflow transactions to equipment leasing companies
          - `equipment_lease_payments_sum` string: Total amount of outflow transactions to equipment leasing companies
          - `estimated_daily_expense_by_month` unknown, required
          - `estimated_daily_revenue_by_month` unknown, required
          - `estimated_expense_by_month` unknown, required
          - `estimated_expense_txns_list` Transaction[], required: List of transactions included in estimated expense calculations.
            - `page_idx` integer, required: The page number of the original document from which this transaction was captured.
            - `bank_account_pk` integer, required: The primary key of the bank account from which this transaction was captured.
            - `amount` string, required: The amount of the credit or debit that this transaction represents. Will be in USD, and can be positive or negative.
            - `bbox` number[], required: The coordinates of the bounding box (i.e. rectangle) on the page from which this transaction was captured. Unit of measurement is in pixels, and the origin (`[0, 0]`) is in the top-left corner. The bounding box is encoded as `[x, y, x+w, y+h]`, where: - `x` is the horizontal position of the box, relative to the left of the page. - `y` is the vertical position of the bounding box, relative to the top of the page. - `w` is the width of the bounding box. - `h` is the height of the bounding box.
            - `txn_date` string, required: The date on which this transaction occurred. Given in `MM/DD/YYYY` format.
            - `page_doc_pk` integer, required: The unique identifier of the page from which this transaction was captured.
            - `pk` integer, required: The unique identifier of this particular transaction.
            - `uploaded_doc_pk` integer, required: The unique identifier of the document from which this transaction was captured.
            - `description` string, required: Details about the transaction that were captured from the original bank statement.
          - `estimated_revenue_by_month` object, required: The estimated revenue of the business grouped by calendar month. This is calculated by summing together all credit transactions, then removing all transfer credits (except for wire transfers), all alternative lender credits (except for factoring credits), and all transactions that contain words that signify that they are not revenue deposits. This includes words such as "Refund", "Reversal", "Cash Back", "Return", and about 20 others. Each key is a string representing a month and a year, using the regex `^\d{2}/\d{4}$` (i.e `MM/YYYY`).
          - `estimated_revenue_by_month_calc_txns` EstimatedRevenueCalculationTransactionsByMonth, required: The list of credit transactions used to calculate estimated revenues grouped by category and calendar month. estimated_revenue = all credits - revenue_deducted - transfer + revenue_included - alternative_lender + factoring The estimated revenue of the business grouped by calendar month. This is calculated by summing together all credit transactions, then removing all transfer credits (except for wire transfers), all alternative lender credits (except for factoring credits), and all transactions that contain words that signify that they are not revenue deposits. This includes words such as "Refund", "Reversal", "Cash Back", "Return", and about 20 others.
            - `added_factoring_txns` unknown, required
            - `added_specific_terms_txns` unknown, required
            - `deposits` unknown, required
            - `deducted_alternative_lender_txns` unknown, required
            - `deducted_specific_terms_txns` unknown, required
            - `deducted_transfer_deposit_txns` unknown, required
          - `estimated_revenue_txns_list` Transaction[], required: The ungrouped list of credit transactions that comprise the estimated revenue of the applicant.
            - `page_idx` integer, required: The page number of the original document from which this transaction was captured.
            - `bank_account_pk` integer, required: The primary key of the bank account from which this transaction was captured.
            - `amount` string, required: The amount of the credit or debit that this transaction represents. Will be in USD, and can be positive or negative.
            - `bbox` number[], required: The coordinates of the bounding box (i.e. rectangle) on the page from which this transaction was captured. Unit of measurement is in pixels, and the origin (`[0, 0]`) is in the top-left corner. The bounding box is encoded as `[x, y, x+w, y+h]`, where: - `x` is the horizontal position of the box, relative to the left of the page. - `y` is the vertical position of the bounding box, relative to the top of the page. - `w` is the width of the bounding box. - `h` is the height of the bounding box.
            - `txn_date` string, required: The date on which this transaction occurred. Given in `MM/DD/YYYY` format.
            - `page_doc_pk` integer, required: The unique identifier of the page from which this transaction was captured.
            - `pk` integer, required: The unique identifier of this particular transaction.
            - `uploaded_doc_pk` integer, required: The unique identifier of the document from which this transaction was captured.
            - `description` string, required: Details about the transaction that were captured from the original bank statement.
          - `factor_txns` Transaction[], required: A list of all transactions to/from invoice factoring companies.
            - `page_idx` integer, required: The page number of the original document from which this transaction was captured.
            - `bank_account_pk` integer, required: The primary key of the bank account from which this transaction was captured.
            - `amount` string, required: The amount of the credit or debit that this transaction represents. Will be in USD, and can be positive or negative.
            - `bbox` number[], required: The coordinates of the bounding box (i.e. rectangle) on the page from which this transaction was captured. Unit of measurement is in pixels, and the origin (`[0, 0]`) is in the top-left corner. The bounding box is encoded as `[x, y, x+w, y+h]`, where: - `x` is the horizontal position of the box, relative to the left of the page. - `y` is the vertical position of the bounding box, relative to the top of the page. - `w` is the width of the bounding box. - `h` is the height of the bounding box.
            - `txn_date` string, required: The date on which this transaction occurred. Given in `MM/DD/YYYY` format.
            - `page_doc_pk` integer, required: The unique identifier of the page from which this transaction was captured.
            - `pk` integer, required: The unique identifier of this particular transaction.
            - `uploaded_doc_pk` integer, required: The unique identifier of the document from which this transaction was captured.
            - `description` string, required: Details about the transaction that were captured from the original bank statement.
          - `holder_address_1` string, required: The primary address of the person or entity who owns this bank account.
          - `holder_address_2` string, nullable, required: Extra address information about the owner of this bank account, usually about a particular suite or office. Will be `null` if not provided.
          - `holder_city` string, required: The town or city of the account holder's address.
          - `holder_country` string, required: The captured country of residence of the account holder. We only support American bank statements at this time.
          - `holder_state` string, required: The captured state or territory of the account holder.
          - `holder_zip` string, required: The captured postal code of the account holder.
          - `id` integer
          - `insurance_credits` Transaction[], required: A list of all positive transactions from insurance providers.
            - `page_idx` integer, required: The page number of the original document from which this transaction was captured.
            - `bank_account_pk` integer, required: The primary key of the bank account from which this transaction was captured.
            - `amount` string, required: The amount of the credit or debit that this transaction represents. Will be in USD, and can be positive or negative.
            - `bbox` number[], required: The coordinates of the bounding box (i.e. rectangle) on the page from which this transaction was captured. Unit of measurement is in pixels, and the origin (`[0, 0]`) is in the top-left corner. The bounding box is encoded as `[x, y, x+w, y+h]`, where: - `x` is the horizontal position of the box, relative to the left of the page. - `y` is the vertical position of the bounding box, relative to the top of the page. - `w` is the width of the bounding box. - `h` is the height of the bounding box.
            - `txn_date` string, required: The date on which this transaction occurred. Given in `MM/DD/YYYY` format.
            - `page_doc_pk` integer, required: The unique identifier of the page from which this transaction was captured.
            - `pk` integer, required: The unique identifier of this particular transaction.
            - `uploaded_doc_pk` integer, required: The unique identifier of the document from which this transaction was captured.
            - `description` string, required: Details about the transaction that were captured from the original bank statement.
          - `insurance_debits` Transaction[], required: A list of all negative transactions from insurance providers.
            - `page_idx` integer, required: The page number of the original document from which this transaction was captured.
            - `bank_account_pk` integer, required: The primary key of the bank account from which this transaction was captured.
            - `amount` string, required: The amount of the credit or debit that this transaction represents. Will be in USD, and can be positive or negative.
            - `bbox` number[], required: The coordinates of the bounding box (i.e. rectangle) on the page from which this transaction was captured. Unit of measurement is in pixels, and the origin (`[0, 0]`) is in the top-left corner. The bounding box is encoded as `[x, y, x+w, y+h]`, where: - `x` is the horizontal position of the box, relative to the left of the page. - `y` is the vertical position of the bounding box, relative to the top of the page. - `w` is the width of the bounding box. - `h` is the height of the bounding box.
            - `txn_date` string, required: The date on which this transaction occurred. Given in `MM/DD/YYYY` format.
            - `page_doc_pk` integer, required: The unique identifier of the page from which this transaction was captured.
            - `pk` integer, required: The unique identifier of this particular transaction.
            - `uploaded_doc_pk` integer, required: The unique identifier of the document from which this transaction was captured.
            - `description` string, required: Details about the transaction that were captured from the original bank statement.
          - `insurance_payments_num` integer: Number of insurance payments
          - `insurance_payments_sum` string: Amount of insurance payments
          - `insurance_terms` Transaction[], required: A list of negative transactions associated with insurance companies.
            - `page_idx` integer, required: The page number of the original document from which this transaction was captured.
            - `bank_account_pk` integer, required: The primary key of the bank account from which this transaction was captured.
            - `amount` string, required: The amount of the credit or debit that this transaction represents. Will be in USD, and can be positive or negative.
            - `bbox` number[], required: The coordinates of the bounding box (i.e. rectangle) on the page from which this transaction was captured. Unit of measurement is in pixels, and the origin (`[0, 0]`) is in the top-left corner. The bounding box is encoded as `[x, y, x+w, y+h]`, where: - `x` is the horizontal position of the box, relative to the left of the page. - `y` is the vertical position of the bounding box, relative to the top of the page. - `w` is the width of the bounding box. - `h` is the height of the bounding box.
            - `txn_date` string, required: The date on which this transaction occurred. Given in `MM/DD/YYYY` format.
            - `page_doc_pk` integer, required: The unique identifier of the page from which this transaction was captured.
            - `pk` integer, required: The unique identifier of this particular transaction.
            - `uploaded_doc_pk` integer, required: The unique identifier of the document from which this transaction was captured.
            - `description` string, required: Details about the transaction that were captured from the original bank statement.
          - `interbank_transactions` Transaction[], required: A list of all transactions to/from any bank or financial institution.
            - `page_idx` integer, required: The page number of the original document from which this transaction was captured.
            - `bank_account_pk` integer, required: The primary key of the bank account from which this transaction was captured.
            - `amount` string, required: The amount of the credit or debit that this transaction represents. Will be in USD, and can be positive or negative.
            - `bbox` number[], required: The coordinates of the bounding box (i.e. rectangle) on the page from which this transaction was captured. Unit of measurement is in pixels, and the origin (`[0, 0]`) is in the top-left corner. The bounding box is encoded as `[x, y, x+w, y+h]`, where: - `x` is the horizontal position of the box, relative to the left of the page. - `y` is the vertical position of the bounding box, relative to the top of the page. - `w` is the width of the bounding box. - `h` is the height of the bounding box.
            - `txn_date` string, required: The date on which this transaction occurred. Given in `MM/DD/YYYY` format.
            - `page_doc_pk` integer, required: The unique identifier of the page from which this transaction was captured.
            - `pk` integer, required: The unique identifier of this particular transaction.
            - `uploaded_doc_pk` integer, required: The unique identifier of the document from which this transaction was captured.
            - `description` string, required: Details about the transaction that were captured from the original bank statement.
          - `lottery_withdrawals_num` integer: Number of outflow transactions spent on lottery
          - `lottery_withdrawals_sum` string: Total amount of outflow transactions spent on lottery
          - `mca_payments_by_month` unknown, required
          - `merchant_cash_advance_lender_txns` Transaction[], required: A list of all transactions to/from merchant cash advance companies.
            - `page_idx` integer, required: The page number of the original document from which this transaction was captured.
            - `bank_account_pk` integer, required: The primary key of the bank account from which this transaction was captured.
            - `amount` string, required: The amount of the credit or debit that this transaction represents. Will be in USD, and can be positive or negative.
            - `bbox` number[], required: The coordinates of the bounding box (i.e. rectangle) on the page from which this transaction was captured. Unit of measurement is in pixels, and the origin (`[0, 0]`) is in the top-left corner. The bounding box is encoded as `[x, y, x+w, y+h]`, where: - `x` is the horizontal position of the box, relative to the left of the page. - `y` is the vertical position of the bounding box, relative to the top of the page. - `w` is the width of the bounding box. - `h` is the height of the bounding box.
            - `txn_date` string, required: The date on which this transaction occurred. Given in `MM/DD/YYYY` format.
            - `page_doc_pk` integer, required: The unique identifier of the page from which this transaction was captured.
            - `pk` integer, required: The unique identifier of this particular transaction.
            - `uploaded_doc_pk` integer, required: The unique identifier of the document from which this transaction was captured.
            - `description` string, required: Details about the transaction that were captured from the original bank statement.
          - `merchant_service_deposits_num` integer: Total number of merchant service deposits (positive transactions matching with merchant service terms) in the bank account
          - `merchant_service_deposits_sum` string: The sum of merchant service deposit transactions amounts (positive transactions matching with merchant service terms) in the bank account
          - `minimum_balance_by_month` unknown, required
          - `name` string, required: Name of the Book or bank account
          - `negative_balances_by_month` unknown, required
          - `negative_balances_by_month_weekday` unknown, required
          - `negative_balances_weekday` string[], required: The list of all weekdays in which the daily ending balance fell below zero
          - `negative_cash_flows` string[], required: List of dates where net cash flows (defined as credits - debits) are negative.
          - `negative_cash_flows_weekday` string[], required: List of weekdays where net cash flows (defined as credits - debits) are negative.
          - `net_cash_flows_by_month` unknown, required
          - `non_estimated_revenue_txns_list` Transaction[], required: The list of credit transactions that are excluded from the “Estimated Revenue by Month” calculation.
            - `page_idx` integer, required: The page number of the original document from which this transaction was captured.
            - `bank_account_pk` integer, required: The primary key of the bank account from which this transaction was captured.
            - `amount` string, required: The amount of the credit or debit that this transaction represents. Will be in USD, and can be positive or negative.
            - `bbox` number[], required: The coordinates of the bounding box (i.e. rectangle) on the page from which this transaction was captured. Unit of measurement is in pixels, and the origin (`[0, 0]`) is in the top-left corner. The bounding box is encoded as `[x, y, x+w, y+h]`, where: - `x` is the horizontal position of the box, relative to the left of the page. - `y` is the vertical position of the bounding box, relative to the top of the page. - `w` is the width of the bounding box. - `h` is the height of the bounding box.
            - `txn_date` string, required: The date on which this transaction occurred. Given in `MM/DD/YYYY` format.
            - `page_doc_pk` integer, required: The unique identifier of the page from which this transaction was captured.
            - `pk` integer, required: The unique identifier of this particular transaction.
            - `uploaded_doc_pk` integer, required: The unique identifier of the document from which this transaction was captured.
            - `description` string, required: Details about the transaction that were captured from the original bank statement.
          - `nsf_count` integer, required: The number of unique NSF & Overdraft fees for each bank account. This is especially useful with institutions that lump NSF fees into one transaction.
          - `nsf_count_by_month` unknown, required
          - `nsf_transactions` Transaction[], required: A list of transactions associated with non-sufficient funds and overdraft transactions.
            - `page_idx` integer, required: The page number of the original document from which this transaction was captured.
            - `bank_account_pk` integer, required: The primary key of the bank account from which this transaction was captured.
            - `amount` string, required: The amount of the credit or debit that this transaction represents. Will be in USD, and can be positive or negative.
            - `bbox` number[], required: The coordinates of the bounding box (i.e. rectangle) on the page from which this transaction was captured. Unit of measurement is in pixels, and the origin (`[0, 0]`) is in the top-left corner. The bounding box is encoded as `[x, y, x+w, y+h]`, where: - `x` is the horizontal position of the box, relative to the left of the page. - `y` is the vertical position of the bounding box, relative to the top of the page. - `w` is the width of the bounding box. - `h` is the height of the bounding box.
            - `txn_date` string, required: The date on which this transaction occurred. Given in `MM/DD/YYYY` format.
            - `page_doc_pk` integer, required: The unique identifier of the page from which this transaction was captured.
            - `pk` integer, required: The unique identifier of this particular transaction.
            - `uploaded_doc_pk` integer, required: The unique identifier of the document from which this transaction was captured.
            - `description` string, required: Details about the transaction that were captured from the original bank statement.
          - `nsf_transactions_paid_or_negative_balance` Transaction[], required: A list of transactions associated with overdraft transactions.
            - `page_idx` integer, required: The page number of the original document from which this transaction was captured.
            - `bank_account_pk` integer, required: The primary key of the bank account from which this transaction was captured.
            - `amount` string, required: The amount of the credit or debit that this transaction represents. Will be in USD, and can be positive or negative.
            - `bbox` number[], required: The coordinates of the bounding box (i.e. rectangle) on the page from which this transaction was captured. Unit of measurement is in pixels, and the origin (`[0, 0]`) is in the top-left corner. The bounding box is encoded as `[x, y, x+w, y+h]`, where: - `x` is the horizontal position of the box, relative to the left of the page. - `y` is the vertical position of the bounding box, relative to the top of the page. - `w` is the width of the bounding box. - `h` is the height of the bounding box.
            - `txn_date` string, required: The date on which this transaction occurred. Given in `MM/DD/YYYY` format.
            - `page_doc_pk` integer, required: The unique identifier of the page from which this transaction was captured.
            - `pk` integer, required: The unique identifier of this particular transaction.
            - `uploaded_doc_pk` integer, required: The unique identifier of the document from which this transaction was captured.
            - `description` string, required: Details about the transaction that were captured from the original bank statement.
          - `nsf_transactions_paid_or_negative_balance_count_by_month` unknown, required
          - `nsf_transactions_returned_or_not_paid` Transaction[], required: A list of transactions associated with returned and/or unpaid items due to NSF fees.
            - `page_idx` integer, required: The page number of the original document from which this transaction was captured.
            - `bank_account_pk` integer, required: The primary key of the bank account from which this transaction was captured.
            - `amount` string, required: The amount of the credit or debit that this transaction represents. Will be in USD, and can be positive or negative.
            - `bbox` number[], required: The coordinates of the bounding box (i.e. rectangle) on the page from which this transaction was captured. Unit of measurement is in pixels, and the origin (`[0, 0]`) is in the top-left corner. The bounding box is encoded as `[x, y, x+w, y+h]`, where: - `x` is the horizontal position of the box, relative to the left of the page. - `y` is the vertical position of the bounding box, relative to the top of the page. - `w` is the width of the bounding box. - `h` is the height of the bounding box.
            - `txn_date` string, required: The date on which this transaction occurred. Given in `MM/DD/YYYY` format.
            - `page_doc_pk` integer, required: The unique identifier of the page from which this transaction was captured.
            - `pk` integer, required: The unique identifier of this particular transaction.
            - `uploaded_doc_pk` integer, required: The unique identifier of the document from which this transaction was captured.
            - `description` string, required: Details about the transaction that were captured from the original bank statement.
          - `nsf_transactions_returned_or_not_paid_count_by_month` unknown, required
          - `outside_source_deposits` Transaction[], required: The list of credit transactions that are not transfers
            - `page_idx` integer, required: The page number of the original document from which this transaction was captured.
            - `bank_account_pk` integer, required: The primary key of the bank account from which this transaction was captured.
            - `amount` string, required: The amount of the credit or debit that this transaction represents. Will be in USD, and can be positive or negative.
            - `bbox` number[], required: The coordinates of the bounding box (i.e. rectangle) on the page from which this transaction was captured. Unit of measurement is in pixels, and the origin (`[0, 0]`) is in the top-left corner. The bounding box is encoded as `[x, y, x+w, y+h]`, where: - `x` is the horizontal position of the box, relative to the left of the page. - `y` is the vertical position of the bounding box, relative to the top of the page. - `w` is the width of the bounding box. - `h` is the height of the bounding box.
            - `txn_date` string, required: The date on which this transaction occurred. Given in `MM/DD/YYYY` format.
            - `page_doc_pk` integer, required: The unique identifier of the page from which this transaction was captured.
            - `pk` integer, required: The unique identifier of this particular transaction.
            - `uploaded_doc_pk` integer, required: The unique identifier of the document from which this transaction was captured.
            - `description` string, required: Details about the transaction that were captured from the original bank statement.
          - `paypal_num` integer: Number of Paypal Transactions
          - `paypal_sum` string: Amount of Paypal Transactions
          - `payroll` Transaction[], required: A list of all transactions from payroll providers.
            - `page_idx` integer, required: The page number of the original document from which this transaction was captured.
            - `bank_account_pk` integer, required: The primary key of the bank account from which this transaction was captured.
            - `amount` string, required: The amount of the credit or debit that this transaction represents. Will be in USD, and can be positive or negative.
            - `bbox` number[], required: The coordinates of the bounding box (i.e. rectangle) on the page from which this transaction was captured. Unit of measurement is in pixels, and the origin (`[0, 0]`) is in the top-left corner. The bounding box is encoded as `[x, y, x+w, y+h]`, where: - `x` is the horizontal position of the box, relative to the left of the page. - `y` is the vertical position of the bounding box, relative to the top of the page. - `w` is the width of the bounding box. - `h` is the height of the bounding box.
            - `txn_date` string, required: The date on which this transaction occurred. Given in `MM/DD/YYYY` format.
            - `page_doc_pk` integer, required: The unique identifier of the page from which this transaction was captured.
            - `pk` integer, required: The unique identifier of this particular transaction.
            - `uploaded_doc_pk` integer, required: The unique identifier of the document from which this transaction was captured.
            - `description` string, required: Details about the transaction that were captured from the original bank statement.
          - `payroll_num` integer: For business account only, the total number of payroll transactions (negative transactions matching with payroll term list) in the bank account
          - `payroll_sum` string: For business account only, the sum of payroll transactions' amounts (negative transactions matching with payroll term list) in the bank account
          - `period_balance_mismatches` PeriodBalanceMismatch[], required: An indication of gaps between statement periods captured in the bank account.
            - `begin_date` string: The starting date of the unaccounted-for statement period.
            - `begin_balance` string: The starting balance of the unaccounted-for statement period.
            - `end_date` string: The ending date of the unaccounted-for statement period.
            - `end_balance` string: The ending balance of the unaccounted-for statement period.
          - `periods` PeriodAnalytics[], required: Contains list of period level JSONs
            - `alternative_lender_transactions` Transaction[], required: A list of all transactions to/from alternative lenders, including small business lenders, personal lenders, and mortgage players. This list also includes transactions relating to Merchant Cash Advance and Factoring, though these are separately filtered in unique lists for Merchant Cash Advance Transactions and Factoring Transactions.
              - …
            - `average_amount` string, required: The average absolute value of transaction amounts in a statement period.
            - `average_daily_balance` string, required: The average daily ending balance (including weekends).
            - `average_daily_balance_weekday` string, required: The average daily ending balance of weekdays.
            - `average_daily_cash_flow` string, required: Average daily net cash flow, where `Net Cash Flow = Credits - Debits`. Important to understand if the business is running a surplus or deficit and how much free cash flow may be available for servicing new debt.
            - `average_daily_cash_flow_weekday` string, required: Average daily net cash flow on weekdays, where `Net Cash Flow = Credits - Debits`. Important to understand if the business is running a surplus or deficit and how much free cash flow may be available for servicing new debt.
            - `average_deposit` string, required: The average value of credit transactions
            - `bank_account_pk` integer, required
            - `begin_balance` string, required: The beginning balance of the statement period captured from the summary section of a bank statement.
            - `begin_date` string, required: The beginning date of the statement period captured from the summary section of a bank statement.
            - `deposit_count` integer, required: The total number of credit transactions.
            - `deposit_max` Transaction[], required: The credit txn(s) with the largest amount
              - …
            - `deposit_min` Transaction[], required: The credit txn(s) with the smallest amount
              - …
            - `deposit_sum` string, required: Sum of all credit transactions
            - `end_balance` string, required: The ending balance of the statement period captured from the summary section of a bank statement.
            - `end_date` string, required: The ending date of the statement period captured from the summary section of a bank statement.
            - `estimated_revenue` string, required: The estimated revenue of the business. This is calculated by summing together all credit transactions, then removing all transfer credits (except for wire transfers), all alternative lender credits (except for factoring credits), and all transactions that contain words that signify that they are not revenue deposits. This includes words such as Refund, Reversal, Cash Back, Return, and about 20 others.
            - `estimated_revenue_calc_txns` EstimatedRevenueCalculationTransactions, required: The list of credit transactions that comprise the estimated revenue calculations for the business.
              - …
            - `negative_balances` string[], required: The list of all days in which the daily ending balance fell below zero
            - `negative_balances_weekday` string[], required: The list of all weekdays in which the daily ending balance fell below zero
            - `negative_cash_flows` string[], required: List of dates where net cash flows (defined as credits - debits) are negative.
            - `negative_cash_flows_weekday` string[], required: List of weekdays where net cash flows (defined as credits - debits) are negative.
            - `nsf_count` integer, required: The number of unique NSF & Overdraft fees for each bank account. This is especially useful with institutions that lump NSF fees into one transaction.
            - `nsf_transactions_paid_or_negative_balance_count` integer, required: The count of transactions associated with overdraft transactions.
            - `nsf_transactions_returned_or_not_paid_count` integer: The count of transactions associated with returned and/or unpaid items due to NSF fees.
            - `payroll` string, required: The sum of payroll transaction amounts within this period.
            - `period_month_days` unknown, required
            - `period_month_txns` unknown, required
            - `pk` integer, required: A unique identifying integer.
            - `primary_recon_error_reason` string, required: Manual verifier flag for suspicious activity after inspection
            - `secondary_recon_error_reason` string, required: Manual verifier flag for suspicious activity after inspection
            - `txn_count` integer, required: The total number of transactions in a bank account.
            - `uploaded_doc_pk` integer, required: Unique identifying integer
            - `withdrawal_count` integer, required: The total number of debit transactions.
            - `withdrawal_sum` string, required: The total monetary value of debits
            - `withdrawals_max` Transaction[], required: The debit transaction(s) with the most negative amount
              - …
          - `pk` integer, required: A unique identifying integer.
          - `ppp_loan_txns` Transaction[], required: A list of credit transactions associated with the SBA Payroll Protection Program
            - `page_idx` integer, required: The page number of the original document from which this transaction was captured.
            - `bank_account_pk` integer, required: The primary key of the bank account from which this transaction was captured.
            - `amount` string, required: The amount of the credit or debit that this transaction represents. Will be in USD, and can be positive or negative.
            - `bbox` number[], required: The coordinates of the bounding box (i.e. rectangle) on the page from which this transaction was captured. Unit of measurement is in pixels, and the origin (`[0, 0]`) is in the top-left corner. The bounding box is encoded as `[x, y, x+w, y+h]`, where: - `x` is the horizontal position of the box, relative to the left of the page. - `y` is the vertical position of the bounding box, relative to the top of the page. - `w` is the width of the bounding box. - `h` is the height of the bounding box.
            - `txn_date` string, required: The date on which this transaction occurred. Given in `MM/DD/YYYY` format.
            - `page_doc_pk` integer, required: The unique identifier of the page from which this transaction was captured.
            - `pk` integer, required: The unique identifier of this particular transaction.
            - `uploaded_doc_pk` integer, required: The unique identifier of the document from which this transaction was captured.
            - `description` string, required: Details about the transaction that were captured from the original bank statement.
          - `probable_recurring_txns` Transaction[], required: A list of transactions with the same dollar value that are greater than $10 and occur two or more times within 45 days.
            - `page_idx` integer, required: The page number of the original document from which this transaction was captured.
            - `bank_account_pk` integer, required: The primary key of the bank account from which this transaction was captured.
            - `amount` string, required: The amount of the credit or debit that this transaction represents. Will be in USD, and can be positive or negative.
            - `bbox` number[], required: The coordinates of the bounding box (i.e. rectangle) on the page from which this transaction was captured. Unit of measurement is in pixels, and the origin (`[0, 0]`) is in the top-left corner. The bounding box is encoded as `[x, y, x+w, y+h]`, where: - `x` is the horizontal position of the box, relative to the left of the page. - `y` is the vertical position of the bounding box, relative to the top of the page. - `w` is the width of the bounding box. - `h` is the height of the bounding box.
            - `txn_date` string, required: The date on which this transaction occurred. Given in `MM/DD/YYYY` format.
            - `page_doc_pk` integer, required: The unique identifier of the page from which this transaction was captured.
            - `pk` integer, required: The unique identifier of this particular transaction.
            - `uploaded_doc_pk` integer, required: The unique identifier of the document from which this transaction was captured.
            - `description` string, required: Details about the transaction that were captured from the original bank statement.
          - `recurring_vs_episodic_inflows_by_month` unknown, required
          - `recurring_vs_episodic_outflows_by_month` unknown, required
          - `remote_deposits_num` integer: Total number of remote deposits in the bank account
          - `remote_deposits_sum` string: Sum of remote deposit amounts in the bank account
          - `returned_items` Transaction[]
            - `page_idx` integer, required: The page number of the original document from which this transaction was captured.
            - `bank_account_pk` integer, required: The primary key of the bank account from which this transaction was captured.
            - `amount` string, required: The amount of the credit or debit that this transaction represents. Will be in USD, and can be positive or negative.
            - `bbox` number[], required: The coordinates of the bounding box (i.e. rectangle) on the page from which this transaction was captured. Unit of measurement is in pixels, and the origin (`[0, 0]`) is in the top-left corner. The bounding box is encoded as `[x, y, x+w, y+h]`, where: - `x` is the horizontal position of the box, relative to the left of the page. - `y` is the vertical position of the bounding box, relative to the top of the page. - `w` is the width of the bounding box. - `h` is the height of the bounding box.
            - `txn_date` string, required: The date on which this transaction occurred. Given in `MM/DD/YYYY` format.
            - `page_doc_pk` integer, required: The unique identifier of the page from which this transaction was captured.
            - `pk` integer, required: The unique identifier of this particular transaction.
            - `uploaded_doc_pk` integer, required: The unique identifier of the document from which this transaction was captured.
            - `description` string, required: Details about the transaction that were captured from the original bank statement.
          - `round_number_txns` Transaction[], required: A list of transactions that end in at least five zeroes, e.g., $1,000.00.
            - `page_idx` integer, required: The page number of the original document from which this transaction was captured.
            - `bank_account_pk` integer, required: The primary key of the bank account from which this transaction was captured.
            - `amount` string, required: The amount of the credit or debit that this transaction represents. Will be in USD, and can be positive or negative.
            - `bbox` number[], required: The coordinates of the bounding box (i.e. rectangle) on the page from which this transaction was captured. Unit of measurement is in pixels, and the origin (`[0, 0]`) is in the top-left corner. The bounding box is encoded as `[x, y, x+w, y+h]`, where: - `x` is the horizontal position of the box, relative to the left of the page. - `y` is the vertical position of the bounding box, relative to the top of the page. - `w` is the width of the bounding box. - `h` is the height of the bounding box.
            - `txn_date` string, required: The date on which this transaction occurred. Given in `MM/DD/YYYY` format.
            - `page_doc_pk` integer, required: The unique identifier of the page from which this transaction was captured.
            - `pk` integer, required: The unique identifier of this particular transaction.
            - `uploaded_doc_pk` integer, required: The unique identifier of the document from which this transaction was captured.
            - `description` string, required: Details about the transaction that were captured from the original bank statement.
          - `state_tax_payments_num` integer: Number of tax payments that are not US tax payments
          - `state_tax_payments_sum` string: Amount of tax payments that are not US tax payments
          - `suspicious_activities` SuspiciousActivities, required: Suspicious activity flags. Deprecated because this represents legacy detection. We suggest using our dedicated [Suspicious Activity Flags](ref:suspicious-activity), which reveals suspicious activity signals with much greater accuracy and fidelity than offered by this attribute.
            - `has_weekend_transactions` boolean, required
            - `high_amount_average_daily_balance` boolean, required
            - `balance_ending_with_zero` boolean, required
            - `no_txn_in_weekdays_within_period` boolean, required
            - `high_txns_amount_atm_over_cash` boolean, required
            - `high_txns_count_atm_over_cash` boolean, required
          - `tolls_num` integer: Number of toll payments
          - `tolls_sum` string: Amount of toll payments
          - `total_days` integer, required: The total number of days in all statement periods captured in the bank account.
          - `transfer` Transfers, required: The list of all transfers to or from a bank account.
            - `debit_transfer` Transaction[], required
              - …
            - `credit_transfer` Transaction[], required
              - …
          - `transfer_num` integer: Total number of transfer transactions (positive and negative transactions matching with transfer term list) in the bank account
          - `transfer_sum` string: Sum of transfer transactions' amounts (positive and negative transactions matching with transfer term list) in the bank account
          - `txn_count` integer, required: The total number of transactions in a bank account.
          - `txn_four_zeros` integer: Number of transactions ending in 4 zeros (00.00)
          - `usa_tax_payments_num` integer: Number of US tax payments
          - `usa_tax_payments_sum` string: Amount of US tax payments
          - `venmo_zelle_cashapp_num` integer: Total number of transactions that include terms such as Venmo, Zelle or Cash App
          - `venmo_zelle_cashapp_sum` string: Sum of amounts for Venmo, Zelle and Cash App transactions
          - `withdrawal_count` integer, required: The total number of debit transactions.
          - `withdrawal_sum` string, required: The total monetary value of debits
          - `withdrawals` Transaction[], required: The list of all debits transactions from a bank account.
            - `page_idx` integer, required: The page number of the original document from which this transaction was captured.
            - `bank_account_pk` integer, required: The primary key of the bank account from which this transaction was captured.
            - `amount` string, required: The amount of the credit or debit that this transaction represents. Will be in USD, and can be positive or negative.
            - `bbox` number[], required: The coordinates of the bounding box (i.e. rectangle) on the page from which this transaction was captured. Unit of measurement is in pixels, and the origin (`[0, 0]`) is in the top-left corner. The bounding box is encoded as `[x, y, x+w, y+h]`, where: - `x` is the horizontal position of the box, relative to the left of the page. - `y` is the vertical position of the bounding box, relative to the top of the page. - `w` is the width of the bounding box. - `h` is the height of the bounding box.
            - `txn_date` string, required: The date on which this transaction occurred. Given in `MM/DD/YYYY` format.
            - `page_doc_pk` integer, required: The unique identifier of the page from which this transaction was captured.
            - `pk` integer, required: The unique identifier of this particular transaction.
            - `uploaded_doc_pk` integer, required: The unique identifier of the document from which this transaction was captured.
            - `description` string, required: Details about the transaction that were captured from the original bank statement.
          - `withdrawals_max_by_month` unknown, required
          - `withdrawals_sum_by_month` unknown, required
        - `cash_expense_days_by_month` unknown, required
        - `daily_balances` unknown, required
        - `daily_balances_by_month` unknown, required
        - `daily_balances_weekday` unknown, required
        - `daily_balances_weekday_by_month` unknown, required
        - `deposit_count` integer, required: The total number of credit transactions.
        - `deposit_sum` string, required: Sum of all credit transactions
        - `estimated_daily_expense_by_month` unknown, required
        - `estimated_expense_by_month` unknown, required
        - `estimated_revenue_by_month` object, required: The estimated revenue of the business grouped by calendar month. This is calculated by summing together all credit transactions, then removing all transfer credits (except for wire transfers), all alternative lender credits (except for factoring credits), and all transactions that contain words that signify that they are not revenue deposits. This includes words such as "Refund", "Reversal", "Cash Back", "Return", and about 20 others. Each key is a string representing a month and a year, using the regex `^\d{2}/\d{4}$` (i.e `MM/YYYY`).
        - `mca_payments_by_month` unknown, required
        - `name` string, required: Name of the Book or bank account
        - `negative_balances_by_month` unknown, required
        - `negative_balances_by_month_weekday` unknown, required
        - `pk` integer, required: A unique identifying integer.

## Other responses

- `400`: Client Errors

---

[API](https://skmtc.dev/ocrolus/apis/analyze.md) - [All operations](https://skmtc.dev/ocrolus/apis/analyze/llms.txt) - [OpenAPI document](https://skmtc.dev/ocrolus/apis/analyze/revisions/4ef40f224ab5?raw)