Ocrolus API

{{user.name}}Log In

Ocrolus API Documentation

Welcome to the 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!

HomeGuidesAPI ReferenceReferenceChangelogDiscussionsPage Not FoundSearch{{ state.current().meta.title }}API LogsTutorials

Process Documents with Ocrolus

PDF Bank Statements
PDF Forms
PDF Mixed Documents
Image Groups

Income Verification

Getting Started with Income Verification
Paystub Standard Extraction
Paystub Full Extraction (Beta)

SBA - PPP Forms

Getting Started
SBA Paycheck Protection Program (PPP) Application
Payroll Report
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 (Schedule C)
IRS Form 1040 (Schedule SE)
IRS Form 1096
IRS Form 1099-MISC
IRS Form 1099-K
Voided Check
Identity Verification for PPP

SBA - PPP Loan Forgiveness Forms

Canceled Checks (i.e. Deposited Checks)
Rent Bills
Mortgage Statement
Utility Bill
Lease Agreement
Amortization Schedule
State Quarterly Payroll Report

Monitor Books

Polling For Completion
Retry Strategies

Upload Endpoints

multipart/form-data Payloads

Webhooks

Register Webhook Endpoint
Secure Webhook URLs

Data Types

Composite Types
Simple Types
Code Types

Process Documents with Ocrolus

PDF Bank Statements
PDF Forms
PDF Mixed Documents
Image Groups

Income Verification

Getting Started with Income Verification
Paystub Standard Extraction
Paystub Full Extraction (Beta)

SBA - PPP Forms

Getting Started
SBA Paycheck Protection Program (PPP) Application
Payroll Report
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 (Schedule C)
IRS Form 1040 (Schedule SE)
IRS Form 1096
IRS Form 1099-MISC
IRS Form 1099-K
Voided Check
Identity Verification for PPP

SBA - PPP Loan Forgiveness Forms

Canceled Checks (i.e. Deposited Checks)
Rent Bills
Mortgage Statement
Utility Bill
Lease Agreement
Amortization Schedule
State Quarterly Payroll Report

Monitor Books

Polling For Completion
Retry Strategies

Upload Endpoints

multipart/form-data Payloads

Webhooks

Register Webhook Endpoint
Secure Webhook URLs

Data Types

Composite Types
Simple Types
Code Types

Ocrolus API

Introduction
Endpoint Types
Breaking Change Policy

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

post
Upload PDF to Book
post
Upload Images to Book
- postMark Image Group complete
post
Upload Mixed Document PDF to Book
post
Upload Plaid JSON to Book
post
Import Plaid Asset Report into Book

File Commands

post
Delete a File
post
Cancel File Verification

File Queries

get
Mixed Document Status

Result Commands

post
Async Analytics Request

Result Downloads

get
Transactions
get
Transaction Snippet
get
Analytics (JSON)
get
Analytics (Excel)
get
Async Analytics Result
get
Doc Form Data
get
Book Form Data

Webhook Commands

post
Configure Webhook

Webhook Queries

get
Test Webhook

Simple Types

Simple Types are primitives with additional restrictions relevant to their domain.

Updated about a year ago

Simple Types

Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.

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