Skip to navigation
Lending

Home Lending

Check mortgage eligibility, estimate payments, and track a home loan application's status.
View as Markdown

Overview

The Home Lending API helps customers explore and track home financing. Estimate monthly payments, check pre-approval eligibility, start an application, and follow it through underwriting to closing — all surfaced inside your experience.

What you can do

Estimate payments — Calculate an estimated monthly payment from price, down payment, rate, and term.

Check eligibility — Return a pre-approval estimate based on the customer’s profile.

Track applications — Show real-time status as an application moves through each milestone.

Estimate a payment

1

Authenticate

Obtain an access token. See the Authentication guide.

2

Submit the scenario

Provide the home price, down payment, term, and estimated rate.

3

Show the breakdown

Return principal and interest, plus estimated taxes and insurance for a full monthly picture.

{
  "homePrice": 550000,
  "downPayment": 110000,
  "termYears": 30,
  "estimatedApr": 6.75
}
{
  "loanAmount": 440000,
  "monthlyPrincipalInterest": 2854.19,
  "estimatedTaxesInsurance": 690.00,
  "estimatedMonthlyPayment": 3544.19
}

Application milestones

StatusMeaning
SUBMITTEDApplication received
PROCESSINGDocuments under review
UNDERWRITINGCredit and property being assessed
CONDITIONAL_APPROVALApproved pending final conditions
CLEARED_TO_CLOSEReady to schedule closing

Payment estimates are for illustration and are not a commitment to lend. Actual terms depend on a full application, credit review, and property appraisal.

Security requirements

Home lending requests require an OAuth 2.0 access token and customer consent. See the Authentication guide.