v1

latestOpenAPI 3.0.02026-07-2482421001.1 KB

Classify

Mixed Doc classification summary

This API retrieves a summary of the classification of all Documents within a Mixed <glossary:Document>.

📘 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 or reach out to support@ocrolus.com.

get/v2/mixed-document/{mixed_doc_uuid}/classification-summary

Path parameters

mixed_doc_uuidstring uuid required

The unique identifier of the Mixed Document you'd like to receive classification information on.

Query parameters

process_unknownsboolean

Enables duplicate form detection and unknown page reassignment when set to true. When enabled, each form item in the response includes two additional fields, is_original to indicate if the form is original or a duplicate, and form_uuid_duplicate_of to reference the original form UUID if a duplicate is detected.

Response

Success

statusinteger

A numerical code that indicates the status of the request.

messagestring

A textual description that indicates details about this response's status.

Example response

{
  "status": 200,
  "response": {
    "mixed_doc_uuid": "b41ca80c-a4d1-4373-9329-90e7e5aba92d",
    "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
          ]
        },
        "status": "CLASSIFIED",
        "form_type": {
          "name": "TAX_940",
          "account_type": "CHECKING",
          "account_source": "STANDARD_STATEMENT",
          "display_name": "TAX_940"
        },
        "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": "BANK OF AMERICA",
            "confidence": 1
          }
        ]
      }
    ]
  },
  "message": "OK"
}