Ocrolus API

{{user.name}}Log In

Ocrolus API Documentation

Welcome to Ocrolus' API Documentation. You'll find comprehensive guides and documentation here to help you get started with the Ocrolus API. Let's jump right in!

HomeGuidesRecipesAPI ReferenceReferenceRelease NotesDiscussionsPage Not FoundSearch{{ state.current().meta.title }}API Logs

Quick Start Guides

How Ocrolus Works
Getting Started with Bank Statements

Ocrolus API

Introduction
Endpoint Types
Breaking Change Policy
Webhooks
- Secure Webhook URLs
Monitor Books
- Retry Strategies

Product Guides

Classify
Capture
Detect
Analyze

Mortgage

Getting Started in Mortgage
Encompass Integration - Connect
Encompass Integration - Classify
Encompass Integration - Capture

SBA - PPP Forms

Getting Started in SBA - PPP
Identity Verification for PPP
SBA Paycheck Protection Program (PPP) Application

Income Verification

Income Verification with Paystub Capture

Analytics

Getting Started with Cross-Source Validation (XSV)

Third-Party Integrations

Plaid
- Ingesting Plaid JSON Reports
- Importing Plaid Audit Copy Token

Process Documents

Document Classification
PDF Mixed Documents
PDF Bank Statements
PDF Forms
Image Groups

Additional Supported Forms

Amortization Schedule
Canceled Checks (i.e. Deposited Checks)
Disbursement Form
Federal Statements Other Deductions
IRS Form W-2
IRS Form W-3
IRS Form 940
IRS Form 941
IRS Form 944
IRS Form 1040 (2018)
IRS Form 1040 (2019)
IRS Form 1040 (2020)
IRS Form 1040 Schedule 1 (2020)
IRS Form 1040 Schedule C (2020)
IRS Form 1040 Schedule E (2020)
IRS Form 1040 (Schedule SE)
IRS Form 1040 Schedule SE (2020)
IRS Form 1065 (2020)
IRS Form 1065 Schedule K-1 (2019)
IRS Form 1065 Schedule K-1 (2020)
IRS Form 1065 Schedules L and M-1 (2020)
IRS Form 1096
IRS Form 1099-K
IRS Form 1099-MISC
IRS Form 1120 (2020)
IRS Form 1120 Schedules L and M-1 (2020)
IRS Form 1120S (2020)
IRS Form 1120S Schedule K-1 (2020)
IRS Form 1120S Schedules L and M-1 (2020)
IRS Form 1125-A
Invoices & Receipts
Lease Agreement
Mortgage Statement
Payroll Report
Utility Bill
Rent Bills
State Quarterly Payroll Report
Voided Check

Data Types

Composite Types
Simple Types
Code Types

Quick Start Guides

How Ocrolus Works
Getting Started with Bank Statements

Ocrolus API

Introduction
Endpoint Types
Breaking Change Policy
Webhooks
- Secure Webhook URLs
Monitor Books
- Retry Strategies

Product Guides

Classify
Capture
Detect
Analyze

Mortgage

Getting Started in Mortgage
Encompass Integration - Connect
Encompass Integration - Classify
Encompass Integration - Capture

SBA - PPP Forms

Getting Started in SBA - PPP
Identity Verification for PPP
SBA Paycheck Protection Program (PPP) Application

Income Verification

Income Verification with Paystub Capture

Analytics

Getting Started with Cross-Source Validation (XSV)

Third-Party Integrations

Plaid
- Ingesting Plaid JSON Reports
- Importing Plaid Audit Copy Token

Process Documents

Document Classification
PDF Mixed Documents
PDF Bank Statements
PDF Forms
Image Groups

Additional Supported Forms

Amortization Schedule
Canceled Checks (i.e. Deposited Checks)
Disbursement Form
Federal Statements Other Deductions
IRS Form W-2
IRS Form W-3
IRS Form 940
IRS Form 941
IRS Form 944
IRS Form 1040 (2018)
IRS Form 1040 (2019)
IRS Form 1040 (2020)
IRS Form 1040 Schedule 1 (2020)
IRS Form 1040 Schedule C (2020)
IRS Form 1040 Schedule E (2020)
IRS Form 1040 (Schedule SE)
IRS Form 1040 Schedule SE (2020)
IRS Form 1065 (2020)
IRS Form 1065 Schedule K-1 (2019)
IRS Form 1065 Schedule K-1 (2020)
IRS Form 1065 Schedules L and M-1 (2020)
IRS Form 1096
IRS Form 1099-K
IRS Form 1099-MISC
IRS Form 1120 (2020)
IRS Form 1120 Schedules L and M-1 (2020)
IRS Form 1120S (2020)
IRS Form 1120S Schedule K-1 (2020)
IRS Form 1120S Schedules L and M-1 (2020)
IRS Form 1125-A
Invoices & Receipts
Lease Agreement
Mortgage Statement
Payroll Report
Utility Bill
Rent Bills
State Quarterly Payroll Report
Voided Check

Data Types

Composite Types
Simple Types
Code Types

Book Commands

post
Create New Book
post
Delete a Book
post
Update Book Authorization

Book Queries

get
Book List/Search
get
Book Status
get
Book Information

File Uploads

Uploading with multipart/form-data Payloads
post
Upload PDF to Book
post
Upload Images to Book
- post
  Mark Image Group complete
post
Upload Mixed Document PDF to Book
post
Upload Plaid JSON to Book
post
Import Plaid Asset Report into Book
post
Upload Paystub PDF to Book
post
Upload Mixed Document PDF to Book

File Commands

post
Delete a File
post
Cancel File Verification

File Queries

get
Mixed Document Status

Classify

get
Book Classification Summary
get
Mixed Doc Classification Summary

Capture

get
Doc Form Data
get
Doc Paystub Data
get
Book Form Data
get
Book Paystub Data
get
Transactions

Detect

get
Suspicious Activity Flags

Analyze

get
Analytics (JSON)
get
Analytics (Excel)
post
Async Analytics Request
get
Async Analytics Result
get
Cross Source Validation
get
Paystub Income
get
Traditionally Employed Income

Webhook Commands

post
Configure Webhook

Webhook Queries

get
Test Webhook

Powered by

We’re currently having some issues with our infrastructure. Please check back soon to see if this has been resolved. Learn more