API
Start free trialRaise a request

Book classification summary

get
https://api.ocrolus.com/v2/book//classification-summary

This API retrieved a summary of the classification of all Documents within a 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 [email protected].

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
uuid
required

The unique identifier of the Book whose Documents you'd like to receive classification information on.

Query Params
boolean

When set to true, it enables the following two additional processing behaviors for the Book:

  • Unknown page reassignment: Attempts to reassign pages that could not be classified to a known form type to reduce the number of UNKNOWN forms in the response.
  • Checksum-based duplicate detection: Identifies and flags duplicate forms within the Book using checksum comparison.
Responses

Updated 6 days ago

Language
Credentials
OAuth2
LoadingLoading…
Response
Choose an example:
application/json

Updated 6 days ago