Document Analysis

Overview

Model Name: DocumentAnalysis

Represents signal analysis for a particular Document within a Book.

Properties

uploaded_doc_uuid

Type
UUID (uuid)
Required
true

The unique identifier of the uploaded document.

uploaded_doc_type

Type
String
Required
true

The type of the uploaded document. We currently only support signal analysis on the types that are listed here.

Possible Values

  • BANK_STATEMENT
  • PAYSTUB
  • FORM

mixed_uploaded_doc_uuid

Type
UUID (uuid) (or null)
Required
false

The unique identifier of the mixed document that this object represents. This field will be null if this was not a mixed document.

detect_status

Type
String
Required
true

The current state of this document in our processing pipeline. The statuses are as follows:

  • PENDING: This document is still being processed, and no results are available yet. Check back later.
  • COMPLETED: This document has been completely processed, and complete results are enclosed.
  • UNABLE_TO_PROCESS: This document could not be processed, most likely because it's of an unsupported type.

Possible Values

  • PENDING
  • COMPLETED
  • UNABLE_TO_PROCESS

form_analysis

Type
List of FormAnalysis objects
Required
true
Min. Item Count
1

Analysis results on each form in this document. Each object represents a different form.