---
title: "Book information"
method: GET
path: "/v1/book/info"
tags: ["Book Queries"]
---

# Book information

`GET /v1/book/info`

Retrieve details of a <<glossary:Book>>, including uploaded <<glossary:Document>>s, bank account information, and transaction periods.

## Query parameters

- `book_uuid` string, uuid
- `pk` string

## Response `200`

Success

- object
  - `status` integer — A numerical code that indicates the status of the request.
  - `response` object — An object received from the server that potentially contains data.
    - `name` integer — Name of the <<glossary:Book>> from which information is retrieved.
    - `created` string — A timestamp of when the <<glossary:Book>> was created.
    - `created_ts` string — The timestamp at which <<glossary:Book>> was created.
    - `pk` integer — Unique primary key for the <<glossary:Book>>.
    - `owner_email` string — Name of the owner who has created the <<glossary:Book>>.
    - `is_public` boolean — Indicates if all users in your organization can see and upload <<glossary:Document>>s into this <<glossary:Book>>."
    - `book_uuid` string — Universally unique identifier (UUID) for the <<glossary:Book>>.
    - `id` integer — Unique identifier for the <<glossary:Book>>.
    - `xid` string — A free form field that can be used to associate a Book with some identity outside of Ocrolus.
    - `book_type` string — Determines what type of processing the Book will go through. Options include DEFAULT, OPTIMA, or WIDGET.
    - `is_shared_or_public_book` boolean — Indicates if this <<glossary:Book>> is a public <<glossary:Book>> and can be shared with other users.
    - `docs` array[]
      - unknown[] — An array of all the <<glossary:Document>>s uploaded to the <<glossary:Book>>.
        - unknown
    - `mixed_docs` array[]
      - unknown[] — An array of all the Mixed Documents uploaded to the <<glossary:Book>>. A Mixed Document is a single or multipage PDF that contains more than one doc type. This array is optional and is only returned when the <<glossary:Book>> has Mixed Documents uploaded to it.
        - unknown
    - `bank_accounts` object[] — An array of all the bank accounts present in the <<glossary:Book>> where every key is the bank account pk.
      - `pk` string — A unique integer identifier of the bank account using which the transaction was done.
      - `book_pk` string — A unique integer identifier of the <<glossary:Book>> to which the <<glossary:Document>> is uploaded.
      - `name` integer — Name of the bank account holder.
      - `bank_name` string — Name of the bank.
      - `activity_info` object[] — It displays the start and end period in which transactions have occurred for a given bank account.
        - `active` object[]
          - `start` object[] — It displays the start duration in which transactions have occurred.
            - `year` integer — It displays the start year in which transactions have occurred.
            - `month` integer — It displays the start month in which transactions have occurred.
            - `day` integer — It displays the start day in which transactions have occurred.
          - `end` object[] — It displays the end duration in which transactions have occurred.
            - `year` integer — It displays the end year in which transactions have occurred.
            - `month` integer — It displays the end month in which transactions have occurred.
            - `day` integer — It displays the end day in which transactions have occurred.
        - `missing` object — An array of date ranges when the bank account had no transactional data similarly structured to the active object.
      - `account_type` string — Type of the account from which transactions are retrieved.
      - `account_holder` string — Name of the account holder from which transactions are retrieved.
      - `account_number` string — Account number from which transactions are retrieved.
      - `holder_zip` string — Zip code of the account holder's address.
      - `holder_country` string — Country of the account holder.
      - `holder_state` string — State of the account holder.
      - `holder_city` string — City of the account holder.
      - `holder_address_1` string — The first line address of the account holder.
      - `holder_address_2` string — The second line address of the account holder.
      - `account_category` string — Category of the account.
      - `id` string — Unique id of the bank.
      - `periods` object[] — An array of bank account statement periods.
        - `pk` string — Unique ID of the period from where transactions are retrieved.
        - `uuid` string — Universally unique identification code (uuid) of the period from where transactions are retrieved.
        - `bank_account_pk` integer — A unique integer identifier of the bank account that completed the transaction.
        - `begin_date` string — Start of date of the transction.
        - `end_date` string — End of date of the transction.
        - `begin_balance` string — Starting balance of the transction retrieved.
        - `end_balance` string — Ending balance of the transction retrieved.
        - `primary_recon_error_reason` string — Manual verifier flag for suspicious activity after inspection. If the period is not reconciled, the verifiers will add the predefined values like Potential Fraud, Incomplete Information, and Unreconciled Period.
        - `secondary_recon_error_reason` string — Manual verifier flag for suspicious activity after inspection. If the period is not reconciled, the verifiers will add the predefined values like Incomplete Transaction Data, Invalid Date(s), Photoshopped Data, Missing Period Data, Missing Page(s), Invalid Amount(s) Or Balance(s), and Reconciliation Error Reason Is Not Identified.
        - `uploaded_doc_pk` string — A unique integer of the <<glossary:Document>> from which the transaction details are retrieved.
      - `account_holders` string — Name of the account holder.
      - `custom_filters` object — Filters applied to finetune results for this <<glossary:Book>>.
      - `status_tags` object — An object containing the Status Tags associated with this <<glossary:Book>>
        - `status_tag` object — A Status Tags associated with this <<glossary:Book>>
          - `pk` integer — The unique identifier (primary key) for the Status Tag.
          - `created_ts` string — The timestamp at which Status Tag was created.
          - `tag_name` string — The name assigned to the Status Tag.
          - `color` string — The color assigned to the Status Tag.
          - `text_color` string — An optional color of text assigned to the Status Tag.
          - `is_status_tag` boolean — Defines if the tag is a Status Tag.
          - `is_hidden` string — Determines if the Status Tag should appear in transaction calculations.
          - `org_info_pk` string — The unique identifier (primary key) for the Org that the <<glossary:Book>> is associated with.
          - `config_name` string — The name of the config associated with the Status Tag.
          - `id` integer — The unique identifier (primary key) for the Status Tag.
      - `book_class` string — The processing type of the Book.
  - `message` string — A textual description that indicates details about this response's status.

## Other responses

- `400` — Client Errors

---

[API](https://skmtc.net/ocrolus/apis/user-management.md) · [All operations](https://skmtc.net/ocrolus/apis/user-management/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/ocrolus/user-management/revisions/3571ef602d13/schema)