Jump to Content

Home Guides Recipes API Release notes Supported documents

Ocrolus.com Start free trial Raise a request

API

Ocrolus.com Start free trial Raise a request

Home Guides Recipes API Release notes Supported documents

Ocrolus API

Introduction
HTTP status codes
Ocrolus status codes
API Rate Limit Policy

Authentication

Grant authentication tokenpost

Book Commands

Create a Bookpost
Delete a Bookpost
Update a Bookpost

Book Queries

Book informationget
Book listget
Book statusget

File Uploads

Multipart/form-data payloads
Upload PDF to Bookpost
Upload Mixed Document PDF to Bookpost
Upload Pay stub PDF to Bookpost
Upload Image to Bookpost
Finalize Image Grouppost
Upload Plaid JSON to Bookpost
Import Plaid Asset Reportpost

File Commands

Cancel Document verificationpost
Delete a Documentpost
Download a Documentget
Update a Documentpost
Update a Mixed Documentpost

File Queries

Retrieve Mixed Document statusget

Classify

Book classification summaryget
Mixed Doc classification summaryget

Capture

Book form dataget
Book pay stub dataget
Doc form dataget
Doc pay stub dataget
Form dataget
Pay stub dataget
Transactionsget

Detect

Book-level Fraud Signalsget
Document-Level Fraud Signalsget
Signal visualizationget
Suspicious Activity Flags (Legacy)get
Business Verification
Object Definitions

Analyze

Bank Statement Income Calculatorget
Bank Statement Income Calculator (Excel)get
Book summaryget
Cash Flow Featuresget
Enriched transactionsget
SMB Analytics (Excel)get
Risk Scoreget

Account Level Webhooks

Configure webhookpost
Get webhook configurationget
Test webhookget

Org Level Webhooks

Add a webhookpost
Delete a webhookdelete
List webhooksget
List events for a webhookget
Retrieve a webhookget
Test a webhookpost
Update a webhookpost

Update a Book

post https://api.ocrolus.com/v1/book/update

Configure various properties of a Book.

Language

Credentials

OAuth2

Bearer

Home
Guides
API
Supported documents
Release notes

Ocrolus © 2025. All rights reserved. Legal | Privacy Policy