The API can also process documents uploaded as images as opposed to PDFs. This includes images of bank statements and forms such as pay stubs, ISO applications, and W-2s.

Upload images to Ocrolus

The steps involved are:

• Generate your API credentialsAPI credentials - API Credentials are the API Key and Secret used to authenticate all requests to the API. as described in the Authentication section.
• Create a new BookBook - A Book is a container for all Documents in a Case or Loan Application. This container primarily serves as a boundary to correlate data. As such, objects in different Books can never be associated or correlated with each other. to upload all the bank statements for a given case.
• Upload the image files to the Book. Reference the book_pk from the response of the "create Book" call. This will ensure that the files are organized within the appropriate Book.
  • Mark image group as complete by specifying the appropriate form_type.

📘

Image Formats

We currently support a wide range of image formats including:

• JPEG
• PNG
• BMP
• GIF
• TIFF (Currently we only support single-image TIFF files)

Supported form types include:

• BANK_ACCOUNT
• W2
• W3
• PAYSTUB_01
• ISO_APP
• TAX_940
• TAX_941
• TAX_944
• A_1040_2018
• A_1040_2019
• A_1040_SCHEDULE_C
• A_1040_SCHEDULE_SE
• TAX_1096
• A_1099_MISC
• A_1099_K
• PAYROLL_SUMMARY
• SBA_PPP_APPLICATION
• VOIDED_CHECK
• ID

Setting the form_type to BANK_STATEMENT makes the invocation equivalent to uploading PDF bank statements, while setting it to any other form type makes the invocation equivalent to uploading PDF forms.

Additional form types can be set up for organizations by request. Your Account Manager can explain the form types available for your organization. If you have any questions about form types, email us at [email protected].

🚧

This is not an exhaustive list of all forms. Please contact your Account Manager for a full list of supported forms.

Check for completion

📘

While you can request results at any point, you will only receive data from documents with VERIFICATION_COMPLETE status.

In order to receive results from a case, poll for completion for documents in a Book. In this scenario, poll for Book status. Alternatively, configure a webhook to be notified when a document or Book is complete.

Extract results from Book

To extract the results from a Book:

• Download Transaction listing and/or Analytics (JSON) or Analytics (Excel) for bank statements; and
• Download form data (pay stub, ISO app, W-2, etc.) for all other documents.