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!

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-BorrowerInfo:borrowerName

Text

Entity that took out the mortgage

mortgage_statement-Part1-BorrowerInfo:borrowerAddress:addressLine1

Text

Borrower address line 1

mortgage_statement-Part1-BorrowerInfo:borrowerAddress:addressLine2

Text

Borrower address line 2

mortgage_statement-Part1-BorrowerInfo:borrowerAddress:city

Text

Borrower address city

mortgage_statement-Part1-BorrowerInfo:borrowerAddress:state

Text

Borrower address state (formatted 2 character State code)

mortgage_statement-Part1-BorrowerInfo:borrowerAddress:zip

Text

Borrower address zip (formatted 5 digit code)

mortgage_statement-Part2-AccountInfo:propertyAddress:addressLine1

Text

Property address line 1

mortgage_statement-Part2-AccountInfo:propertyAddress:addressLine2

Text

Property address line 2

mortgage_statement-Part2-AccountInfo:propertyAddress:city

Text

Property address city

mortgage_statement-Part2-AccountInfo:propertyAddress:state

Text

Property address state (formatted 2 character State code)

mortgage_statement-Part2-AccountInfo:propertyAddress:zip

Text

Property address zip (formatted 5 digit code)

mortgage_statement-Part2-AccountInfo:statementDate

Date

Date the mortgage statement was issued

mortgage_statement-Part2-AccountInfo:accountNumber

Text

Account number of the entity with the mortgage

mortgage_statement-Part2-AccountInfo:paymentDueDate

Date

Date next mortgage payment is due

mortgage_statement-Part2-AccountInfo:currentBalance

Money

Current outstanding mortgage balance

mortgage_statement-Part2-AccountInfo:interestRate

Text

Interest rate on the mortgage

mortgage_statement-Part3-AmountDue(CurrentPeriod):interestAmountDue

Money

Amount in interest due in the payment

mortgage_statement-Part3-AmountDue(CurrentPeriod):principalAmountDue

Money

Amount in principal due in the payment

mortgage_statement-Part3-AmountDue(CurrentPeriod):totalAmountDue

Money

Total amount due for the payment

mortgage_statement-Part4-PriorPayment:priorPaymentPostingDate

Date

Date the prior payment was posted

mortgage_statement-Part4-PriorPayment:priorPaymentTotalPaid

Money

Prior total amount paid

mortgage_statement-Part4-PriorPayment:priorPaymentPrincipalPaid

Money

Prior principal amount paid

mortgage_statement-Part4-PriorPayment:priorPaymentInterestPaid

Money

Prior interest amount paid

mortgage_statement-Part5-LenderInfo:lenderName

Text

Entity who holds the mortgage

mortgage_statement-Part5-LenderInfo:lenderAddress:addressLine1

Text

Lender address line 1

mortgage_statement-Part5-LenderInfo:lenderAddress:addressLine2

Text

Lender address line 2

mortgage_statement-Part5-LenderInfo:lenderAddress:city

Text

Lender address city

mortgage_statement-Part5-LenderInfo:lenderAddress:state

Text

Lender address state (formatted 2 character State code)

mortgage_statement-Part5-LenderInfo:lenderAddress:zip

Text

Lender address zip (formatted 5 digit code)

Sample Form

Sample JSON Result

