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!

Amortization Schedule

Amortization Schedules are issued by a lender to a borrower. These statements contain a proposed schedule of payments against a Mortgage, including payment terms, interest rate, and principal and interest due over the term of the Mortagage.

The form_type parameter AMORTIZATION_SCHEDULE 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

amortization_schedule-part1:lenderName

Text

Entity with whom the loan is with

amortization_schedule-part1:borrowerName

Text

Entity that took out the loan

amortization_schedule-part1:borrowerAddress:addressLine1

Text

Address of the borrower

amortization_schedule-part1:borrowerAddress:addressLine2

Text

Address 2 of the borrower

amortization_schedule-part1:borrowerAddress:city

Text

City in which the borrower resides

amortization_schedule-part1:borrowerAddress:state

Text

State in which the borrower resides

amortization_schedule-part1:borrowerAddress:zip

Text

Zip in which the entity resides

amortization_schedule-part2:accountNumber

Text

Account Number of the entity with the loan

amortization_schedule-part2:propertyAddress:addressLine1

Text

Address of the the loan property

amortization_schedule-part2:propertyAddress:addressLine2

Text

Address 2 of the the loan property

amortization_schedule-part2:propertyAddress:city

Text

City in which the loan property resides

amortization_schedule-part2:propertyAddress:state

Text

State in which the loan property resides

amortization_schedule-part2:propertyAddress:zip

Text

Zip in which the loan property resides

amortization_schedule-part3:annualInterestRate

Text

Interest rate on the loan

amortization_schedule-part3:firstPaymentDate

Date

Date of the first loan payment

amortization_schedule-part3:lastPaymentDate

Date

Date of the last/terminal mortgage payment due, immediately prior to a complete mortgage payoff.

Example: For a 10 year mortgage, this payment date would occur roughly 10 years after the first payment date.

Optional line item fields captured

πŸ“˜

Form-Driven Output

column_ids associated with the Table object will be a subset of the following list that matches the line item headers as they appear on the specific form.

Column ID

Data Type

Description

paymentDueDate

Date

Date the loan payment is due

totalAmountPaid

Money

Amount total paid

principalPaid

Money

Allocated principal paid/due for the period.

interestPaid

Money

Interest paid/due for the period.

otherFeesPaid

Money

Amount of other fees (insurance, taxes, escrow, etc.) paid/due for the period.

endingBalance

Money

Total ending balance per payment

Sample Form

Sample JSON Result

