Ocrolus API

Ocrolus API Documentation

Welcome to the 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!

Mortgage Statement

Mortgage Interest Statements (i.e. mortgage statements) are issued by a lender to a borrower. These statements contain information regarding payment terms, interest rate, property information, and principal and interest due for a given period.

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

Optional fields captured

📘

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

mortgage_statement-part1:propertyAddress:addressLine1

Text

Address of the property

mortgage_statement-part1:propertyAddress:addressLine2

Text

Address of the property

mortgage_statement-part1:propertyAddress:city

Text

City in which the property resides

mortgage_statement-part1:propertyAddress:state

Text

State in which the property resides

mortgage_statement-part1:propertyAddress:zip

Text

Formatted 5 digit zip code. Zip in which the property is located

mortgage_statement-part1:accountNumber

Text

Account Number of the entity with the mortgage

mortgage_statement-part1:statementDate

Date

Date the mortage statement was issued

mortgage_statement-part1:currentBalance

Money

Current oustanding mortgage balance

mortgage_statement-part1:paymentDueDate

Date

Date next mortgage payment is due

mortgage_statement-part2:payerName

Text

Entity that took out the mortgage

mortgage_statement-part2:payerAddress:addressLine1

Text

Address of the entity that took out the mortgage

mortgage_statement-part2:payerAddress:addressLine2

Text

Address of the entity that took out the mortgage

mortgage_statement-part2:payerAddress:city

Text

City in which the entity resides

mortgage_statement-part2:payerAddress:state

Text

State in which the entity resides

mortgage_statement-part2:payerAddress:zip

Text

Zip in which the entity resides

mortgage_statement-part2:priorPaymentPostingDate

Date

Date prior payment posted

mortgage_statement-part2:priorPaymentTotalPaid

Money

Prior total amount paid

mortgage_statement-part2:priorPaymentPrincipalPaid

Money

Prior prinipal amount paid

mortgage_statement-part2:priorPaymentInterestPaid

Money

Prior interest amount paid

mortgage_statement-part2:totalDue

Money

Amount due for payment

mortgage_statement-part3:interestRate

Text

Interest rate on the mortgage

mortgage_statement-part3:interestAmountDue

Money

Amount in interest due in payment

mortgage_statement-part3:principalAmountDue

Money

Amount in principal due in payment

mortgage_statement-part3:payeeName

Text

Entity who holds the mortgage

mortgage_statement-part3:payeeAddress:addressLine1

Text

Address of the entity who holds the mortgage

mortgage_statement-part3:payeeAddress:addressLine2

Text

Address 2 of the entity who holds the mortgage

mortgage_statement-part3:payeeAddress:city

Text

City of the entity who holds the mortgage

mortgage_statement-part3:payeeAddress:state

Text

State of the entity who holds the mortgage

mortgage_statement-part3:payeeAddress:zip

Text

Zip of the entity who holds the mortgage

Sample Form

Sample JSON Result