{
    "status": 200,
    "message": "OK",
    "response": {
        "forms": [
            {
                "tables": [],
                "form_config_pk": 3448,
                "uuid": "fd9215ad-f0b3-42be-a46b-3968a1772940",
                "form_type": "MORTGAGE_STATEMENT",
                "pk": 10552546,
                "raw_fields": {
                    "mortgage_statement-Part1-BorrowerInfo:borrowerAddress:zip": {
                        "is_empty": false,
                        "source_filename": "Ocrolus Sample PDF - Mortgage Statement.pdf",
                        "alias_used": null,
                        "value": "20814",
                        "page_doc_pk": 87469361
                    },
                    "mortgage_statement-Part1-BorrowerInfo:borrowerName": {
                        "is_empty": false,
                        "source_filename": "Ocrolus Sample PDF - Mortgage Statement.pdf",
                        "alias_used": null,
                        "value": "LOGAN TOM",
                        "page_doc_pk": 87469361
                    },
                    "mortgage_statement-Part2-AccountInfo:accountNumber": {
                        "is_empty": false,
                        "source_filename": "Ocrolus Sample PDF - Mortgage Statement.pdf",
                        "alias_used": null,
                        "value": "586987458",
                        "page_doc_pk": 87469361
                    },
                    "mortgage_statement-Part1-BorrowerInfo:borrowerAddress:addressLine1": {
                        "is_empty": false,
                        "source_filename": "Ocrolus Sample PDF - Mortgage Statement.pdf",
                        "alias_used": null,
                        "value": "4700 OAK RIDGE LN",
                        "page_doc_pk": 87469361
                    },
                    "mortgage_statement-Part1-BorrowerInfo:borrowerAddress:addressLine2": {
                        "is_empty": true,
                        "source_filename": "Ocrolus Sample PDF - Mortgage Statement.pdf",
                        "alias_used": null,
                        "value": "",
                        "page_doc_pk": 87469361
                    },
                    "mortgage_statement-Part5-LenderInfo:lenderAddress:state": {
                        "is_empty": false,
                        "source_filename": "Ocrolus Sample PDF - Mortgage Statement.pdf",
                        "alias_used": null,
                        "value": "MD",
                        "page_doc_pk": 87469361
                    },
                    "mortgage_statement-Part2-AccountInfo:propertyAddress:state": {
                        "is_empty": false,
                        "source_filename": "Ocrolus Sample PDF - Mortgage Statement.pdf",
                        "alias_used": null,
                        "value": "MD",
                        "page_doc_pk": 87469361
                    },
                    "mortgage_statement-Part3-AmountDue(CurrentPeriod):totalAmountDue": {
                        "is_empty": false,
                        "source_filename": "Ocrolus Sample PDF - Mortgage Statement.pdf",
                        "alias_used": null,
                        "value": "1829.71",
                        "page_doc_pk": 87469361
                    },
                    "mortgage_statement-Part3-AmountDue(CurrentPeriod):interestAmountDue": {
                        "is_empty": false,
                        "source_filename": "Ocrolus Sample PDF - Mortgage Statement.pdf",
                        "alias_used": null,
                        "value": "1048.07",
                        "page_doc_pk": 87469361
                    },
                    "mortgage_statement-Part2-AccountInfo:propertyAddress:zip": {
                        "is_empty": false,
                        "source_filename": "Ocrolus Sample PDF - Mortgage Statement.pdf",
                        "alias_used": null,
                        "value": "20814",
                        "page_doc_pk": 87469361
                    },
                    "mortgage_statement-Part4-PriorPayment:priorPaymentPrincipalPaid": {
                        "is_empty": false,
                        "source_filename": "Ocrolus Sample PDF - Mortgage Statement.pdf",
                        "alias_used": null,
                        "value": "384.93",
                        "page_doc_pk": 87469361
                    },
                    "mortgage_statement-Part2-AccountInfo:statementDate": {
                        "is_empty": false,
                        "source_filename": "Ocrolus Sample PDF - Mortgage Statement.pdf",
                        "alias_used": null,
                        "value": "03/20/2012",
                        "page_doc_pk": 87469361
                    },
                    "mortgage_statement-Part2-AccountInfo:propertyAddress:addressLine2": {
                        "is_empty": true,
                        "source_filename": "Ocrolus Sample PDF - Mortgage Statement.pdf",
                        "alias_used": null,
                        "value": "",
                        "page_doc_pk": 87469361
                    },
                    "mortgage_statement-Part2-AccountInfo:propertyAddress:addressLine1": {
                        "is_empty": false,
                        "source_filename": "Ocrolus Sample PDF - Mortgage Statement.pdf",
                        "alias_used": null,
                        "value": "4700 OAK RIDGE LN",
                        "page_doc_pk": 87469361
                    },
                    "mortgage_statement-Part4-PriorPayment:priorPaymentTotalPaid": {
                        "is_empty": false,
                        "source_filename": "Ocrolus Sample PDF - Mortgage Statement.pdf",
                        "alias_used": null,
                        "value": "1669.71",
                        "page_doc_pk": 87469361
                    },
                    "mortgage_statement-Part4-PriorPayment:priorPaymentInterestPaid": {
                        "is_empty": false,
                        "source_filename": "Ocrolus Sample PDF - Mortgage Statement.pdf",
                        "alias_used": null,
                        "value": "1049.60",
                        "page_doc_pk": 87469361
                    },
                    "mortgage_statement-Part2-AccountInfo:propertyAddress:city": {
                        "is_empty": false,
                        "source_filename": "Ocrolus Sample PDF - Mortgage Statement.pdf",
                        "alias_used": null,
                        "value": "BETHESDA",
                        "page_doc_pk": 87469361
                    },
                    "mortgage_statement-Part1-BorrowerInfo:borrowerAddress:city": {
                        "is_empty": false,
                        "source_filename": "Ocrolus Sample PDF - Mortgage Statement.pdf",
                        "alias_used": null,
                        "value": "BETHESDA",
                        "page_doc_pk": 87469361
                    },
                    "mortgage_statement-Part2-AccountInfo:interestRate": {
                        "is_empty": false,
                        "source_filename": "Ocrolus Sample PDF - Mortgage Statement.pdf",
                        "alias_used": null,
                        "value": "4.75%",
                        "page_doc_pk": 87469361
                    },
                    "mortgage_statement-Part5-LenderInfo:lenderName": {
                        "is_empty": false,
                        "source_filename": "Ocrolus Sample PDF - Mortgage Statement.pdf",
                        "alias_used": null,
                        "value": "SPRINGSIDE MORTGAGE",
                        "page_doc_pk": 87469361
                    },
                    "mortgage_statement-Part3-AmountDue(CurrentPeriod):principalAmountDue": {
                        "is_empty": false,
                        "source_filename": "Ocrolus Sample PDF - Mortgage Statement.pdf",
                        "alias_used": null,
                        "value": "386.46",
                        "page_doc_pk": 87469361
                    },
                    "mortgage_statement-Part5-LenderInfo:lenderAddress:addressLine1": {
                        "is_empty": false,
                        "source_filename": "Ocrolus Sample PDF - Mortgage Statement.pdf",
                        "alias_used": null,
                        "value": "8100 MARKET AVE",
                        "page_doc_pk": 87469361
                    },
                    "mortgage_statement-Part5-LenderInfo:lenderAddress:addressLine2": {
                        "is_empty": true,
                        "source_filename": "Ocrolus Sample PDF - Mortgage Statement.pdf",
                        "alias_used": null,
                        "value": "",
                        "page_doc_pk": 87469361
                    },
                    "mortgage_statement-Part5-LenderInfo:lenderAddress:city": {
                        "is_empty": false,
                        "source_filename": "Ocrolus Sample PDF - Mortgage Statement.pdf",
                        "alias_used": null,
                        "value": "BETHESDA",
                        "page_doc_pk": 87469361
                    },
                    "mortgage_statement-Part2-AccountInfo:paymentDueDate": {
                        "is_empty": false,
                        "source_filename": "Ocrolus Sample PDF - Mortgage Statement.pdf",
                        "alias_used": null,
                        "value": "04/01/2012",
                        "page_doc_pk": 87469361
                    },
                    "mortgage_statement-Part1-BorrowerInfo:borrowerAddress:state": {
                        "is_empty": false,
                        "source_filename": "Ocrolus Sample PDF - Mortgage Statement.pdf",
                        "alias_used": null,
                        "value": "MD",
                        "page_doc_pk": 87469361
                    },
                    "mortgage_statement-Part4-PriorPayment:priorPaymentPostingDate": {
                        "is_empty": false,
                        "source_filename": "Ocrolus Sample PDF - Mortgage Statement.pdf",
                        "alias_used": null,
                        "value": "03/17/2012",
                        "page_doc_pk": 87469361
                    },
                    "mortgage_statement-Part5-LenderInfo:lenderAddress:zip": {
                        "is_empty": false,
                        "source_filename": "Ocrolus Sample PDF - Mortgage Statement.pdf",
                        "alias_used": null,
                        "value": "20814",
                        "page_doc_pk": 87469361
                    },
                    "mortgage_statement-Part2-AccountInfo:currentBalance": {
                        "is_empty": false,
                        "source_filename": "Ocrolus Sample PDF - Mortgage Statement.pdf",
                        "alias_used": null,
                        "value": "264776.43",
                        "page_doc_pk": 87469361
                    }
                }
            }
        ],
        "pk": 11482648,
        "uuid": "a4d5c580-8481-4b68-aead-e8f21b4c0f41"
    }
}

Updated 5 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.