> This page is for Consumer.

> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://citi-demo.ferndocs.com/consumer/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://citi-demo.ferndocs.com/consumer/_mcp/server.

# Home Lending

### 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

#### Authenticate

Obtain an access token. See the [Authentication guide](/consumer/api-docs/get-started/authentication).

#### Submit the scenario

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

#### Show the breakdown

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

```json
{
  "homePrice": 550000,
  "downPayment": 110000,
  "termYears": 30,
  "estimatedApr": 6.75
}
```

```json
{
  "loanAmount": 440000,
  "monthlyPrincipalInterest": 2854.19,
  "estimatedTaxesInsurance": 690.00,
  "estimatedMonthlyPayment": 3544.19
}
```

---

### Application milestones

| Status                 | Meaning                            |
| ---------------------- | ---------------------------------- |
| `SUBMITTED`            | Application received               |
| `PROCESSING`           | Documents under review             |
| `UNDERWRITING`         | Credit and property being assessed |
| `CONDITIONAL_APPROVAL` | Approved pending final conditions  |
| `CLEARED_TO_CLOSE`     | Ready to schedule closing          |

> **Info**
>
> 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](/consumer/api-docs/get-started/authentication).