{
  "form_type": "MORTGAGE_STATEMENT",
  "pk": 7891067,
  "form_config_pk": 2351,
  "raw_fields": {
    "mortgage_statement-part1:accountNumber": {
      "alias_used": null,
      "is_empty": false,
      "page_doc_pk": 72861210,
      "source_filename": "Ocrolus Sample PDF - Mortgage Statement.pdf",
      "value": "586987458"
    },
    "mortgage_statement-part1:currentBalance": {
      "alias_used": null,
      "is_empty": false,
      "page_doc_pk": 72861210,
      "source_filename": "Ocrolus Sample PDF - Mortgage Statement.pdf",
      "value": "264776.43"
    },
    "mortgage_statement-part1:paymentDueDate": {
      "alias_used": null,
      "is_empty": false,
      "page_doc_pk": 72861210,
      "source_filename": "Ocrolus Sample PDF - Mortgage Statement.pdf",
      "value": "04/01/2012"
    },
    "mortgage_statement-part1:propertyAddress:addressLine1": {
      "alias_used": null,
      "is_empty": false,
      "page_doc_pk": 72861210,
      "source_filename": "Ocrolus Sample PDF - Mortgage Statement.pdf",
      "value": "4700 OAK RIDGE LN"
    },
    "mortgage_statement-part1:propertyAddress:addressLine2": {
      "alias_used": null,
      "is_empty": true,
      "page_doc_pk": 72861210,
      "source_filename": "Ocrolus Sample PDF - Mortgage Statement.pdf",
      "value": ""
    },
    "mortgage_statement-part1:propertyAddress:city": {
      "alias_used": null,
      "is_empty": false,
      "page_doc_pk": 72861210,
      "source_filename": "Ocrolus Sample PDF - Mortgage Statement.pdf",
      "value": "BETHESDA"
    },
    "mortgage_statement-part1:propertyAddress:state": {
      "alias_used": null,
      "is_empty": false,
      "page_doc_pk": 72861210,
      "source_filename": "Ocrolus Sample PDF - Mortgage Statement.pdf",
      "value": "MD"
    },
    "mortgage_statement-part1:propertyAddress:zip": {
      "alias_used": null,
      "is_empty": false,
      "page_doc_pk": 72861210,
      "source_filename": "Ocrolus Sample PDF - Mortgage Statement.pdf",
      "value": "20814"
    },
    "mortgage_statement-part1:statementDate": {
      "alias_used": null,
      "is_empty": false,
      "page_doc_pk": 72861210,
      "source_filename": "Ocrolus Sample PDF - Mortgage Statement.pdf",
      "value": "03/20/2012"
    },
    "mortgage_statement-part2:payerAddress:addressLine1": {
      "alias_used": null,
      "is_empty": false,
      "page_doc_pk": 72861210,
      "source_filename": "Ocrolus Sample PDF - Mortgage Statement.pdf",
      "value": "8100 MARKET AVE"
    },
    "mortgage_statement-part2:payerAddress:addressLine2": {
      "alias_used": null,
      "is_empty": true,
      "page_doc_pk": 72861210,
      "source_filename": "Ocrolus Sample PDF - Mortgage Statement.pdf",
      "value": ""
    },
    "mortgage_statement-part2:payerAddress:city": {
      "alias_used": null,
      "is_empty": false,
      "page_doc_pk": 72861210,
      "source_filename": "Ocrolus Sample PDF - Mortgage Statement.pdf",
      "value": "BETHESDA"
    },
    "mortgage_statement-part2:payerAddress:state": {
      "alias_used": null,
      "is_empty": false,
      "page_doc_pk": 72861210,
      "source_filename": "Ocrolus Sample PDF - Mortgage Statement.pdf",
      "value": "MD"
    },
    "mortgage_statement-part2:payerAddress:zip": {
      "alias_used": null,
      "is_empty": false,
      "page_doc_pk": 72861210,
      "source_filename": "Ocrolus Sample PDF - Mortgage Statement.pdf",
      "value": "20814"
    },
    "mortgage_statement-part2:payerName": {
      "alias_used": null,
      "is_empty": false,
      "page_doc_pk": 72861210,
      "source_filename": "Ocrolus Sample PDF - Mortgage Statement.pdf",
      "value": "SPRINGSIDE MORTGAGE"
    },
    "mortgage_statement-part2:priorPaymentInterestPaid": {
      "alias_used": null,
      "is_empty": false,
      "page_doc_pk": 72861210,
      "source_filename": "Ocrolus Sample PDF - Mortgage Statement.pdf",
      "value": "1049.60"
    },
    "mortgage_statement-part2:priorPaymentPostingDate": {
      "alias_used": null,
      "is_empty": false,
      "page_doc_pk": 72861210,
      "source_filename": "Ocrolus Sample PDF - Mortgage Statement.pdf",
      "value": "03/17/2012"
    },
    "mortgage_statement-part2:priorPaymentPrincipalPaid": {
      "alias_used": null,
      "is_empty": false,
      "page_doc_pk": 72861210,
      "source_filename": "Ocrolus Sample PDF - Mortgage Statement.pdf",
      "value": "384.93"
    },
    "mortgage_statement-part2:priorPaymentTotalPaid": {
      "alias_used": null,
      "is_empty": false,
      "page_doc_pk": 72861210,
      "source_filename": "Ocrolus Sample PDF - Mortgage Statement.pdf",
      "value": "1669.71"
    },
    "mortgage_statement-part2:totalDue": {
      "alias_used": null,
      "is_empty": false,
      "page_doc_pk": 72861210,
      "source_filename": "Ocrolus Sample PDF - Mortgage Statement.pdf",
      "value": "1829.71"
    },
    "mortgage_statement-part3:interestAmountDue": {
      "alias_used": null,
      "is_empty": false,
      "page_doc_pk": 72861210,
      "source_filename": "Ocrolus Sample PDF - Mortgage Statement.pdf",
      "value": "1,048.07"
    },
    "mortgage_statement-part3:interestRate": {
      "alias_used": null,
      "is_empty": false,
      "page_doc_pk": 72861210,
      "source_filename": "Ocrolus Sample PDF - Mortgage Statement.pdf",
      "value": "4.75%"
    },
    "mortgage_statement-part3:payeeAddress:addressLine1": {
      "alias_used": null,
      "is_empty": false,
      "page_doc_pk": 72861210,
      "source_filename": "Ocrolus Sample PDF - Mortgage Statement.pdf",
      "value": "4700 OAK RIDGE LN"
    },
    "mortgage_statement-part3:payeeAddress:addressLine2": {
      "alias_used": null,
      "is_empty": true,
      "page_doc_pk": 72861210,
      "source_filename": "Ocrolus Sample PDF - Mortgage Statement.pdf",
      "value": ""
    },
    "mortgage_statement-part3:payeeAddress:city": {
      "alias_used": null,
      "is_empty": false,
      "page_doc_pk": 72861210,
      "source_filename": "Ocrolus Sample PDF - Mortgage Statement.pdf",
      "value": "BETHESDA"
    },
    "mortgage_statement-part3:payeeAddress:state": {
      "alias_used": null,
      "is_empty": false,
      "page_doc_pk": 72861210,
      "source_filename": "Ocrolus Sample PDF - Mortgage Statement.pdf",
      "value": "MD"
    },
    "mortgage_statement-part3:payeeAddress:zip": {
      "alias_used": null,
      "is_empty": false,
      "page_doc_pk": 72861210,
      "source_filename": "Ocrolus Sample PDF - Mortgage Statement.pdf",
      "value": "20814"
    },
    "mortgage_statement-part3:payeeName": {
      "alias_used": null,
      "is_empty": false,
      "page_doc_pk": 72861210,
      "source_filename": "Ocrolus Sample PDF - Mortgage Statement.pdf",
      "value": "LOGAN TOM"
    },
    "mortgage_statement-part3:principalAmountDue": {
      "alias_used": null,
      "is_empty": false,
      "page_doc_pk": 72861210,
      "source_filename": "Ocrolus Sample PDF - Mortgage Statement.pdf",
      "value": "386.46"
    }
  },
  "tables": []
}

Updated 2 months ago

Mortgage Statement


Suggested Edits are limited on API Reference Pages

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