Jump to Content
Ocrolus API
HomeGuidesAPIRelease notesSupported documents
Ocrolus.comStart free trialOcrolus API
Ocrolus.comStart free trial
HomeGuidesAPIRelease notesSupported documents

Quick Start Guides

  • How Ocrolus works
  • Getting started with bank statements
  • Getting started in mortgage
  • Getting started with SMB lending
  • Getting started with consumer lending

Ocrolus API

  • Introduction
    • Definitions
  • Authentication
    • Creating and managing credentials
    • Using API credentials
    • Exploring Ocrolus with postman
    • Migrating from basic authentication to OAuth 2.0 credentials
  • Endpoint types
    • Command
    • Upload
    • Query
    • Download
  • Breaking change policy
  • Monitor books
    • Retry strategies
  • IP address allowlist
  • API status
  • 🚧 OPTIMA

Webhooks

  • Overview
  • Account-level webhooks
  • Organization-level webhooks
    • Configure and manage
  • Secure webhook URLs

Product Guides

  • Classify
    • PDF mixed documents
    • Image groups
    • PDF forms
    • Classify supported document types
    • Uniqueness Values (UV)
  • Capture
    • Confidence score
  • Detect
    • Authenticity score
    • Understanding signals
    • Suspicious activity flags (Legacy)
  • Analyze
    • Cash Flow Analytics
    • Bank statement analytics (legacy)
    • Bank statement Income calculator
    • Risk Score
  • Instant
  • Widget (beta)

Third-Party Integrations

  • Encompass
    • Setting up Encompass Support
    • Classify
    • Partner Connect Ocrolus Product Setup
    • Standard Classify Mappings
    • Analyze
    • Offboarding
  • Plaid
    • Ingesting Plaid JSON reports
    • Importing Plaid audit copy token

