Worked Example — Conventional Purchase (First Time Homebuyer / Affordability)

Setting first_time_homebuyer: true triggers HomeReady® and Home Possible® affordability programs with reduced MI and 3% down eligibility.

HomeReady® & Home Possible®:
Both programs allow 3% down, discounted MI, and require income ≤ 80% AMI. At 97% LTV with $6,000/month income and Orlando ZIP 32808, this borrower qualifies for both.

Scenario Parameters

Parameter	Value
Loan Purpose	Purchase
Loan Type	Conventional
First Time Homebuyer	true (triggers affordability programs)
List Price	$400,000
Loan Amount	$388,000
Down Payment	$12,000 (3%)
LTV	97%
Credit Score	780
State / City / ZIP	FL / Orlando / 32808
Monthly Income	$6,000
Loan Term	30 years (passed as string)
loid	44

Request Payload

first_time_homebuyer: true is the key field. loan_term is passed as string "30" — both string and integer are accepted.

POST https://api.bankingbridge.com/rateflow
Content-Type: application/json
x-api-key: uL6aLuwfcq1dUvEZTq3Gv2O0KgorNbYXXXXXXXX

{
  "lock_period": 30,
  "first_time_homebuyer": true,
  "loan_type": "Conventional",
  "list_price": 400000,
  "loan_purpose": "purchase",
  "loan_amount": 388000,
  "credit_score": 780,
  "state": "FL",
  "city": "Orlando",
  "zipcode": "32808",
  "coords": { "lat": 0, "lng": 0 },
  "residency_type": "primary_home",
  "property_type": "single_family_home",
  "cash_out": 0,
  "down_payment": 12000,
  "waive_escrows": false,
  "monthly_income": 6000,
  "loan_term": "30",
  "loid": 6309,
  "id": 44,
  "withCredentials": false,
  "min_credit": 780,
  "aus": "NotSpecified"
}

cURL Example

curl -X POST "https://api.bankingbridge.com/rateflow" \
  -H "x-api-key: uL6aLuwfcq1dUvEZTq3Gv2O0KgorNbYXXXXXXXX" \
  -H "Content-Type: application/json" \
  -d '{
    "lock_period": 30,
    "first_time_homebuyer": true,
    "loan_type": "Conventional",
    "list_price": 400000,
    "loan_purpose": "purchase",
    "loan_amount": 388000,
    "credit_score": 780,
    "state": "FL",
    "city": "Orlando",
    "zipcode": "32808",
    "residency_type": "primary_home",
    "property_type": "single_family_home",
    "cash_out": 0,
    "down_payment": 12000,
    "monthly_income": 6000,
    "loan_term": "30",
    "loid": 6309,
    "id": 44,
    "min_credit": 780,
    "aus": "NotSpecified"
  }'

JavaScript (fetch) Example

const response = await fetch("https://api.bankingbridge.com/rateflow", {
  method: "POST",
  headers: {
    "Content-Type": "application/json",
    "x-api-key": "uL6aLuwfcq1dUvEZTq3Gv2O0KgorNbYXXXXXXXX"
  },
  body: JSON.stringify({
    lock_period: 30,
    first_time_homebuyer: true,
    loan_type: "Conventional",
    list_price: 400000,
    loan_purpose: "purchase",
    loan_amount: 388000,
    credit_score: 780,
    state: "FL",
    city: "Orlando",
    zipcode: "32808",
    residency_type: "primary_home",
    property_type: "single_family_home",
    cash_out: 0,
    down_payment: 12000,
    monthly_income: 6000,
    loan_term: "30",
    loid: 6309,
    id: 44,
    min_credit: 780,
    aus: "NotSpecified"
  })
});
const data = await response.json();
console.log(data.pricing_results);

Python (requests) Example

import requests

headers = {
  "Content-Type": "application/json",
  "x-api-key": "uL6aLuwfcq1dUvEZTq3Gv2O0KgorNbYXXXXXXXX"
}

payload = {
  "lock_period": 30,
  "first_time_homebuyer": True,
  "loan_type": "Conventional",
  "list_price": 400000,
  "loan_purpose": "purchase",
  "loan_amount": 388000,
  "credit_score": 780,
  "state": "FL",
  "city": "Orlando",
  "zipcode": "32808",
  "residency_type": "primary_home",
  "property_type": "single_family_home",
  "cash_out": 0,
  "down_payment": 12000,
  "monthly_income": 6000,
  "loan_term": "30",
  "loid": 6309,
  "id": 44,
  "min_credit": 780,
  "aus": "NotSpecified"
}

response = requests.post(
  "https://api.bankingbridge.com/rateflow",
  json=payload,
  headers=headers
)
data = response.json()

Sample Response Structure

Response includes program_name to identify affordability vs. standard products.

{
  "returncode": 0,
  "status": "success",
  "pricing_results": [
    {
      "lender_name": "Example Lender A",
      "program_name": "HomeReady",
      "rate": 6.500,
      "pmi_monthly": 87.30
    },
    {
      "lender_name": "Example Lender B",
      "program_name": "Home Possible",
      "rate": 6.500,
      "pmi_monthly": 91.45
    },
    {
      "lender_name": "Example Lender C",
      "program_name": "Standard Conventional",
      "rate": 6.750,
      "pmi_monthly": 193.03
    }
  ]
}

Key Field Notes:

• program_name: Use in your UI to label affordability vs. standard products.
• HomeReady/Home Possible PMI (~$87–$91/mo) vs. standard conventional (~$193/mo) at 97% LTV — a significant monthly saving.
• Income eligibility: API auto-filters affordability results if monthly_income exceeds the 80% AMI threshold for the ZIP.