For AI agents: visit https://docs.ocrolus.com/llms.txt for an index of all pages formatted in Markdown and endpoints in OpenAPI. Append .md to any documentation page URL to get its markdown version.
Jump to Content
Home
Guides
Recipes
API
Release notes
Supported documents
FAQs
Start free trial
Raise a request
API
Start free trial
Raise a request
Home
Guides
Recipes
API
Release notes
Supported documents
FAQs
Visualization region
JUMP TO
Ocrolus API
Introduction
HTTP status codes
Ocrolus status codes
API Rate Limit Policy
Authentication
Grant authentication token
post
User Management
Create invitation
post
List invitations
get
List users
get
Book Queries
Book information
get
Book list
get
Book status
get
Book from loan
get
Loan details from Book
get
Book Commands
Create Book
post
Delete Book
post
Update Book
post
File Uploads
Multipart/form-data payloads
Upload PDF to Book
post
Upload Mixed Document PDF to Book
post
Upload Pay stub PDF to Book
post
Upload Image to Book
post
Finalize Image Group
post
Upload aggregator JSON to Book
post
Import Plaid Asset Report
post
File Commands
Cancel document verification
post
Delete document
post
Delete mixed document
post
Download document
get
Upgrade a document
post
Upgrade a mixed document
post
File Queries
Retrieve Mixed Document status
get
Classify
Book classification summary
get
Mixed Doc classification summary
get
Grouped mixed doc classification summary
get
Capture
Book form data
get
Book pay stub data
get
Doc form data
get
Doc pay stub data
get
Form data
get
Pay stub data
get
Transactions
get
Detect
Book-level Fraud Signals
get
Document-Level Fraud Signals
get
Signal visualization
get
Suspicious Activity Flags (Legacy)
get
Object Definitions
Signal analysis
Document analysis
Form analysis
Signal
Visualization
Visualization region
Supporting data
Supporting data values
Analyze
Bank statement income calculator
get
Bank statement income calculator (Excel)
get
Book summary
get
Cash flow features
get
Enriched transactions
get
SMB analytics (Excel)
get
Async job status
get
Risk score
get
Cash Flow Benchmarking (CFB)
get
Loan Inquiry Events
get
Business History
Business identifier
get
Business overview
get
Business transactions
get
Business summary
get
Industry revenue formulas
Create industry revenue formulas
post
Get an industry revenue formula
get
List industry revenue formulas
get
List Ocrolus-suggested revenue formulas
get
Update an industry revenue formula
put
Delete an industry revenue formula
del
Income
Income calculations
get
Income summary
get
Configure income entity
post
Save income guideline
put
Calculate Fannie Mae self-employed income
post
Encore
Create Book copy jobs
post
Retrieve Book copy settings (recipient address Book)
get
Accept Book copy jobs
post
List Book copy jobs
get
Reject Book copy jobs
post
Run automated cash flow kick-outs
post
Tag management
Create tag
post
Retrieve a tag
get
Modify tag
put
Delete tag
del
Retrieve all tags (custom and system tags)
get
Retrieve revenue deduction tags
get
Update revenue deduction tag
put
Override transaction tag
put
Account Level Webhooks
Configure webhook
post
Get webhook configuration
get
Test webhook
get
Configure webhook secret
post
Org Level Webhooks
Add webhook
post
Configure webhook secret
post
Delete webhook
del
List webhooks
get
List webhook events
get
Retrieve webhook
get
Test webhook
post
Update webhook
post
Visualization region
Updated 4 months ago
Visualization
Supporting data
Did this page help you?
Yes
No
Updated 4 months ago
Visualization
Supporting data
Did this page help you?
Yes
No
