PDF forms

The Ocrolus API processes a variety of documents beyond bank statements. These documents, referred to as forms, include but are not limited to:

• Pay stubs
• Merchant loan applications
• IRS tax documents, such as:
  • IRS Form W-2
  • IRS Form 1040 (2018), (2019), (2020), (2021), (2022), and (2023)
  • IRS Form 1040 Schedule C (2018), (2019), (2020), (2021), (2022), and (2023)
  • IRS Form 1040 Schedule SE (2018), (2019), (2020), (2021), (2022), and (2023)
  • IRS Form 1099-Misc
  • IRS Form 1099-K
• Voided checks
• Identity verification documents

Upload PDF forms

To upload PDF forms using Ocrolus API, perform the following steps:

1. Generate your API credentials as described in the Authentication section.
2. Create a new Book to upload all the documents for a given case. Save the book_uuid or Book pk for later use.
3. Upload the input file to the Book using the Upload PDF file endpoint. Use the book_uuid or Book pk from the response of create Book API while invoking the upload call to ensure the documents are added within the intended Book.
4. Retrieve the document's classification results using the Book classification summary endpoint.

The form_type parameter for the Upload PDF endpoint is optional. For any other form type or blank parameter, it is equivalent to uploading PDF forms. For a complete list of supported document types, see all supported documents.

Additional form types can be configured for your organization upon request. Your Account Manager can provide details on the form types available for your organization. For any inquiries regarding form types, feel free to email us at [email protected].

Check for completion

To receive the complete results for a case, poll for completion for the Book. Alternatively, we recommend registering for webhook notifications, which lets you know exactly when a document has completed processing.

📘

Note

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

Extract results from Book

Once processed, forms produce JSON results comprising, form data (pay stub, ISO app, W-2, 1040, etc.). To extract the results from a Book, download form Data (pay stub, ISO app, W-2, 1040, etc.) in JSON format.