---
title: "Book classification summary"
method: GET
path: "/v2/book/{book_uuid}/classification-summary"
tags: ["Classify"]
---

# Book classification summary

`GET /v2/book/{book_uuid}/classification-summary`

## Request

- Base URL: `https://api.ocrolus.com`
- URL: `https://api.ocrolus.com/v2/book/{book_uuid}/classification-summary`
- Auth: OAuth 2
  - Client credentials
  - Token URL: `https://auth.ocrolus.com/oauth/token`

This API retrieved a summary of the classification of all Documents within a <<glossary:Book>>.
  > 📘 About Uniqueness Values (UV)
    > The `uniqueness_values` array is populated only when the UV feature is enabled for your organization.
    > The fields returned within this array vary by form type but remain consistent across all organizations for a given form type. 
    > New UV fields may be added to existing form types over time. To enable this feature, contact your Ocrolus account team reach out to [support@ocrolus.com](mailto:support@ocrolus.com).

## Path parameters

- `book_uuid` string, uuid, required

## Query parameters

- `process_unknowns` boolean

## 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.
    - `book_uuid` string, uuid: Unique identification code of a <<glossary:Book>>.
    - `forms` object[]: An array of forms uploaded to the <<glossary:Book>>.
      - `form_uuid` string, uuid: Unique identification code of a form.
      - `upload_origin` string: Origin of the uploaded form type. The possible values are `MIXED` and `PRE_IDENTIFIED`.
      - `upload_details` object: Details of the uploaded forms.
        - `mixed_doc_uuid` string, uuid: Unique identification code of the uploaded mixed Document. This field is returned in the response only when the `upload_origin` field is set to `MIXED`.
        - `mixed_doc_page_indexes` integer[]: An array of page indexes associated with the Mixed Document. This field is returned in the response only when the `upload_origin` field is set to `MIXED`.
        - `doc_uuid` string, uuid: Unique identification code of the uploaded Document. This field is returned in the response only when the `upload_origin` field is set to `PRE_IDENTIFIED`.
        - `doc_page_indexes` integer[]: An array of page indexes associated with the uploaded Document. This field is returned in the response only when the `upload_origin` field is set to `PRE_IDENTIFIED`.
        - `confidence` string, nullable: The confidence score associated with this document.
      - `status` string: The processing status of the Mixed Document.
      - `rejection_reason` string: An optional attribute that briefly explains why a Document was rejected.
      - `form_type` object: The type of form.
        - `name` string: The name of the form.
        - `account_type` string: Type of account.
        - `account_source` 'STANDARD_STATEMENT' | 'TRANSACTION_SUMMARY' | 'CREDIT_UNION' | 'VOA_PLAID' | 'VOA_BLEND' | 'VOA_FINICITY' | 'VOA_ACCOUNTCHEK' | 'VOA_OTHERS' | 'OTHERS' | 'null', nullable: The source of the bank account data. Only populated for BANK_ACCOUNT form types. It will show `null` for non-bank form types.
        - `display_name` string: Display name of the form.
      - `is_original` boolean, nullable: describes if the uploaded form is original.
      - `form_uuid_duplicate_of` string, nullable: An optional value that represents the original document uuid. It is only present if the provided form is a duplicate of another form.
      - `uniqueness_values` object[]: Classification of the documents is based on the uniqueness values (UV). The fields under this object are displayed only when the UV feature is enabled for you from the backend.
        - `display_name` string: Display name of the attribute.
        - `raw_field_key` string: Unique identifier of the attribute in its raw and unprocessed form.
        - `value` string: Value of the attribute.
        - `confidence` number: The confidence score associated with this field.
  - `message` string: A textual description that indicates details about this response's status.

## Other responses

- `400`: Client Errors
- `500`: Internal server error

---

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