{
  "form_type": "AMORTIZATION_SCHEDULE",
  "pk": 7560406,
  "form_config_pk": 2280,
  "raw_fields": {
    "amortization_schedule-part1:borrowerAddress:addressLine1": {
      "alias_used": null,
      "is_empty": true,
      "page_doc_pk": 71726649,
      "source_filename": "Sample 46 - Amortization Schedule.pdf",
      "value": ""
    },
    "amortization_schedule-part1:borrowerAddress:addressLine2": {
      "alias_used": null,
      "is_empty": true,
      "page_doc_pk": 71726649,
      "source_filename": "Sample 46 - Amortization Schedule.pdf",
      "value": ""
    },
    "amortization_schedule-part1:borrowerAddress:city": {
      "alias_used": null,
      "is_empty": true,
      "page_doc_pk": 71726649,
      "source_filename": "Sample 46 - Amortization Schedule.pdf",
      "value": ""
    },
    "amortization_schedule-part1:borrowerAddress:state": {
      "alias_used": null,
      "is_empty": true,
      "page_doc_pk": 71726649,
      "source_filename": "Sample 46 - Amortization Schedule.pdf",
      "value": ""
    },
    "amortization_schedule-part1:borrowerName": {
      "alias_used": null,
      "is_empty": false,
      "page_doc_pk": 71726649,
      "source_filename": "Sample 46 - Amortization Schedule.pdf",
      "value": "MARTIN LOTHER"
    },
    "amortization_schedule-part1:borrowerAddress:zip": {
      "alias_used": null,
      "is_empty": true,
      "page_doc_pk": 71726649,
      "source_filename": "Sample 46 - Amortization Schedule.pdf",
      "value": ""
    },
    "amortization_schedule-part1:lenderName": {
      "alias_used": null,
      "is_empty": false,
      "page_doc_pk": 71726649,
      "source_filename": "Sample 46 - Amortization Schedule.pdf",
      "value": "CHASE BANK"
    },
    "amortization_schedule-part2:accountNumber": {
      "alias_used": null,
      "is_empty": false,
      "page_doc_pk": 71726649,
      "source_filename": "Sample 46 - Amortization Schedule.pdf",
      "value": "1253489648"
    },
    "amortization_schedule-part2:propertyAddress:addressLine1": {
      "alias_used": null,
      "is_empty": false,
      "page_doc_pk": 71726649,
      "source_filename": "Sample 46 - Amortization Schedule.pdf",
      "value": "165 VAUGHAN LN"
    },
    "amortization_schedule-part2:propertyAddress:addressLine2": {
      "alias_used": null,
      "is_empty": true,
      "page_doc_pk": 71726649,
      "source_filename": "Sample 46 - Amortization Schedule.pdf",
      "value": ""
    },
    "amortization_schedule-part2:propertyAddress:city": {
      "alias_used": null,
      "is_empty": false,
      "page_doc_pk": 71726649,
      "source_filename": "Sample 46 - Amortization Schedule.pdf",
      "value": "PELL CITY"
    },
    "amortization_schedule-part2:propertyAddress:state": {
      "alias_used": null,
      "is_empty": false,
      "page_doc_pk": 71726649,
      "source_filename": "Sample 46 - Amortization Schedule.pdf",
      "value": "AL"
    },
    "amortization_schedule-part2:propertyAddress:zip": {
      "alias_used": null,
      "is_empty": false,
      "page_doc_pk": 71726649,
      "source_filename": "Sample 46 - Amortization Schedule.pdf",
      "value": "35125"
    },
    "amortization_schedule-part3:annualInterestRate": {
      "alias_used": null,
      "is_empty": false,
      "page_doc_pk": 71726649,
      "source_filename": "Sample 46 - Amortization Schedule.pdf",
      "value": "5.20%"
    },
    "amortization_schedule-part3:firstPaymentDate": {
      "alias_used": null,
      "is_empty": false,
      "page_doc_pk": 71726649,
      "source_filename": "Sample 46 - Amortization Schedule.pdf",
      "value": "07/15/2018"
    },
    "amortization_schedule-part3:lastPaymentDate": {
      "alias_used": null,
      "is_empty": false,
      "page_doc_pk": 71726649,
      "source_filename": "Sample 46 - Amortization Schedule.pdf",
      "value": "06/15/2019"
    }
  },
  "tables": [
    {
      "columns": [
        {
          "alias_used": "Payment Due Date",
          "column_id": "paymentDueDate"
        },
        {
          "alias_used": "Total Amount Paid",
          "column_id": "totalAmountPaid"
        },
        {
          "alias_used": "Principal Paid",
          "column_id": "principalPaid"
        },
        {
          "alias_used": "Interest Paid",
          "column_id": "interestPaid"
        },
        {
          "alias_used": "Ending Balance ",
          "column_id": "endingBalance"
        }
      ],
      "pk": 10992,
      "rows": [
        {
          "cells": {
            "endingBalance": {
              "value": "9186.34"
            },
            "interestPaid": {
              "value": "43.33"
            },
            "paymentDueDate": {
              "value": "07/15/2018"
            },
            "principalPaid": {
              "value": "813.66"
            },
            "totalAmountPaid": {
              "value": "856.99"
            }
          },
          "page_doc_pk": 71726649,
          "page_idx": 0
        },
        {
          "cells": {
            "endingBalance": {
              "value": "8369.16"
            },
            "interestPaid": {
              "value": "39.81"
            },
            "paymentDueDate": {
              "value": "08/15/2018"
            },
            "principalPaid": {
              "value": "817.18"
            },
            "totalAmountPaid": {
              "value": "856.99"
            }
          },
          "page_doc_pk": 71726649,
          "page_idx": 0
        },
        {
          "cells": {
            "endingBalance": {
              "value": "7548.43"
            },
            "interestPaid": {
              "value": "36.27"
            },
            "paymentDueDate": {
              "value": "09/15/2018"
            },
            "principalPaid": {
              "value": "820.73"
            },
            "totalAmountPaid": {
              "value": "856.99"
            }
          },
          "page_doc_pk": 71726649,
          "page_idx": 0
        },
        {
          "cells": {
            "endingBalance": {
              "value": "6724.15"
            },
            "interestPaid": {
              "value": "32.71"
            },
            "paymentDueDate": {
              "value": "10/15/2018"
            },
            "principalPaid": {
              "value": "824.28"
            },
            "totalAmountPaid": {
              "value": "856.99"
            }
          },
          "page_doc_pk": 71726649,
          "page_idx": 0
        },
        {
          "cells": {
            "endingBalance": {
              "value": "5896.30"
            },
            "interestPaid": {
              "value": "29.14"
            },
            "paymentDueDate": {
              "value": "11/15/2018"
            },
            "principalPaid": {
              "value": "827.85"
            },
            "totalAmountPaid": {
              "value": "856.99"
            }
          },
          "page_doc_pk": 71726649,
          "page_idx": 0
        },
        {
          "cells": {
            "endingBalance": {
              "value": "5064.86"
            },
            "interestPaid": {
              "value": "25.55"
            },
            "paymentDueDate": {
              "value": "12/15/2018"
            },
            "principalPaid": {
              "value": "831.44"
            },
            "totalAmountPaid": {
              "value": "856.99"
            }
          },
          "page_doc_pk": 71726649,
          "page_idx": 0
        },
        {
          "cells": {
            "endingBalance": {
              "value": "4229.81"
            },
            "interestPaid": {
              "value": "21.95"
            },
            "paymentDueDate": {
              "value": "01/15/2019"
            },
            "principalPaid": {
              "value": "835.04"
            },
            "totalAmountPaid": {
              "value": "856.99"
            }
          },
          "page_doc_pk": 71726649,
          "page_idx": 0
        },
        {
          "cells": {
            "endingBalance": {
              "value": "3391.15"
            },
            "interestPaid": {
              "value": "18.33"
            },
            "paymentDueDate": {
              "value": "02/15/2019"
            },
            "principalPaid": {
              "value": "838.66"
            },
            "totalAmountPaid": {
              "value": "856.99"
            }
          },
          "page_doc_pk": 71726649,
          "page_idx": 0
        },
        {
          "cells": {
            "endingBalance": {
              "value": "2548.85"
            },
            "interestPaid": {
              "value": "14.69"
            },
            "paymentDueDate": {
              "value": "03/15/2019"
            },
            "principalPaid": {
              "value": "842.30"
            },
            "totalAmountPaid": {
              "value": "856..99"
            }
          },
          "page_doc_pk": 71726649,
          "page_idx": 0
        },
        {
          "cells": {
            "endingBalance": {
              "value": "1702.91"
            },
            "interestPaid": {
              "value": "11.05"
            },
            "paymentDueDate": {
              "value": "04/15/2019"
            },
            "principalPaid": {
              "value": "845.95"
            },
            "totalAmountPaid": {
              "value": "856.99"
            }
          },
          "page_doc_pk": 71726649,
          "page_idx": 0
        },
        {
          "cells": {
            "endingBalance": {
              "value": "853.29"
            },
            "interestPaid": {
              "value": "7.38"
            },
            "paymentDueDate": {
              "value": "05/15/2019"
            },
            "principalPaid": {
              "value": "849.61"
            },
            "totalAmountPaid": {
              "value": "856.99"
            }
          },
          "page_doc_pk": 71726649,
          "page_idx": 0
        },
        {
          "cells": {
            "endingBalance": {
              "value": "0.00"
            },
            "interestPaid": {
              "value": "3.70"
            },
            "paymentDueDate": {
              "value": "06/15/2019"
            },
            "principalPaid": {
              "value": "853.29"
            },
            "totalAmountPaid": {
              "value": "856.99"
            }
          },
          "page_doc_pk": 71726649,
          "page_idx": 0
        }
      ]
    }
  ]
}

Updated 4 months ago

Amortization Schedule


Suggested Edits are limited on API Reference Pages

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