v1

latestOpenAPI 3.0.02026-07-2482421001.1 KB

Classify

Grouped mixed doc classification summary

This API returns a classification summary for a mixed document, with forms organized into groups. Each group contains the associated pages and key details such as form type, status, and uniqueness values. Use this API to map pages to their respective forms, review form classifications, distinguish between known forms (such as 1040 and W2) and UNKNOWN forms, and extract key borrower data like SSN or name via uniqueness_values.

📘 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/index/mixed-doc/{mixed_doc_uuid}/summary

Path parameters

mixed_doc_uuidstring uuid required

The unique identifier of the mixed document.

Query parameters

split_unknownsboolean

Controls how UNKNOWN forms are grouped in the response. When set to true, each UNKNOWN form is placed into its own separate form group, allowing you to inspect unclassified pages individually. When set to false (default), all UNKNOWN forms are consolidated into a single form group. This is useful when you need granular visibility into pages that could not be classified.

group_bank_statementsboolean

When set to true, bank statement forms that share a common account holder, bank name, and statement period are automatically grouped together into a single form group to simplify the response structure.

Response

Success

mixed_uploaded_doc_uuidstring uuid

A unique identification code of the Mixed Document.

Example response

{
  "mixed_uploaded_doc_uuid": "5d1e8cef-302f-4594-876a-dec8935dac51",
  "form_groups": [
    {
      "pages": [
        5
      ],
      "forms": [
        {
          "form_uuid": "99911f89-e2a5-482a-b832-d9be94994166",
          "upload_origin": "MIXED",
          "upload_details": {
            "mixed_doc_uuid": "5d1e8cef-302f-4594-876a-dec8935dac51",
            "mixed_doc_page_indexes": [
              5
            ],
            "confidence": "1"
          },
          "status": "COMPLETED",
          "form_type": {
            "name": "A_1040_2023",
            "account_type": "CHECKING",
            "account_source": "STANDARD_STATEMENT",
            "display_name": "1040 (2023)"
          },
          "is_original": true,
          "form_uuid_duplicate_of": "71cb2e19-cf3b-4a1e-91c7-7b1703513491",
          "uniqueness_values": [
            {
              "display_name": "Account Holder",
              "raw_field_key": "bank_account:accountHolder",
              "value": "ALEXANDER HAMILTON",
              "confidence": 1
            }
          ],
          "parent": true
        }
      ]
    }
  ]
}