supported documents

  • Getting started with supported documents
  • All supported documents
  • Assets
    • Bank Statements
    • Brokerage Statement
  • Identification
    • H-1B - Non-Immigrant Employment Visa
    • Passport
    • Passport Card
    • Permanent Resident Card
    • Social Security Card
    • State ID
    • US Driver's License
    • Birth Certificate
    • Utility Bill
    • Voided Check
  • Income/Employment
    • Disability Award Letter
    • IRS Form SSA-1099 - Social Security Benefit Statement
    • Pay Stub
    • Pension Award Letter
    • Profit and Loss Statement
    • Social Security Award Letter
    • VOE (1005) - Request for Verification of Employment
    • VOE (generic) - Verification of Employment Report
    • VOE (work number) - The Work Number Verification of Employment Report
    • Balance Sheet
    • Veterans Affairs (VA) Award Letter
  • Legal
    • Car Loan Deed
    • Court Judgment
    • Court Order
    • Deed in Lieu of Foreclosure
    • Foreclosure Notice
    • Loan Agreement
    • Release of Judgment or Lien
    • Solar Panel Lease Agreement
    • Solar Panel Loan Agreement
    • Wage Garnishment Order
  • Mortgage specific forms
    • 1003 (2009) - Uniform Residential Loan Application
    • 1003 (2020) - Uniform Residential Loan Application
    • 1003 (2020) - Uniform Residential Loan Application (Additional Borrower)
    • 1003 (2020) - Uniform Residential Loan Application (Lender Loan Information)
    • 1008 (2009) - Uniform Underwriting and Transmittal Summary
    • 1008 (2018) - Uniform Underwriting and Transmittal Summary
    • Closing Disclosure
    • Flood Elevation Certificate
    • Gift Letter
    • IRS Form 4506-C - IVES Request for Transcript of Tax Return
    • IRS Form 4506-T - Request for Transcript of Tax Return
    • Loan Estimate
    • Mortgage Note
    • Title Insurance Policy
    • VA Certificate of Eligibility
    • Wiring Instructions
    • Borrower Certification and Authorization
    • CAIVRS Authorization
    • Closing Protection Letter
    • Divorce Decree
    • FHA Case Number Assignment
    • Mortgage Insurance Certificate
    • Pre-Approval Letter
    • Private Mortgage Payment
  • Other
    • Auto Loan Statement
    • Child Care Payment
    • Credit Card Statement
    • Credit Report
    • Deposited Checks
    • ISO Application
    • Letter from the Payor (Alimony or Child Support)
    • Life Insurance Payment
    • Rental Housing Payment
    • Solar Panel Payment Receipt
    • Stock Purchase Plan Payment
    • Student Loan Statement
    • Wire Remittance Statement
  • Property
    • Purchase Contract
    • Homeowner Insurance Policy - Insurance Binder
    • Residential Lease Agreement
    • Mortgage Statement
    • Payoff Letter
    • Preliminary Title Report
    • Property Tax Bill
    • 1004 - Uniform Residential Appraisal Report
    • 1032 - One-Unit Residential Appraisal Field Review Report
    • Appraisal Notice
    • Final Inspection
  • Tax forms
    • 1040-SR (2019) - U.S. Tax Return for Seniors
    • 1040-SR (2020) - U.S. Tax Return for Seniors
    • 1040-SR (2021) - U.S. Tax Return for Seniors
    • 1040-SR (2022) - U.S. Tax Return for Seniors
    • 4835 (2022) - Farm Rental Income and Expenses
    • 940 - Employer’s Annual Federal Unemployment (FUTA) Tax Return
    • 940-V - Payment Voucher
    • 941 - Employer’s QUARTERLY Federal Tax Return
    • 941-V - Payment Voucher
    • 941-X - Adjusted Employer’s QUARTERLY Federal Tax Return or Claim for Refund
    • IRS Form 1040 (2018) - U.S. Individual Income Tax Return
    • IRS Form 1040 (2019) - U.S. Individual Income Tax Return
    • IRS Form 1040 (2020) - U.S. Individual Income Tax Return
    • IRS Form 1040 (2021) - U.S. Individual Income Tax Return
    • IRS Form 1040 (2022) - U.S. Individual Income Tax Return
    • IRS Form 1040 Schedule 1 (2018) - Additional Income and Adjustments to Income
    • IRS Form 1040 Schedule 1 (2019) - Additional Income and Adjustments to Income
    • IRS Form 1040 Schedule 1 (2020) - Additional Income and Adjustments to Income
    • IRS Form 1040 Schedule 1 (2021) - Additional Income and Adjustments to Income
    • IRS Form 1040 Schedule 1 (2022) - Additional Income and Adjustments to Income
    • IRS Form 1040 Schedule 2 (2018) - Additional Taxes
    • IRS Form 1040 Schedule 2 (2019) - Additional Taxes
    • IRS Form 1040 Schedule 2 (2020) - Additional Taxes
    • IRS Form 1040 Schedule 2 (2021) - Additional Taxes
    • IRS Form 1040 Schedule 2 (2022) - Additional Taxes
    • IRS Form 1040 Schedule 3 (2018) - Nonrefundable Credits
    • IRS Form 1040 Schedule 3 (2019) - Additional Credits and Payments
    • IRS Form 1040 Schedule 3 (2020) - Additional Credits and Payments
    • IRS Form 1040 Schedule 3 (2021) - Additional Credits and Payments
    • IRS Form 1040 Schedule 3 (2022) - Additional Credits and Payments
    • IRS Form 1040 Schedule 4 (2018) - Other Taxes
    • IRS Form 1040 Schedule 5 (2018) - Other Payments and Refundable Credits
    • IRS Form 1040 Schedule 6 (2018) - Foreign Address and Third Party Designee
    • IRS Form 1040 Schedule 8812 (2018) - Additional Child Tax Credit
    • IRS Form 1040 Schedule 8812 (2019) - Additional Child Tax Credit
    • IRS Form 1040 Schedule 8812 (2020) - Additional Child Tax Credit
    • IRS Form 1040 Schedule 8812 (2021) - Credits for Qualifying Children and Other Dependents
    • IRS Form 1040 Schedule 8812 (2022) - Credits for Qualifying Children and Other Dependents
    • IRS Form 1040 Schedule A (2018) - Itemized Deductions
    • IRS Form 1040 Schedule A (2019) - Itemized Deductions
    • IRS Form 1040 Schedule A (2020) - Itemized Deductions
    • IRS Form 1040 Schedule A (2021) - Itemized Deductions
    • IRS Form 1040 Schedule A (2022) - Itemized Deductions
    • IRS Form 1040 Schedule B (2018) - Interest and Ordinary Dividends
    • IRS Form 1040 Schedule B (2019) - Interest and Ordinary Dividends
    • IRS Form 1040 Schedule B (2020) - Interest and Ordinary Dividends
    • IRS Form 1040 Schedule B (2021) - Interest and Ordinary Dividends
    • IRS Form 1040 Schedule B (2022) - Interest and Ordinary Dividends
    • IRS Form 1040 Schedule C (2018) - Profit or Loss From Business
    • IRS Form 1040 Schedule C (2019) - Profit or Loss From Business
    • IRS Form 1040 Schedule C (2020) - Profit or Loss From Business
    • IRS Form 1040 Schedule C (2021) - Profit or Loss From Business
    • IRS Form 1040 Schedule C (2022) - Profit or Loss From Business
    • IRS Form 1040 Schedule C-EZ (2018) - Net Profit From Business
    • IRS Form 1040 Schedule D (2018) - Capital Gains and Losses
    • IRS Form 1040 Schedule D (2019) - Capital Gains and Losses
    • IRS Form 1040 Schedule D (2020) - Capital Gains and Losses
    • IRS Form 1040 Schedule D (2021) - Capital Gains and Losses
    • IRS Form 1040 Schedule D (2022) - Capital Gains and Losses
    • IRS Form 1040 Schedule E (2018) - Supplemental Income and Loss
    • IRS Form 1040 Schedule E (2019) - Supplemental Income and Loss
    • IRS Form 1040 Schedule E (2020) - Supplemental Income and Loss
    • IRS Form 1040 Schedule E (2021) - Supplemental Income and Loss
    • IRS Form 1040 Schedule E (2022) - Supplemental Income and Loss
    • IRS Form 1040 Schedule EIC (2018) - Earned Income Credit
    • IRS Form 1040 Schedule EIC (2019) - Earned Income Credit
    • IRS Form 1040 Schedule EIC (2020) - Earned Income Credit
    • IRS Form 1040 Schedule EIC (2021) - Earned Income Credit
    • IRS Form 1040 Schedule EIC (2022) - Earned Income Credit
    • IRS Form 1040 Schedule F (2018) - Profit or Loss From Farming
    • IRS Form 1040 Schedule F (2019) - Profit or Loss From Farming
    • IRS Form 1040 Schedule F (2020) - Profit or Loss From Farming
    • IRS Form 1040 Schedule F (2021) - Profit or Loss From Farming
    • IRS Form 1040 Schedule F (2022) - Profit or Loss From Farming
    • IRS Form 1040 Schedule H (2018) - Household Employment Taxes
    • IRS Form 1040 Schedule H (2019) - Household Employment Taxes
    • IRS Form 1040 Schedule H (2020) - Household Employment Taxes
    • IRS Form 1040 Schedule H (2021) - Household Employment Taxes
    • IRS Form 1040 Schedule H (2022) - Household Employment Taxes
    • IRS Form 1040 Schedule J (2018) - Income Averaging for Farmers and Fishermen
    • IRS Form 1040 Schedule J (2019) - Income Averaging for Farmers and Fishermen
    • IRS Form 1040 Schedule J (2020) - Income Averaging for Farmers and Fishermen
    • IRS Form 1040 Schedule J (2021) - Income Averaging for Farmers and Fishermen
    • IRS Form 1040 Schedule J (2022) - Income Averaging for Farmers and Fishermen
    • IRS Form 1040 Schedule LEP - Request for Change in Language Preference
    • IRS Form 1040 Schedule R (2018) - Credit for the Elderly or the Disabled
    • IRS Form 1040 Schedule R (2019) - Credit for the Elderly or the Disabled
    • IRS Form 1040 Schedule R (2020) - Credit for the Elderly or the Disabled
    • IRS Form 1040 Schedule R (2021) - Credit for the Elderly or the Disabled
    • IRS Form 1040 Schedule R (2022) - Credit for the Elderly or the Disabled
    • IRS Form 1040 Schedule SE (2018) - Self-Employment Tax
    • IRS Form 1040 Schedule SE (2019) - Self-Employment Tax
    • IRS Form 1040 Schedule SE (2020)
    • IRS Form 1040 Schedule SE (2021) - Self-Employment Tax
    • IRS Form 1040 Schedule SE (2022) - Self-Employment Tax
    • IRS Form 1040-X - Amended U.S. Individual Income Tax Return
    • IRS Form 1065 (2018) - U.S. Return of Partnership Income
    • IRS Form 1065 (2019) - U.S. Return of Partnership Income
    • IRS Form 1065 (2020) - U.S. Return of Partnership Income
    • IRS Form 1065 (2021) - U.S. Return of Partnership Income
    • IRS Form 1065 (2022) - U.S. Return of Partnership Income
    • IRS Form 1065 Schedule K-1 (2018) - Partner’s Share of Income, Deductions, Credits, etc.
    • IRS Form 1065 Schedule K-1 (2019) - Partner’s Share of Income, Deductions, Credits, etc.
    • IRS Form 1065 Schedule K-1 (2020) - Partner’s Share of Income, Deductions, Credits, etc.
    • IRS Form 1065 Schedule K-1 (2021) - Partner’s Share of Income, Deductions, Credits, etc.
    • IRS Form 1065 Schedule K-1 (2022) - Partner’s Share of Income, Deductions, Credits, etc.
    • IRS Form 1065 Schedules L, M-1, and M-2 (2018) - Balance Sheets (L), Income Reconciliation(M-1), and Analysis (M-2) of Partnership Income
    • IRS Form 1065 Schedules L, M-1, and M-2 (2019) - Balance Sheets (L), Income Reconciliation(M-1), and Analysis (M-2) of Partnership Income
    • IRS Form 1065 Schedules L, M-1, and M-2 (2020) - Balance Sheets (L), Income Reconciliation(M-1), and Analysis (M-2) of Partnership Income
    • IRS Form 1065 Schedules L, M-1, and M-2 (2021) - Balance Sheets (L), Income Reconciliation(M-1), and Analysis (M-2) of Partnership Income
    • IRS Form 1065 Schedules L, M-1, and M-2 (2022) - Balance Sheets (L), Income Reconciliation(M-1), and Analysis (M-2) of Partnership Income
    • IRS Form 1096 - Annual Summary and Transmittal of U.S. Information Returns
    • IRS Form 1099-G - Certain Government Payments
    • IRS Form 1099-INT - Interest income
    • IRS Form 1099-K - Payment Card and Third Party Network Transactions
    • IRS Form 1099-MISC - Miscellaneous Information
    • 1099-NEC - Nonemployee Compensation
    • IRS Form 1099-R - Distributions from Pensions, Annuities, Retirement or Profit-Sharing Plans, IRAs, Insurance Contracts, etc.
    • IRS Form 1120 (2018) - U.S. Corporation Income Tax Return
    • IRS Form 1120 (2019) - U.S. Corporation Income Tax Return
    • IRS Form 1120 (2020) - U.S. Corporation Income Tax Return
    • IRS Form 1120 (2021) - U.S. Corporation Income Tax Return
    • IRS Form 1120 (2022) - U.S. Corporation Income Tax Return
    • IRS Form 1120 Schedule G - Information on Certain Persons Owning the Corporation’s Voting Stock
    • IRS Form 1120 Schedules L, M-1, and M-2 (2018) - Balance Sheet (L), Income Reconciliation (M-1), and Analysis (M-2) of Corporation's Income Report
    • IRS Form 1120 Schedules L, M-1, and M-2 (2019) - Balance Sheet (L), Income Reconciliation (M-1), and Analysis (M-2) of Corporation's Income Report
    • IRS Form 1120 Schedules L, M-1, and M-2 (2020) - Balance Sheet (L), Income Reconciliation (M-1), and Analysis (M-2) of Corporation's Income Report
    • IRS Form 1120 Schedules L, M-1, and M-2 (2021) - Balance Sheet (L), Income Reconciliation (M-1), and Analysis (M-2) of Corporation's Income Report
    • IRS Form 1120 Schedules L, M-1, and M-2 (2022) - Balance Sheet (L), Income Reconciliation (M-1), and Analysis (M-2) of Corporation's Income Report
    • IRS Form 1120S (2018) - U.S. Income Tax Return for an S Corporation
    • IRS Form 1120S (2019) - U.S. Income Tax Return for an S Corporation
    • IRS Form 1120S (2020) - U.S. Income Tax Return for an S Corporation
    • IRS Form 1120S (2021) - U.S. Income Tax Return for an S Corporation
    • IRS Form 1120S (2022) - U.S. Income Tax Return for an S Corporation
    • IRS Form 1120S Schedule K-1 (2018) - Shareholder’s Share of Income, Deductions, Credits, etc.
    • IRS Form 1120S Schedule K-1 (2019) - Shareholder’s Share of Income, Deductions, Credits, etc.
    • IRS Form 1120S Schedule K-1 (2020) - Shareholder’s Share of Income, Deductions, Credits, etc.
    • IRS Form 1120S Schedule K-1 (2021) - Shareholder’s Share of Income, Deductions, Credits, etc.
    • IRS Form 1120S Schedule K-1 (2022) - Shareholder’s Share of Income, Deductions, Credits, etc.
    • IRS Form 1120S Schedules L, M-1, and M-2 (2018) - Balance Sheet (L), Income Reconciliation (M-1), and Analysis (M-2) of S Corporation's Financial Activity Report
    • IRS Form 1120S Schedules L, M-1, and M-2 (2019) - Balance Sheet (L), Income Reconciliation (M-1), and Analysis (M-2) of S Corporation's Financial Activity Report
    • IRS Form 1120S Schedules L, M-1, and M-2 (2020) - Balance Sheet (L), Income Reconciliation (M-1), and Analysis (M-2) of S Corporation's Financial Activity Report
    • IRS Form 1120S Schedules L, M-1, and M-2 (2021) - Balance Sheet (L), Income Reconciliation (M-1), and Analysis (M-2) of S Corporation's Financial Activity Report
    • IRS Form 1120S Schedules L, M-1, and M-2 (2022) - Balance Sheet (L), Income Reconciliation (M-1), and Analysis (M-2) of S Corporation's Financial Activity Report
    • IRS Form 1125-E - Compensation of Officers
    • IRS Form W-2 - Wage and Tax State
    • IRS 8825 - Rental Real Estate Income and Expenses of a Partnership or an S Corporation
    • W9 - Request for Taxpayer Identification Number and Certification

Data Types

  • Composite types
    • Transactions
    • Document
    • Bank account
    • Period
    • Form data
    • Table
    • Consumer analytics
  • Simple types
    • Bounding box
    • Money
    • Date
    • Month map
    • Month ref
    • Date map
  • Code types
    • Bank account category
    • Bank account type
    • Book status
    • Document status
    • Extra fields
    • Rejection reasons
    • Suspicious activity flags

Period

Suggest Edits

{

AttributeData typeDescription
pkPK
bank_account_pkBank Account PK
uploaded_doc_pkDocument PK
begin_dateDate
end_dateDate
begin_balanceMoney
end_balanceMoney
primary_recon_error_reasonsecondary_recon_error_reasonSuspicious Activity Flags

}

Updated about 1 month ago


Ocrolus
  • linkedin
  • twitter
  • facebook
  • youtube
  • Home
  • Guides
  • API
  • Supported documents
  • Release notes

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