v1
latestOpenAPI 3.0.02026-07-2482421001.1 KBClassify
Book classification summary
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.
get/v2/book/{book_uuid}/classification-summary
Path parameters
book_uuidstring uuid required
The unique identifier of the <glossary:Book> whose Documents you'd like to receive classification information on.
Query parameters
process_unknownsboolean
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.
Response
Success
Example response
{
"status": 200,
"response": {
"forms": [
{
"form_uuid": "71cb2e19-cf3b-4a1e-91c7-7b1703513491",
"upload_origin": "MIXED",
"upload_details": {
"mixed_doc_uuid": "b41ca80c-a4d1-4373-9329-90e7e5aba92d",
"mixed_doc_page_indexes": [
16
],
"doc_uuid": "b41ca80c-a4d1-4373-9329-90e7e5aba92d",
"doc_page_indexes": [
16
]
},
"status": "CLASSIFIED",
"form_type": {
"name": "TAX_940",
"account_type": "CHECKING",
"account_source": "STANDARD_STATEMENT",
"display_name": "TAX_940"
},
"uniqueness_values": [
{
"display_name": "Account Holder",
"raw_field_key": "bank_account:accountHolder",
"value": "BANK OF AMERICA"
}
]
}
]
},
"message": "OK"
}