Ocrolus API

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!

Getting Started with Cross-Source Validation (XSV)

What is XSV?

XSV automatically compares data extracted from multiple documents or data sources to verify that the information provided is logical and correct.

Currently Available Rulesets

Mortgage Application

Purpose: This ruleset is designed to provide basic cross-source validation for a mortgage application book.

Included Rules:

  • Applicant Name Match: All Forms. This rule compares the applicant(s) name across all documents in the book. The rule will return either "no match," "exact match," or a confidence level of "low," "medium," or "high," to describe the likelihood of the names on the various documents matching.
  • Applicant Name Match: Paystubs and Bank Statements. This rule compares the applicant(s) name on paystubs and bank statements. The rule will return either "no match," "exact match," or a confidence level of "low," "medium," or "high," to describe the likelihood of the names on the various documents matching.
  • Applicant Name Match: Paystubs and W-2s. This rule compares the applicant(s) name on paystubs and W-2s. The rule will return either "no match," "exact match," or a confidence level of "low," "medium," or "high," to describe the likelihood of the names on the various documents matching.
  • Applicant Net Pay Match: Paystubs and Bank Statement. This rule attempts to find deposit transactions for the applicant(s) paystubs within the available bank statements. It reviews the date, the transaction amount (net pay), and the transaction description. The rule will return either "no match," "exact match," or a confidence level of "low," "medium," or "high," to describe the likelihood of the given pay deposit being found in the bank statement.
  • Applicant Gross Pay Match: Paystubs and W-2s. This rule reviews the gross pay found on paystubs, extrapolates the gross pay to an annual gross pay amount, and compares that amount against the applicant(s) most recent W-2 in the book. The rule will return either "no match," "exact match," or a confidence level of "low," "medium," or "high," to describe the likelihood of the gross pay amount making sense when reviewing the income amounts shown on the W-2.

Prerequisites

XSV can only be run against validated books.

How to Get Started

Once you have a book loaded and verified, see https://docs.ocrolus.com/reference/cross-source-validation for instructions on executing XSV on your book.

Updated about a month ago

Getting Started with Cross-Source Validation (XSV)


Suggested Edits are limited on API Reference Pages

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