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!

Payoff Statement

Payoff Statement documents a mortgage principal paydown/payoff as is issued by the lender.

The form_type parameter PAYOFF_STATEMENT for the Upload PDF endpoint is required for this Form Type.

Optional fields captured

Field data attributed directly to a Payoff Statement is captured as Form Data objects, each one keyed off the following attribute names.

πŸ“˜

Configuration-Driven Output

All fields below are optionally captured, depending on your order form. To adjust fields captured, please speak with your Ocrolus Account Manager.

JSON Attribute

Data Type

Description

payoff_statement-General:payoffDate

Date

Payoff Date

payoff_statement-General:payoffAmount

Money

Payoff Amount

payoff_statement-General:borrowerName

Text

Borrower's Name

payoff_statement-General:co-borrowerName

Text

Co-Borrower's Name

payoff_statement-General:lenderCompanyName

Text

Lender's Name

payoff_statement-General:propertyAddress

Text

Property / Collateral Address

Updated about a month ago


Payoff Statement


Suggested Edits are limited on API Reference Pages

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