Live US mortgage, auto, HELOC, personal & deposit rates with evidence, plus who can join each lender
Maintain this server? Claim it
Call this server's tools from your browser. Nothing to install.
Requests go through mcptry because browsers can't call most MCP servers directly. Header values are sent to the server for that request only and are never stored or logged.
Tool list from our last check. Connect live to refresh it.
Add recipients (email + optional name) to a campaign. Up to 50 per request, 200 per campaign. Duplicate addresses are ignored.
Campaign id. Required.
Recipients to add.
This tool isn't marked read-only, so it may change something on the server or in an account you connected.
Add recipients (email + optional name) to a campaign. Up to 50 per request, 200 per campaign. Duplicate addresses are ignored.
| Argument | Type | Description |
|---|---|---|
| id* | string | Campaign id. Required. |
| recipients* | array | Recipients to add. |
{
"type": "object",
"required": [
"id",
"recipients"
],
"properties": {
"id": {
"type": "string",
"description": "Campaign id. Required."
},
"recipients": {
"type": "array",
"items": {
"type": "object",
"required": [
"email"
],
"properties": {
"name": {
"type": "string"
},
"email": {
"type": "string"
}
}
},
"description": "Recipients to add."
}
}
}Compare projected cost of renting vs buying a home over a holding period, anchored to LIVE market mortgage rates. Given home price, down payment, monthly rent, and a holding period, returns year-by-year cumulative cost of each path (rent vs PITI), equity built, net cost of owning after sale, and the breakeven year where buying becomes cheaper than renting. If no rate is supplied, the current best market rate for the state is used. Use for 'should I rent or buy?' questions.
| Argument | Type | Description |
|---|---|---|
| rate | number | Annual interest rate, e.g. 6.5. If omitted, best market rate for the state is used. |
| state | string | 2-letter US state code for the market-rate lookup. Default CA. |
| pmi_rate | number | Annual PMI as % of loan balance. Default 0.5, applied only when LTV > 80%. |
| home_price* | number | Purchase price in dollars. Required. |
| monthly_hoa | number | HOA dues in dollars/month. Default 0. |
| term_months | number | Loan term in months. Default 360. |
| down_payment | number | Cash down payment in dollars. Default 20% of home_price. |
| monthly_rent* | number | Current monthly rent in dollars. Required. |
| annual_insurance | number | Homeowners insurance in dollars/year. Default max(800, 0.35% of home price). |
| closing_cost_pct | number | Buying closing costs as % of home price. Default 3.0. |
| maintenance_rate | number | Annual maintenance as % of home value. Default 1.0. |
Frame a buy/refi-now vs wait recommendation. Combines recent rate movement (direction + magnitude over 1w/2w/4w) with break-even sensitivity on the borrower's loan to return a forward 'lock now' vs 'wait' lean, the bps swing that would change the call, and the cost of waiting. Use for 'should I lock now or wait for rates to drop?' questions. Distinct from get_rate_delta (raw historical deltas only) — this adds a forward recommendation. Not a rate forecast.
| Argument | Type | Description |
|---|---|---|
| since | string | Movement window (default 4w) |
| state* | string | 2-letter US state code |
| loan_amount* | number | Loan amount in dollars — drives break-even sensitivity |
| term_months | number | Loan term in months (default 360 for mortgage) |
| current_rate | number | Borrower's existing or quoted rate %, enables refi-now framing |
| product_type* | string | Loan product |
| closing_costs | number | Closing/refi costs in dollars (default 0) |
Lock-window-aware lock-vs-float-down recommendation for a deal already in the pipeline. Given a known lock-expiration date, the currently locked rate, and the float-down cost, returns a defensible hold-lock vs exercise-float-down call a loan officer can document — combining recent market movement (1w/2w/4w) with payment and break-even math on this loan. Builds on the same recent-movement signal as assess_buy_timing but framed around the lock window/expiration. Not a rate forecast.
| Argument | Type | Description |
|---|---|---|
| since | string | movement window; default 4w |
| state* | string | 2-letter state code |
| loan_amount* | number | |
| locked_rate* | number | % already locked |
| term_months | number | default 360 |
| product_type* | string | |
| float_down_bps | number | optional improvement in bps if float_down_rate omitted |
| float_down_cost |
Score an array of inline financing scenarios in one stateless call; returns ranked decisions and top offers per item — no persisted cohorts, no per-borrower HTTP loops.
| Argument | Type | Description |
|---|---|---|
| state | string | Optional 2-letter default state applied to scenarios lacking one |
| scenarios* | array | Inline scenarios to score in one stateless call (no persisted cohorts). |
| credit_score | number | Optional default credit score applied to scenarios lacking one |
| max_providers | number | Top-N offers returned per scenario (default 3) |
{
"type": "object",
"required": [
"scenarios"
],
"properties": {
"state": {
"type": "string",
"description": "Optional 2-letter default state applied to scenarios lacking one"
},
"scenarios": {
"type": "array",
"items": {
"type": "object",
"required": [
"product_type",
"intent",
"amount"
],
"properties": {
"id": {
"type": "string",
"description": "Caller correlation id, echoed back"
},
"state": {
"type": "string",
"description": "Overrides top-level state"
},
"amount": {
"type": "number"
},
"intent": {
"enum": [
"purchase",
"refinance",
"cash_out",
"balance_transfer",
"new_credit"
],
"type": "string"
},
"term_months": {
"type": "number"
},
"credit_score": {
"type": "number",
"description": "Overrides top-level credit_score"
},
"product_type": {
"enum": [
"mortgage",
"mortgage_arm",
"auto_loan",
"rv",
"boat",
"motorcycle",
"powersports",
"personal_loan",
"heloc",
"credit_card",
"student_loan",
"equipment_loan"
],
"type": "string"
},
"down_payment_percent": {
"type": "number"
}
}
},
"maxItems": 25,
"minItems": 1,
"description": "Inline scenarios to score in one stateless call (no persisted cohorts)."
},
"credit_score": {
"type": "number",
"description": "Optional default credit score applied to scenarios lacking one"
},
"max_providers": {
"type": "number",
"description": "Top-N offers returned per scenario (default 3)"
}
}
}Build a year-by-year amortization / payoff schedule for a loan: total lifetime interest, principal/interest split per period, and a what-if extra-payment accelerator showing months saved and interest saved. Resolves the market rate from real credit-union offers when no rate is provided.
| Argument | Type | Description |
|---|---|---|
| rate | number | Annual interest rate as a percent (e.g. 6.5). If omitted, the market rate is resolved from real credit-union offers via the decision engine. |
| state | string | 2-letter US state code; required only when rate is omitted (for market-rate lookup). |
| loan_amount* | number | Loan principal in dollars (required, > 0). |
| term_months* | number | Loan term in months, e.g. 360 or 180 (required). |
| credit_score | number | Optional borrower credit score used to qualify the market offer. |
| product_type | string | Loan product; required only when rate is omitted. Default mortgage. |
| schedule_granularity | string | Schedule row granularity. Default year. |
Run compliance/suitability guardrails over a financing scenario and an optional recommendation. Returns flags (red/yellow with code + message) for things like DTI strain, long auto terms with negative-equity risk, possible balloon payments, and stale market data, plus generic disclaimers and an overall verdict (ok/caution/stop). Use this before presenting a rate recommendation to a borrower.
| Argument | Type | Description |
|---|---|---|
| scenario* | object | The borrower scenario. |
| recommendation | object | Optional recommended offer to evaluate. |
{
"type": "object",
"required": [
"scenario"
],
"properties": {
"scenario": {
"type": "object",
"required": [
"product_type",
"state",
"amount",
"term_months"
],
"properties": {
"state": {
"type": "string",
"description": "US state code (2-letter)."
},
"amount": {
"type": "number",
"description": "Loan amount in dollars."
},
"intent": {
"type": "string",
"description": "The loan intent (purchase/refinance/etc.)."
},
"term_months": {
"type": "number",
"description": "Loan term in months."
},
"credit_score": {
"type": "number",
"description": "Borrower's credit score (300-850)."
},
"monthly_debt": {
"type": "number",
"description": "Borrower's existing monthly debt payments in dollars."
},
"product_type": {
"enum": [
"auto_loan",
"rv",
"boat",
"motorcycle",
"powersports",
"mortgage",
"heloc",
"personal_loan",
"student_loan",
"equipment_loan"
],
"type": "string",
"description": "Type of financing product."
},
"monthly_income": {
"type": "number",
"description": "Borrower's gross monthly income in dollars."
}
},
"description": "The borrower scenario."
},
"recommendation": {
"type": "object",
"properties": {
"apr": {
"type": "number",
"description": "Recommended APR as a percentage."
},
"rate": {
"type": "number",
"description": "Recommended rate as a percentage."
},
"monthly_payment": {
"type": "number",
"description": "Recommended monthly payment in dollars."
}
},
"description": "Optional recommended offer to evaluate."
}
}
}LENDER-side 'is my offer competitive' check — input your OWN published rate for a state+product, get the market percentile, bps vs the state median, and a leading/competitive/overpriced verdict. This is for a loan officer or credit union benchmarking their published pricing against the live market distribution. Do NOT use this for a consumer's quote: if the user is a BORROWER asking whether a rate they were offered is fair, use rate_sanity_check instead.
| Argument | Type | Description |
|---|---|---|
| apr | number | The lender's published APR. Optional — falls back to rate. |
| rate* | number | The lender's OWN published note rate as a percentage (e.g. 6.49). Required. |
| state* | string | US state code (2-letter, e.g. CA, TX). Required. |
| product* | string | Mortgage product the lender publishes. Required. |
{
"type": "object",
"required": [
"state",
"product",
"rate"
],
"properties": {
"apr": {
"type": "number",
"description": "The lender's published APR. Optional — falls back to rate."
},
"rate": {
"type": "number",
"description": "The lender's OWN published note rate as a percentage (e.g. 6.49). Required."
},
"state": {
"type": "string",
"description": "US state code (2-letter, e.g. CA, TX). Required."
},
"product": {
"enum": [
"30yr_fixed",
"15yr_fixed"
],
"type": "string",
"description": "Mortgage product the lender publishes. Required."
}
}
}`relative_memberships` carries confirmed current/deceased relative membership scoped to one exact target credit union; one institution is never reused for another. Check whether a user can JOIN specific credit unions (field-of-membership eligibility). Batch-friendly: pass 1-50 credit_union_ids (from get_financing_decision offers, list_credit_unions, or get_credit_union) plus whatever is known about the user (home, worksite, and payroll geography are independent facts; employer, occupation, military_status, school plus school_relationship, and worship are also supported). City facts require their same-role state or a recognized same-role ZIP that uniquely identifies one state, and are accepted only when the closed Census gazetteer resolves them. Returns one row for every requested credit union. Positive outcomes include open_to_anyone, likely_eligible, eligible_via_employer, and eligible_via_military. A school name alone is not a positive signal: school_relationship is required to affirm a typed student, alumni, or school-employee path. Only a graph carrying exact active-publication lineage governs the top compatibility verdict; a publication-less shadow graph remains diagnostic and cannot replace the flat result. A non-match is returned as unknown, with `unknown_reason: fom_completeness_unaffirmed` when the published field-of-membership corpus is not attested complete. The legacy `geo_mismatch` enum value is reserved for wire compatibility and is not emitted by this MCP boundary without a future typed closed-world attestation. Verdicts are guidance based on each credit union's published membership criteria; the final membership determination is always the institution's. Non-matches carry `missing_facts` for the named institutions: the exact question to ask next, the `fact_field` an answer populates, and the institution's own words. A check that returns unknown for all of them and a question for each is a SUCCESSFUL call, not a failure — ask the questions, merge the answers into the same request, and call again. Home geography accepts both the original `zip`/`state`/`county` names and the `home_zip`/`home_state`/`home_county` aliases emitted by `missing_facts`; do not send conflicting values in both forms. Fact fields, in full — supply every one you know: `home_zip`, `home_state`, `home_county`, `home_city`; `work_zip`, `work_state`, `work_county`, `work_city`; `payroll_zip`, `payroll_state`, `payroll_county`, `payroll_city` (payroll can differ from the worksite and is a separate door); `property_zip`, `property_state`, `property_county`, `property_city` (where they OWN property — never inferred from where they live, and an absentee owner qualifies); `facility_zip`, `facility_state`, `facility_county`, `facility_city` (where their business maintains a location); `occupation`; `employer`; `school` plus `school_relationship` (student/alumni/employee — a school name without a relationship affirms nothing); `military_status` plus `military_service_state` (state National Guard doors need the state); `worship`; `family_relation` plus `relative_employers`, `relative_schools`, `relative_associations` (a great many people qualify only through a relative — ask); `applicant_kind` (person/trust/organization/partnership/corporation — some charters admit entities, and a person is never rejected by an entity-only door, only left unknown); and `asserted_org_qualifiers` (narrowings the person asserts about themselves, e.g. "assigned as a recruiter in Arkansas").
Compare baseline and candidate confirmed person facts across the same 1-19 explicit products. Both catalogs use one pinned immutable eligibility graph snapshot; rate rows retain independent evidence and as_of. Returns access, membership-path, and like-for-like published-price basis-point deltas: APY for deposits, APR for lending when both sides publish APR, otherwise nominal rate only when both sides publish nominal rate. It never mixes APR and nominal rate. Never describe missing access as denial or infer savings, underwriting, approval, or final terms.
| Argument | Type | Description |
|---|---|---|
| products* | array | |
| total_limit | integer | |
| baseline_person* | object | Explicit caller-supplied person facts. Unknown facts stay absent; do not infer them. |
| candidate_person* | object | Explicit caller-supplied person facts. Unknown facts stay absent; do not infer them. |
| limit_per_product | integer |
{
"type": "object",
"required": [
"baseline_person",
"candidate_person",
"products"
],
"properties": {
"products": {
"type": "array",
"items": {
"type": "object",
"required": [
"product_type"
],
"properties": {
"amount": {
"type": "number",
"description": "Loan or credit amount in USD.",
"exclusiveMinimum": 0
},
"intent": {
"enum": [
"purchase",
"refinance",
"cash_out",
"balance_transfer",
"new_credit"
],
"type": "string",
"description": "Transaction intent when relevant."
},
"balance": {
"type": "number",
"minimum": 0,
"description": "Deposit balance in USD."
},
"audience": {
"enum": [
"business",
"consumer"
],
"type": "string",
"description": "Product audience."
},
"occupancy": {
"enum": [
"primary",
"secondary",
"investment"
],
"type": "string",
"description": "Property occupancy."
},
"term_months": {
"type": "integer",
"maximum": 600,
"minimum": 1,
"description": "Requested term in months."
},
"product_type": {
"enum": [
"mortgage",
"mortgage_arm",
"auto_loan",
"rv",
"boat",
"motorcycle",
"powersports",
"heloc",
"personal_loan",
"student_loan",
"equipment_loan",
"credit_card",
"savings",
"cd",
"share_certificate",
"money_market",
"ira_cd",
"ira",
"share_savings"
],
"type": "string",
"description": "Exact product family."
},
"vehicle_condition": {
"enum": [
"new",
"used",
"certified_pre_owned",
"any"
],
"type": "string",
"description": "Vehicle condition."
}
},
"description": "Exact product request used for both eligibility-backed rate evaluation and ranking.",
"additionalProperties": false
},
"maxItems": 19,
"minItems": 1,
"uniqueItems": true
},
"total_limit": {
"type": "integer",
"maximum": 100,
"minimum": 1
},
"baseline_person": {
"type": "object",
"properties": {
"school": {
"type": "string",
"maxLength": 500,
"minLength": 1,
"description": "Person-supplied school name; school_relationship is needed for a typed positive path."
},
"worship": {
"type": "string",
"maxLength": 500,
"minLength": 1,
"description": "Person-supplied place of worship."
},
"employer": {
"type": "string",
"maxLength": 500,
"minLength": 1,
"description": "Person-supplied employer name; use employer_org_ids after authoritative resolution."
},
"home_zip": {
"type": "string",
"pattern": "^\\d{5}(?:-\\d{4})?$",
"description": "Home ZIP; never inferred from another role."
},
"work_zip": {
"type": "string",
"pattern": "^\\d{5}(?:-\\d{4})?$",
"description": "Worksite ZIP, separate from home and payroll."
},
"home_city": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"description": "Census-recognized home city."
},
"work_city": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"description": "Census-recognized worksite city."
},
"home_state": {
"type": "string",
"pattern": "^(?:[Aa][Ll]|[Aa][Kk]|[Aa][Zz]|[Aa][Rr]|[Cc][Aa]|[Cc][Oo]|[Cc][Tt]|[Dd][Ee]|[Dd][Cc]|[Ff][Ll]|[Gg][Aa]|[Hh][Ii]|[Ii][Dd]|[Ii][Ll]|[Ii][Nn]|[Ii][Aa]|[Kk][Ss]|[Kk][Yy]|[Ll][Aa]|[Mm][Ee]|[Mm][Dd]|[Mm][Aa]|[Mm][Ii]|[Mm][Nn]|[Mm][Ss]|[Mm][Oo]|[Mm][Tt]|[Nn][Ee]|[Nn][Vv]|[Nn][Hh]|[Nn][Jj]|[Nn][Mm]|[Nn][Yy]|[Nn][Cc]|[Nn][Dd]|[Oo][Hh]|[Oo][Kk]|[Oo][Rr]|[Pp][Aa]|[Rr][Ii]|[Ss][Cc]|[Ss][Dd]|[Tt][Nn]|[Tt][Xx]|[Uu][Tt]|[Vv][Tt]|[Vv][Aa]|[Ww][Aa]|[Ww][Vv]|[Ww][Ii]|[Ww][Yy])$",
"description": "Valid 50-state/DC home state."
},
"occupation": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"description": "Person-supplied occupation."
},
"work_state": {
"type": "string",
"pattern": "^(?:[Aa][Ll]|[Aa][Kk]|[Aa][Zz]|[Aa][Rr]|[Cc][Aa]|[Cc][Oo]|[Cc][Tt]|[Dd][Ee]|[Dd][Cc]|[Ff][Ll]|[Gg][Aa]|[Hh][Ii]|[Ii][Dd]|[Ii][Ll]|[Ii][Nn]|[Ii][Aa]|[Kk][Ss]|[Kk][Yy]|[Ll][Aa]|[Mm][Ee]|[Mm][Dd]|[Mm][Aa]|[Mm][Ii]|[Mm][Nn]|[Mm][Ss]|[Mm][Oo]|[Mm][Tt]|[Nn][Ee]|[Nn][Vv]|[Nn][Hh]|[Nn][Jj]|[Nn][Mm]|[Nn][Yy]|[Nn][Cc]|[Nn][Dd]|[Oo][Hh]|[Oo][Kk]|[Oo][Rr]|[Pp][Aa]|[Rr][Ii]|[Ss][Cc]|[Ss][Dd]|[Tt][Nn]|[Tt][Xx]|[Uu][Tt]|[Vv][Tt]|[Vv][Aa]|[Ww][Aa]|[Ww][Vv]|[Ww][Ii]|[Ww][Yy])$",
"description": "Valid 50-state/DC worksite state."
},
"home_county": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"description": "Home county."
},
"payroll_zip": {
"type": "string",
"pattern": "^\\d{5}(?:-\\d{4})?$",
"description": "Payroll-origin ZIP, separate from the worksite."
},
"work_county": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"description": "Worksite county."
},
"associations": {
"type": "array",
"items": {
"type": "string",
"maxLength": 500,
"minLength": 1
},
"maxItems": 20,
"description": "Associations the person already belongs to."
},
"facility_zip": {
"type": "string",
"pattern": "^\\d{5}(?:-\\d{4})?$",
"description": "ZIP where the applicant organization maintains a facility."
},
"payroll_city": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"description": "Census-recognized payroll-origin city."
},
"property_zip": {
"type": "string",
"pattern": "^\\d{5}(?:-\\d{4})?$",
"description": "ZIP where the person owns real property; never inferred from home."
},
"facility_city": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"description": "Census-recognized facility city."
},
"payroll_state": {
"type": "string",
"pattern": "^(?:[Aa][Ll]|[Aa][Kk]|[Aa][Zz]|[Aa][Rr]|[Cc][Aa]|[Cc][Oo]|[Cc][Tt]|[Dd][Ee]|[Dd][Cc]|[Ff][Ll]|[Gg][Aa]|[Hh][Ii]|[Ii][Dd]|[Ii][Ll]|[Ii][Nn]|[Ii][Aa]|[Kk][Ss]|[Kk][Yy]|[Ll][Aa]|[Mm][Ee]|[Mm][Dd]|[Mm][Aa]|[Mm][Ii]|[Mm][Nn]|[Mm][Ss]|[Mm][Oo]|[Mm][Tt]|[Nn][Ee]|[Nn][Vv]|[Nn][Hh]|[Nn][Jj]|[Nn][Mm]|[Nn][Yy]|[Nn][Cc]|[Nn][Dd]|[Oo][Hh]|[Oo][Kk]|[Oo][Rr]|[Pp][Aa]|[Rr][Ii]|[Ss][Cc]|[Ss][Dd]|[Tt][Nn]|[Tt][Xx]|[Uu][Tt]|[Vv][Tt]|[Vv][Aa]|[Ww][Aa]|[Ww][Vv]|[Ww][Ii]|[Ww][Yy])$",
"description": "Valid 50-state/DC payroll-origin state."
},
"property_city": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"description": "Census-recognized city where the person owns real property."
},
"applicant_kind": {
"enum": [
"person",
"trust",
"organization",
"partnership",
"corporation",
"other_legal_entity"
],
"type": "string",
"description": "What the applicant is; absence means a natural person."
},
"facility_state": {
"type": "string",
"pattern": "^(?:[Aa][Ll]|[Aa][Kk]|[Aa][Zz]|[Aa][Rr]|[Cc][Aa]|[Cc][Oo]|[Cc][Tt]|[Dd][Ee]|[Dd][Cc]|[Ff][Ll]|[Gg][Aa]|[Hh][Ii]|[Ii][Dd]|[Ii][Ll]|[Ii][Nn]|[Ii][Aa]|[Kk][Ss]|[Kk][Yy]|[Ll][Aa]|[Mm][Ee]|[Mm][Dd]|[Mm][Aa]|[Mm][Ii]|[Mm][Nn]|[Mm][Ss]|[Mm][Oo]|[Mm][Tt]|[Nn][Ee]|[Nn][Vv]|[Nn][Hh]|[Nn][Jj]|[Nn][Mm]|[Nn][Yy]|[Nn][Cc]|[Nn][Dd]|[Oo][Hh]|[Oo][Kk]|[Oo][Rr]|[Pp][Aa]|[Rr][Ii]|[Ss][Cc]|[Ss][Dd]|[Tt][Nn]|[Tt][Xx]|[Uu][Tt]|[Vv][Tt]|[Vv][Aa]|[Ww][Aa]|[Ww][Vv]|[Ww][Ii]|[Ww][Yy])$",
"description": "Valid 50-state/DC facility state."
},
"payroll_county": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"description": "Payroll-origin county."
},
"property_state": {
"type": "string",
"pattern": "^(?:[Aa][Ll]|[Aa][Kk]|[Aa][Zz]|[Aa][Rr]|[Cc][Aa]|[Cc][Oo]|[Cc][Tt]|[Dd][Ee]|[Dd][Cc]|[Ff][Ll]|[Gg][Aa]|[Hh][Ii]|[Ii][Dd]|[Ii][Ll]|[Ii][Nn]|[Ii][Aa]|[Kk][Ss]|[Kk][Yy]|[Ll][Aa]|[Mm][Ee]|[Mm][Dd]|[Mm][Aa]|[Mm][Ii]|[Mm][Nn]|[Mm][Ss]|[Mm][Oo]|[Mm][Tt]|[Nn][Ee]|[Nn][Vv]|[Nn][Hh]|[Nn][Jj]|[Nn][Mm]|[Nn][Yy]|[Nn][Cc]|[Nn][Dd]|[Oo][Hh]|[Oo][Kk]|[Oo][Rr]|[Pp][Aa]|[Rr][Ii]|[Ss][Cc]|[Ss][Dd]|[Tt][Nn]|[Tt][Xx]|[Uu][Tt]|[Vv][Tt]|[Vv][Aa]|[Ww][Aa]|[Ww][Vv]|[Ww][Ii]|[Ww][Yy])$",
"description": "Valid 50-state/DC property state."
},
"school_org_ids": {
"type": "array",
"items": {
"type": "string",
"pattern": "^[a-z0-9]+(?:-[a-z0-9]+)*$",
"maxLength": 80,
"minLength": 1
},
"maxItems": 20,
"description": "Explicit school ids returned by resolve_eligibility_entities; rates-api revalidates them.",
"uniqueItems": true
},
"facility_county": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"description": "County where the applicant organization maintains a facility."
},
"family_relation": {
"type": "string",
"maxLength": 60,
"minLength": 1,
"description": "Relationship to the relative whose affiliations are supplied."
},
"military_status": {
"enum": [
"active_duty",
"veteran",
"reservist",
"dod_civilian",
"military_family"
],
"type": "string",
"description": "Person-supplied military affiliation."
},
"property_county": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"description": "County where the person owns real property."
},
"worship_org_ids": {
"type": "array",
"items": {
"type": "string",
"pattern": "^[a-z0-9]+(?:-[a-z0-9]+)*$",
"maxLength": 80,
"minLength": 1
},
"maxItems": 20,
"description": "Explicit worship-organization ids returned by resolve_eligibility_entities; rates-api revalidates them.",
"uniqueItems": true
},
"employer_org_ids": {
"type": "array",
"items": {
"type": "string",
"pattern": "^[a-z0-9]+(?:-[a-z0-9]+)*$",
"maxLength": 80,
"minLength": 1
},
"maxItems": 20,
"description": "Explicit employer ids returned by resolve_eligibility_entities; rates-api revalidates type and active-publication authority.",
"uniqueItems": true
},
"relative_schools": {
"type": "array",
"items": {
"type": "string",
"maxLength": 500,
"minLength": 1
},
"maxItems": 20,
"description": "Schools of the named relative, not the applicant."
},
"relative_employers": {
"type": "array",
"items": {
"type": "string",
"maxLength": 500,
"minLength": 1
},
"maxItems": 20,
"description": "Employers of the named relative, not the applicant."
},
"association_org_ids": {
"type": "array",
"items": {
"type": "string",
"pattern": "^[a-z0-9]+(?:-[a-z0-9]+)*$",
"maxLength": 80,
"minLength": 1
},
"maxItems": 20,
"description": "Explicit association ids returned by resolve_eligibility_entities; rates-api revalidates them.",
"uniqueItems": true
},
"school_relationship": {
"enum": [
"student",
"alumni",
"employee"
],
"type": "string",
"description": "How the person relates to the supplied school."
},
"relative_memberships": {
"type": "array",
"items": {
"type": "object",
"required": [
"credit_union_id",
"relation",
"status"
],
"properties": {
"status": {
"enum": [
"current_member",
"deceased_member"
],
"type": "string",
"description": "Confirmed membership status."
},
"relation": {
"type": "string",
"maxLength": 60,
"minLength": 1,
"description": "Relative relationship."
},
"credit_union_id": {
"type": "string",
"maxLength": 300,
"minLength": 1,
"description": "Exact credit-union id."
}
},
"additionalProperties": false
},
"maxItems": 50,
"description": "Confirmed relative memberships, each scoped to one exact institution."
},
"relative_associations": {
"type": "array",
"items": {
"type": "string",
"maxLength": 500,
"minLength": 1
},
"maxItems": 20,
"description": "Associations of the named relative, not the applicant."
},
"military_service_state": {
"type": "string",
"pattern": "^(?:[Aa][Ll]|[Aa][Kk]|[Aa][Zz]|[Aa][Rr]|[Cc][Aa]|[Cc][Oo]|[Cc][Tt]|[Dd][Ee]|[Dd][Cc]|[Ff][Ll]|[Gg][Aa]|[Hh][Ii]|[Ii][Dd]|[Ii][Ll]|[Ii][Nn]|[Ii][Aa]|[Kk][Ss]|[Kk][Yy]|[Ll][Aa]|[Mm][Ee]|[Mm][Dd]|[Mm][Aa]|[Mm][Ii]|[Mm][Nn]|[Mm][Ss]|[Mm][Oo]|[Mm][Tt]|[Nn][Ee]|[Nn][Vv]|[Nn][Hh]|[Nn][Jj]|[Nn][Mm]|[Nn][Yy]|[Nn][Cc]|[Nn][Dd]|[Oo][Hh]|[Oo][Kk]|[Oo][Rr]|[Pp][Aa]|[Rr][Ii]|[Ss][Cc]|[Ss][Dd]|[Tt][Nn]|[Tt][Xx]|[Uu][Tt]|[Vv][Tt]|[Vv][Aa]|[Ww][Aa]|[Ww][Vv]|[Ww][Ii]|[Ww][Yy])$",
"description": "State tied to a state-scoped military affiliation."
},
"asserted_org_qualifiers": {
"type": "array",
"items": {
"type": "string",
"maxLength": 200,
"minLength": 1
},
"maxItems": 20,
"description": "Narrow conditions the person explicitly asserted; never infer them."
},
"relative_school_org_ids": {
"type": "array",
"items": {
"type": "string",
"pattern": "^[a-z0-9]+(?:-[a-z0-9]+)*$",
"maxLength": 80,
"minLength": 1
},
"maxItems": 20,
"description": "Canonical school ids belonging to the named relative, not the applicant.",
"uniqueItems": true
},
"relative_employer_org_ids": {
"type": "array",
"items": {
"type": "string",
"pattern": "^[a-z0-9]+(?:-[a-z0-9]+)*$",
"maxLength": 80,
"minLength": 1
},
"maxItems": 20,
"description": "Canonical employer ids belonging to the named relative, not the applicant.",
"uniqueItems": true
},
"willing_to_join_association": {
"type": "boolean",
"description": "Whether documented joinable-association actions may be considered."
},
"relative_association_org_ids": {
"type": "array",
"items": {
"type": "string",
"pattern": "^[a-z0-9]+(?:-[a-z0-9]+)*$",
"maxLength": 80,
"minLength": 1
},
"maxItems": 20,
"description": "Canonical association ids belonging to the named relative, not the applicant.",
"uniqueItems": true
}
},
"description": "Explicit caller-supplied person facts. Unknown facts stay absent; do not infer them.",
"additionalProperties": false
},
"candidate_person": {
"type": "object",
"properties": {
"school": {
"type": "string",
"maxLength": 500,
"minLength": 1,
"description": "Person-supplied school name; school_relationship is needed for a typed positive path."
},
"worship": {
"type": "string",
"maxLength": 500,
"minLength": 1,
"description": "Person-supplied place of worship."
},
"employer": {
"type": "string",
"maxLength": 500,
"minLength": 1,
"description": "Person-supplied employer name; use employer_org_ids after authoritative resolution."
},
"home_zip": {
"type": "string",
"pattern": "^\\d{5}(?:-\\d{4})?$",
"description": "Home ZIP; never inferred from another role."
},
"work_zip": {
"type": "string",
"pattern": "^\\d{5}(?:-\\d{4})?$",
"description": "Worksite ZIP, separate from home and payroll."
},
"home_city": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"description": "Census-recognized home city."
},
"work_city": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"description": "Census-recognized worksite city."
},
"home_state": {
"type": "string",
"pattern": "^(?:[Aa][Ll]|[Aa][Kk]|[Aa][Zz]|[Aa][Rr]|[Cc][Aa]|[Cc][Oo]|[Cc][Tt]|[Dd][Ee]|[Dd][Cc]|[Ff][Ll]|[Gg][Aa]|[Hh][Ii]|[Ii][Dd]|[Ii][Ll]|[Ii][Nn]|[Ii][Aa]|[Kk][Ss]|[Kk][Yy]|[Ll][Aa]|[Mm][Ee]|[Mm][Dd]|[Mm][Aa]|[Mm][Ii]|[Mm][Nn]|[Mm][Ss]|[Mm][Oo]|[Mm][Tt]|[Nn][Ee]|[Nn][Vv]|[Nn][Hh]|[Nn][Jj]|[Nn][Mm]|[Nn][Yy]|[Nn][Cc]|[Nn][Dd]|[Oo][Hh]|[Oo][Kk]|[Oo][Rr]|[Pp][Aa]|[Rr][Ii]|[Ss][Cc]|[Ss][Dd]|[Tt][Nn]|[Tt][Xx]|[Uu][Tt]|[Vv][Tt]|[Vv][Aa]|[Ww][Aa]|[Ww][Vv]|[Ww][Ii]|[Ww][Yy])$",
"description": "Valid 50-state/DC home state."
},
"occupation": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"description": "Person-supplied occupation."
},
"work_state": {
"type": "string",
"pattern": "^(?:[Aa][Ll]|[Aa][Kk]|[Aa][Zz]|[Aa][Rr]|[Cc][Aa]|[Cc][Oo]|[Cc][Tt]|[Dd][Ee]|[Dd][Cc]|[Ff][Ll]|[Gg][Aa]|[Hh][Ii]|[Ii][Dd]|[Ii][Ll]|[Ii][Nn]|[Ii][Aa]|[Kk][Ss]|[Kk][Yy]|[Ll][Aa]|[Mm][Ee]|[Mm][Dd]|[Mm][Aa]|[Mm][Ii]|[Mm][Nn]|[Mm][Ss]|[Mm][Oo]|[Mm][Tt]|[Nn][Ee]|[Nn][Vv]|[Nn][Hh]|[Nn][Jj]|[Nn][Mm]|[Nn][Yy]|[Nn][Cc]|[Nn][Dd]|[Oo][Hh]|[Oo][Kk]|[Oo][Rr]|[Pp][Aa]|[Rr][Ii]|[Ss][Cc]|[Ss][Dd]|[Tt][Nn]|[Tt][Xx]|[Uu][Tt]|[Vv][Tt]|[Vv][Aa]|[Ww][Aa]|[Ww][Vv]|[Ww][Ii]|[Ww][Yy])$",
"description": "Valid 50-state/DC worksite state."
},
"home_county": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"description": "Home county."
},
"payroll_zip": {
"type": "string",
"pattern": "^\\d{5}(?:-\\d{4})?$",
"description": "Payroll-origin ZIP, separate from the worksite."
},
"work_county": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"description": "Worksite county."
},
"associations": {
"type": "array",
"items": {
"type": "string",
"maxLength": 500,
"minLength": 1
},
"maxItems": 20,
"description": "Associations the person already belongs to."
},
"facility_zip": {
"type": "string",
"pattern": "^\\d{5}(?:-\\d{4})?$",
"description": "ZIP where the applicant organization maintains a facility."
},
"payroll_city": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"description": "Census-recognized payroll-origin city."
},
"property_zip": {
"type": "string",
"pattern": "^\\d{5}(?:-\\d{4})?$",
"description": "ZIP where the person owns real property; never inferred from home."
},
"facility_city": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"description": "Census-recognized facility city."
},
"payroll_state": {
"type": "string",
"pattern": "^(?:[Aa][Ll]|[Aa][Kk]|[Aa][Zz]|[Aa][Rr]|[Cc][Aa]|[Cc][Oo]|[Cc][Tt]|[Dd][Ee]|[Dd][Cc]|[Ff][Ll]|[Gg][Aa]|[Hh][Ii]|[Ii][Dd]|[Ii][Ll]|[Ii][Nn]|[Ii][Aa]|[Kk][Ss]|[Kk][Yy]|[Ll][Aa]|[Mm][Ee]|[Mm][Dd]|[Mm][Aa]|[Mm][Ii]|[Mm][Nn]|[Mm][Ss]|[Mm][Oo]|[Mm][Tt]|[Nn][Ee]|[Nn][Vv]|[Nn][Hh]|[Nn][Jj]|[Nn][Mm]|[Nn][Yy]|[Nn][Cc]|[Nn][Dd]|[Oo][Hh]|[Oo][Kk]|[Oo][Rr]|[Pp][Aa]|[Rr][Ii]|[Ss][Cc]|[Ss][Dd]|[Tt][Nn]|[Tt][Xx]|[Uu][Tt]|[Vv][Tt]|[Vv][Aa]|[Ww][Aa]|[Ww][Vv]|[Ww][Ii]|[Ww][Yy])$",
"description": "Valid 50-state/DC payroll-origin state."
},
"property_city": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"description": "Census-recognized city where the person owns real property."
},
"applicant_kind": {
"enum": [
"person",
"trust",
"organization",
"partnership",
"corporation",
"other_legal_entity"
],
"type": "string",
"description": "What the applicant is; absence means a natural person."
},
"facility_state": {
"type": "string",
"pattern": "^(?:[Aa][Ll]|[Aa][Kk]|[Aa][Zz]|[Aa][Rr]|[Cc][Aa]|[Cc][Oo]|[Cc][Tt]|[Dd][Ee]|[Dd][Cc]|[Ff][Ll]|[Gg][Aa]|[Hh][Ii]|[Ii][Dd]|[Ii][Ll]|[Ii][Nn]|[Ii][Aa]|[Kk][Ss]|[Kk][Yy]|[Ll][Aa]|[Mm][Ee]|[Mm][Dd]|[Mm][Aa]|[Mm][Ii]|[Mm][Nn]|[Mm][Ss]|[Mm][Oo]|[Mm][Tt]|[Nn][Ee]|[Nn][Vv]|[Nn][Hh]|[Nn][Jj]|[Nn][Mm]|[Nn][Yy]|[Nn][Cc]|[Nn][Dd]|[Oo][Hh]|[Oo][Kk]|[Oo][Rr]|[Pp][Aa]|[Rr][Ii]|[Ss][Cc]|[Ss][Dd]|[Tt][Nn]|[Tt][Xx]|[Uu][Tt]|[Vv][Tt]|[Vv][Aa]|[Ww][Aa]|[Ww][Vv]|[Ww][Ii]|[Ww][Yy])$",
"description": "Valid 50-state/DC facility state."
},
"payroll_county": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"description": "Payroll-origin county."
},
"property_state": {
"type": "string",
"pattern": "^(?:[Aa][Ll]|[Aa][Kk]|[Aa][Zz]|[Aa][Rr]|[Cc][Aa]|[Cc][Oo]|[Cc][Tt]|[Dd][Ee]|[Dd][Cc]|[Ff][Ll]|[Gg][Aa]|[Hh][Ii]|[Ii][Dd]|[Ii][Ll]|[Ii][Nn]|[Ii][Aa]|[Kk][Ss]|[Kk][Yy]|[Ll][Aa]|[Mm][Ee]|[Mm][Dd]|[Mm][Aa]|[Mm][Ii]|[Mm][Nn]|[Mm][Ss]|[Mm][Oo]|[Mm][Tt]|[Nn][Ee]|[Nn][Vv]|[Nn][Hh]|[Nn][Jj]|[Nn][Mm]|[Nn][Yy]|[Nn][Cc]|[Nn][Dd]|[Oo][Hh]|[Oo][Kk]|[Oo][Rr]|[Pp][Aa]|[Rr][Ii]|[Ss][Cc]|[Ss][Dd]|[Tt][Nn]|[Tt][Xx]|[Uu][Tt]|[Vv][Tt]|[Vv][Aa]|[Ww][Aa]|[Ww][Vv]|[Ww][Ii]|[Ww][Yy])$",
"description": "Valid 50-state/DC property state."
},
"school_org_ids": {
"type": "array",
"items": {
"type": "string",
"pattern": "^[a-z0-9]+(?:-[a-z0-9]+)*$",
"maxLength": 80,
"minLength": 1
},
"maxItems": 20,
"description": "Explicit school ids returned by resolve_eligibility_entities; rates-api revalidates them.",
"uniqueItems": true
},
"facility_county": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"description": "County where the applicant organization maintains a facility."
},
"family_relation": {
"type": "string",
"maxLength": 60,
"minLength": 1,
"description": "Relationship to the relative whose affiliations are supplied."
},
"military_status": {
"enum": [
"active_duty",
"veteran",
"reservist",
"dod_civilian",
"military_family"
],
"type": "string",
"description": "Person-supplied military affiliation."
},
"property_county": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"description": "County where the person owns real property."
},
"worship_org_ids": {
"type": "array",
"items": {
"type": "string",
"pattern": "^[a-z0-9]+(?:-[a-z0-9]+)*$",
"maxLength": 80,
"minLength": 1
},
"maxItems": 20,
"description": "Explicit worship-organization ids returned by resolve_eligibility_entities; rates-api revalidates them.",
"uniqueItems": true
},
"employer_org_ids": {
"type": "array",
"items": {
"type": "string",
"pattern": "^[a-z0-9]+(?:-[a-z0-9]+)*$",
"maxLength": 80,
"minLength": 1
},
"maxItems": 20,
"description": "Explicit employer ids returned by resolve_eligibility_entities; rates-api revalidates type and active-publication authority.",
"uniqueItems": true
},
"relative_schools": {
"type": "array",
"items": {
"type": "string",
"maxLength": 500,
"minLength": 1
},
"maxItems": 20,
"description": "Schools of the named relative, not the applicant."
},
"relative_employers": {
"type": "array",
"items": {
"type": "string",
"maxLength": 500,
"minLength": 1
},
"maxItems": 20,
"description": "Employers of the named relative, not the applicant."
},
"association_org_ids": {
"type": "array",
"items": {
"type": "string",
"pattern": "^[a-z0-9]+(?:-[a-z0-9]+)*$",
"maxLength": 80,
"minLength": 1
},
"maxItems": 20,
"description": "Explicit association ids returned by resolve_eligibility_entities; rates-api revalidates them.",
"uniqueItems": true
},
"school_relationship": {
"enum": [
"student",
"alumni",
"employee"
],
"type": "string",
"description": "How the person relates to the supplied school."
},
"relative_memberships": {
"type": "array",
"items": {
"type": "object",
"required": [
"credit_union_id",
"relation",
"status"
],
"properties": {
"status": {
"enum": [
"current_member",
"deceased_member"
],
"type": "string",
"description": "Confirmed membership status."
},
"relation": {
"type": "string",
"maxLength": 60,
"minLength": 1,
"description": "Relative relationship."
},
"credit_union_id": {
"type": "string",
"maxLength": 300,
"minLength": 1,
"description": "Exact credit-union id."
}
},
"additionalProperties": false
},
"maxItems": 50,
"description": "Confirmed relative memberships, each scoped to one exact institution."
},
"relative_associations": {
"type": "array",
"items": {
"type": "string",
"maxLength": 500,
"minLength": 1
},
"maxItems": 20,
"description": "Associations of the named relative, not the applicant."
},
"military_service_state": {
"type": "string",
"pattern": "^(?:[Aa][Ll]|[Aa][Kk]|[Aa][Zz]|[Aa][Rr]|[Cc][Aa]|[Cc][Oo]|[Cc][Tt]|[Dd][Ee]|[Dd][Cc]|[Ff][Ll]|[Gg][Aa]|[Hh][Ii]|[Ii][Dd]|[Ii][Ll]|[Ii][Nn]|[Ii][Aa]|[Kk][Ss]|[Kk][Yy]|[Ll][Aa]|[Mm][Ee]|[Mm][Dd]|[Mm][Aa]|[Mm][Ii]|[Mm][Nn]|[Mm][Ss]|[Mm][Oo]|[Mm][Tt]|[Nn][Ee]|[Nn][Vv]|[Nn][Hh]|[Nn][Jj]|[Nn][Mm]|[Nn][Yy]|[Nn][Cc]|[Nn][Dd]|[Oo][Hh]|[Oo][Kk]|[Oo][Rr]|[Pp][Aa]|[Rr][Ii]|[Ss][Cc]|[Ss][Dd]|[Tt][Nn]|[Tt][Xx]|[Uu][Tt]|[Vv][Tt]|[Vv][Aa]|[Ww][Aa]|[Ww][Vv]|[Ww][Ii]|[Ww][Yy])$",
"description": "State tied to a state-scoped military affiliation."
},
"asserted_org_qualifiers": {
"type": "array",
"items": {
"type": "string",
"maxLength": 200,
"minLength": 1
},
"maxItems": 20,
"description": "Narrow conditions the person explicitly asserted; never infer them."
},
"relative_school_org_ids": {
"type": "array",
"items": {
"type": "string",
"pattern": "^[a-z0-9]+(?:-[a-z0-9]+)*$",
"maxLength": 80,
"minLength": 1
},
"maxItems": 20,
"description": "Canonical school ids belonging to the named relative, not the applicant.",
"uniqueItems": true
},
"relative_employer_org_ids": {
"type": "array",
"items": {
"type": "string",
"pattern": "^[a-z0-9]+(?:-[a-z0-9]+)*$",
"maxLength": 80,
"minLength": 1
},
"maxItems": 20,
"description": "Canonical employer ids belonging to the named relative, not the applicant.",
"uniqueItems": true
},
"willing_to_join_association": {
"type": "boolean",
"description": "Whether documented joinable-association actions may be considered."
},
"relative_association_org_ids": {
"type": "array",
"items": {
"type": "string",
"pattern": "^[a-z0-9]+(?:-[a-z0-9]+)*$",
"maxLength": 80,
"minLength": 1
},
"maxItems": 20,
"description": "Canonical association ids belonging to the named relative, not the applicant.",
"uniqueItems": true
}
},
"description": "Explicit caller-supplied person facts. Unknown facts stay absent; do not infer them.",
"additionalProperties": false
},
"limit_per_product": {
"type": "integer",
"maximum": 10,
"minimum": 1
}
},
"additionalProperties": false
}Compare the best real rates across MULTIPLE lending products in a single call — e.g. show a buyer mortgage vs HELOC, or new vs used auto. Runs the decision engine for each product and returns a ranked, true-cost (APR + fees) table. Use this instead of calling get_financing_decision repeatedly. Each product returns its top offer with rate, APR, and monthly payment.
| Argument | Type | Description |
|---|---|---|
| state* | string | US state code, e.g. "CA" |
| amount* | number | Loan/credit amount in dollars |
| intent | string | purchase | refinance | cash_out | balance_transfer | new_credit |
| term_months | number | Optional loan term in months |
| credit_score | number | Optional borrower credit score |
| product_types* | array | Products to compare, e.g. ["mortgage","heloc"]. Any of: mortgage, mortgage_arm, auto, rv, boat, motorcycle, powersports, heloc, personal_loan, credit_card, student_loan. "mortgage" is fixed-rate and "mortgage_arm" is adjustable — comparing them side by side is meaningful, but they are never blended into one ranking. Boats/RVs/motorcycles/powersports are first-class product types; auto means cars. |
Compare one baseline person-fact panel with one candidate panel against the same active eligibility snapshot and exact product request. Use this for explicit what-if questions such as adding a confirmed employer or association. Newly reachable means current positive evidence now proves a path; no_longer_reachable or absence never proves ineligibility. Supply only facts the person confirmed, preferably canonical *_org_ids from resolve_eligibility_entities. Person facts are forwarded transiently and are not stored by this tool.
| Argument | Type | Description |
|---|---|---|
| limit | integer | Visible items per bucket and delta list. |
| product* | object | Exact product request used for both eligibility-backed rate evaluation and ranking. |
| baseline_person* | object | Confirmed facts before the proposed change. |
| candidate_person* | object | Confirmed facts after the proposed change. |
{
"type": "object",
"required": [
"baseline_person",
"candidate_person",
"product"
],
"properties": {
"limit": {
"type": "integer",
"default": 10,
"maximum": 50,
"minimum": 1,
"description": "Visible items per bucket and delta list."
},
"product": {
"type": "object",
"required": [
"product_type"
],
"properties": {
"amount": {
"type": "number",
"description": "Loan or credit amount in USD.",
"exclusiveMinimum": 0
},
"intent": {
"enum": [
"purchase",
"refinance",
"cash_out",
"balance_transfer",
"new_credit"
],
"type": "string",
"description": "Transaction intent when relevant."
},
"balance": {
"type": "number",
"minimum": 0,
"description": "Deposit balance in USD."
},
"audience": {
"enum": [
"business",
"consumer"
],
"type": "string",
"description": "Product audience."
},
"occupancy": {
"enum": [
"primary",
"secondary",
"investment"
],
"type": "string",
"description": "Property occupancy."
},
"term_months": {
"type": "integer",
"maximum": 600,
"minimum": 1,
"description": "Requested term in months."
},
"product_type": {
"enum": [
"mortgage",
"mortgage_arm",
"auto_loan",
"rv",
"boat",
"motorcycle",
"powersports",
"heloc",
"personal_loan",
"student_loan",
"equipment_loan",
"credit_card",
"savings",
"cd",
"share_certificate",
"money_market",
"ira_cd",
"ira",
"share_savings"
],
"type": "string",
"description": "Exact product family."
},
"vehicle_condition": {
"enum": [
"new",
"used",
"certified_pre_owned",
"any"
],
"type": "string",
"description": "Vehicle condition."
}
},
"description": "Exact product request used for both eligibility-backed rate evaluation and ranking.",
"additionalProperties": false
},
"baseline_person": {
"type": "object",
"properties": {
"school": {
"type": "string",
"maxLength": 500,
"minLength": 1,
"description": "Person-supplied school name; school_relationship is needed for a typed positive path."
},
"worship": {
"type": "string",
"maxLength": 500,
"minLength": 1,
"description": "Person-supplied place of worship."
},
"employer": {
"type": "string",
"maxLength": 500,
"minLength": 1,
"description": "Person-supplied employer name; use employer_org_ids after authoritative resolution."
},
"home_zip": {
"type": "string",
"pattern": "^\\d{5}(?:-\\d{4})?$",
"description": "Home ZIP; never inferred from another role."
},
"work_zip": {
"type": "string",
"pattern": "^\\d{5}(?:-\\d{4})?$",
"description": "Worksite ZIP, separate from home and payroll."
},
"home_city": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"description": "Census-recognized home city."
},
"work_city": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"description": "Census-recognized worksite city."
},
"home_state": {
"type": "string",
"pattern": "^(?:[Aa][Ll]|[Aa][Kk]|[Aa][Zz]|[Aa][Rr]|[Cc][Aa]|[Cc][Oo]|[Cc][Tt]|[Dd][Ee]|[Dd][Cc]|[Ff][Ll]|[Gg][Aa]|[Hh][Ii]|[Ii][Dd]|[Ii][Ll]|[Ii][Nn]|[Ii][Aa]|[Kk][Ss]|[Kk][Yy]|[Ll][Aa]|[Mm][Ee]|[Mm][Dd]|[Mm][Aa]|[Mm][Ii]|[Mm][Nn]|[Mm][Ss]|[Mm][Oo]|[Mm][Tt]|[Nn][Ee]|[Nn][Vv]|[Nn][Hh]|[Nn][Jj]|[Nn][Mm]|[Nn][Yy]|[Nn][Cc]|[Nn][Dd]|[Oo][Hh]|[Oo][Kk]|[Oo][Rr]|[Pp][Aa]|[Rr][Ii]|[Ss][Cc]|[Ss][Dd]|[Tt][Nn]|[Tt][Xx]|[Uu][Tt]|[Vv][Tt]|[Vv][Aa]|[Ww][Aa]|[Ww][Vv]|[Ww][Ii]|[Ww][Yy])$",
"description": "Valid 50-state/DC home state."
},
"occupation": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"description": "Person-supplied occupation."
},
"work_state": {
"type": "string",
"pattern": "^(?:[Aa][Ll]|[Aa][Kk]|[Aa][Zz]|[Aa][Rr]|[Cc][Aa]|[Cc][Oo]|[Cc][Tt]|[Dd][Ee]|[Dd][Cc]|[Ff][Ll]|[Gg][Aa]|[Hh][Ii]|[Ii][Dd]|[Ii][Ll]|[Ii][Nn]|[Ii][Aa]|[Kk][Ss]|[Kk][Yy]|[Ll][Aa]|[Mm][Ee]|[Mm][Dd]|[Mm][Aa]|[Mm][Ii]|[Mm][Nn]|[Mm][Ss]|[Mm][Oo]|[Mm][Tt]|[Nn][Ee]|[Nn][Vv]|[Nn][Hh]|[Nn][Jj]|[Nn][Mm]|[Nn][Yy]|[Nn][Cc]|[Nn][Dd]|[Oo][Hh]|[Oo][Kk]|[Oo][Rr]|[Pp][Aa]|[Rr][Ii]|[Ss][Cc]|[Ss][Dd]|[Tt][Nn]|[Tt][Xx]|[Uu][Tt]|[Vv][Tt]|[Vv][Aa]|[Ww][Aa]|[Ww][Vv]|[Ww][Ii]|[Ww][Yy])$",
"description": "Valid 50-state/DC worksite state."
},
"home_county": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"description": "Home county."
},
"payroll_zip": {
"type": "string",
"pattern": "^\\d{5}(?:-\\d{4})?$",
"description": "Payroll-origin ZIP, separate from the worksite."
},
"work_county": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"description": "Worksite county."
},
"associations": {
"type": "array",
"items": {
"type": "string",
"maxLength": 500,
"minLength": 1
},
"maxItems": 20,
"description": "Associations the person already belongs to."
},
"facility_zip": {
"type": "string",
"pattern": "^\\d{5}(?:-\\d{4})?$",
"description": "ZIP where the applicant organization maintains a facility."
},
"payroll_city": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"description": "Census-recognized payroll-origin city."
},
"property_zip": {
"type": "string",
"pattern": "^\\d{5}(?:-\\d{4})?$",
"description": "ZIP where the person owns real property; never inferred from home."
},
"facility_city": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"description": "Census-recognized facility city."
},
"payroll_state": {
"type": "string",
"pattern": "^(?:[Aa][Ll]|[Aa][Kk]|[Aa][Zz]|[Aa][Rr]|[Cc][Aa]|[Cc][Oo]|[Cc][Tt]|[Dd][Ee]|[Dd][Cc]|[Ff][Ll]|[Gg][Aa]|[Hh][Ii]|[Ii][Dd]|[Ii][Ll]|[Ii][Nn]|[Ii][Aa]|[Kk][Ss]|[Kk][Yy]|[Ll][Aa]|[Mm][Ee]|[Mm][Dd]|[Mm][Aa]|[Mm][Ii]|[Mm][Nn]|[Mm][Ss]|[Mm][Oo]|[Mm][Tt]|[Nn][Ee]|[Nn][Vv]|[Nn][Hh]|[Nn][Jj]|[Nn][Mm]|[Nn][Yy]|[Nn][Cc]|[Nn][Dd]|[Oo][Hh]|[Oo][Kk]|[Oo][Rr]|[Pp][Aa]|[Rr][Ii]|[Ss][Cc]|[Ss][Dd]|[Tt][Nn]|[Tt][Xx]|[Uu][Tt]|[Vv][Tt]|[Vv][Aa]|[Ww][Aa]|[Ww][Vv]|[Ww][Ii]|[Ww][Yy])$",
"description": "Valid 50-state/DC payroll-origin state."
},
"property_city": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"description": "Census-recognized city where the person owns real property."
},
"applicant_kind": {
"enum": [
"person",
"trust",
"organization",
"partnership",
"corporation",
"other_legal_entity"
],
"type": "string",
"description": "What the applicant is; absence means a natural person."
},
"facility_state": {
"type": "string",
"pattern": "^(?:[Aa][Ll]|[Aa][Kk]|[Aa][Zz]|[Aa][Rr]|[Cc][Aa]|[Cc][Oo]|[Cc][Tt]|[Dd][Ee]|[Dd][Cc]|[Ff][Ll]|[Gg][Aa]|[Hh][Ii]|[Ii][Dd]|[Ii][Ll]|[Ii][Nn]|[Ii][Aa]|[Kk][Ss]|[Kk][Yy]|[Ll][Aa]|[Mm][Ee]|[Mm][Dd]|[Mm][Aa]|[Mm][Ii]|[Mm][Nn]|[Mm][Ss]|[Mm][Oo]|[Mm][Tt]|[Nn][Ee]|[Nn][Vv]|[Nn][Hh]|[Nn][Jj]|[Nn][Mm]|[Nn][Yy]|[Nn][Cc]|[Nn][Dd]|[Oo][Hh]|[Oo][Kk]|[Oo][Rr]|[Pp][Aa]|[Rr][Ii]|[Ss][Cc]|[Ss][Dd]|[Tt][Nn]|[Tt][Xx]|[Uu][Tt]|[Vv][Tt]|[Vv][Aa]|[Ww][Aa]|[Ww][Vv]|[Ww][Ii]|[Ww][Yy])$",
"description": "Valid 50-state/DC facility state."
},
"payroll_county": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"description": "Payroll-origin county."
},
"property_state": {
"type": "string",
"pattern": "^(?:[Aa][Ll]|[Aa][Kk]|[Aa][Zz]|[Aa][Rr]|[Cc][Aa]|[Cc][Oo]|[Cc][Tt]|[Dd][Ee]|[Dd][Cc]|[Ff][Ll]|[Gg][Aa]|[Hh][Ii]|[Ii][Dd]|[Ii][Ll]|[Ii][Nn]|[Ii][Aa]|[Kk][Ss]|[Kk][Yy]|[Ll][Aa]|[Mm][Ee]|[Mm][Dd]|[Mm][Aa]|[Mm][Ii]|[Mm][Nn]|[Mm][Ss]|[Mm][Oo]|[Mm][Tt]|[Nn][Ee]|[Nn][Vv]|[Nn][Hh]|[Nn][Jj]|[Nn][Mm]|[Nn][Yy]|[Nn][Cc]|[Nn][Dd]|[Oo][Hh]|[Oo][Kk]|[Oo][Rr]|[Pp][Aa]|[Rr][Ii]|[Ss][Cc]|[Ss][Dd]|[Tt][Nn]|[Tt][Xx]|[Uu][Tt]|[Vv][Tt]|[Vv][Aa]|[Ww][Aa]|[Ww][Vv]|[Ww][Ii]|[Ww][Yy])$",
"description": "Valid 50-state/DC property state."
},
"school_org_ids": {
"type": "array",
"items": {
"type": "string",
"pattern": "^[a-z0-9]+(?:-[a-z0-9]+)*$",
"maxLength": 80,
"minLength": 1
},
"maxItems": 20,
"description": "Explicit school ids returned by resolve_eligibility_entities; rates-api revalidates them.",
"uniqueItems": true
},
"facility_county": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"description": "County where the applicant organization maintains a facility."
},
"family_relation": {
"type": "string",
"maxLength": 60,
"minLength": 1,
"description": "Relationship to the relative whose affiliations are supplied."
},
"military_status": {
"enum": [
"active_duty",
"veteran",
"reservist",
"dod_civilian",
"military_family"
],
"type": "string",
"description": "Person-supplied military affiliation."
},
"property_county": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"description": "County where the person owns real property."
},
"worship_org_ids": {
"type": "array",
"items": {
"type": "string",
"pattern": "^[a-z0-9]+(?:-[a-z0-9]+)*$",
"maxLength": 80,
"minLength": 1
},
"maxItems": 20,
"description": "Explicit worship-organization ids returned by resolve_eligibility_entities; rates-api revalidates them.",
"uniqueItems": true
},
"employer_org_ids": {
"type": "array",
"items": {
"type": "string",
"pattern": "^[a-z0-9]+(?:-[a-z0-9]+)*$",
"maxLength": 80,
"minLength": 1
},
"maxItems": 20,
"description": "Explicit employer ids returned by resolve_eligibility_entities; rates-api revalidates type and active-publication authority.",
"uniqueItems": true
},
"relative_schools": {
"type": "array",
"items": {
"type": "string",
"maxLength": 500,
"minLength": 1
},
"maxItems": 20,
"description": "Schools of the named relative, not the applicant."
},
"relative_employers": {
"type": "array",
"items": {
"type": "string",
"maxLength": 500,
"minLength": 1
},
"maxItems": 20,
"description": "Employers of the named relative, not the applicant."
},
"association_org_ids": {
"type": "array",
"items": {
"type": "string",
"pattern": "^[a-z0-9]+(?:-[a-z0-9]+)*$",
"maxLength": 80,
"minLength": 1
},
"maxItems": 20,
"description": "Explicit association ids returned by resolve_eligibility_entities; rates-api revalidates them.",
"uniqueItems": true
},
"school_relationship": {
"enum": [
"student",
"alumni",
"employee"
],
"type": "string",
"description": "How the person relates to the supplied school."
},
"relative_memberships": {
"type": "array",
"items": {
"type": "object",
"required": [
"credit_union_id",
"relation",
"status"
],
"properties": {
"status": {
"enum": [
"current_member",
"deceased_member"
],
"type": "string",
"description": "Confirmed membership status."
},
"relation": {
"type": "string",
"maxLength": 60,
"minLength": 1,
"description": "Relative relationship."
},
"credit_union_id": {
"type": "string",
"maxLength": 300,
"minLength": 1,
"description": "Exact credit-union id."
}
},
"additionalProperties": false
},
"maxItems": 50,
"description": "Confirmed relative memberships, each scoped to one exact institution."
},
"relative_associations": {
"type": "array",
"items": {
"type": "string",
"maxLength": 500,
"minLength": 1
},
"maxItems": 20,
"description": "Associations of the named relative, not the applicant."
},
"military_service_state": {
"type": "string",
"pattern": "^(?:[Aa][Ll]|[Aa][Kk]|[Aa][Zz]|[Aa][Rr]|[Cc][Aa]|[Cc][Oo]|[Cc][Tt]|[Dd][Ee]|[Dd][Cc]|[Ff][Ll]|[Gg][Aa]|[Hh][Ii]|[Ii][Dd]|[Ii][Ll]|[Ii][Nn]|[Ii][Aa]|[Kk][Ss]|[Kk][Yy]|[Ll][Aa]|[Mm][Ee]|[Mm][Dd]|[Mm][Aa]|[Mm][Ii]|[Mm][Nn]|[Mm][Ss]|[Mm][Oo]|[Mm][Tt]|[Nn][Ee]|[Nn][Vv]|[Nn][Hh]|[Nn][Jj]|[Nn][Mm]|[Nn][Yy]|[Nn][Cc]|[Nn][Dd]|[Oo][Hh]|[Oo][Kk]|[Oo][Rr]|[Pp][Aa]|[Rr][Ii]|[Ss][Cc]|[Ss][Dd]|[Tt][Nn]|[Tt][Xx]|[Uu][Tt]|[Vv][Tt]|[Vv][Aa]|[Ww][Aa]|[Ww][Vv]|[Ww][Ii]|[Ww][Yy])$",
"description": "State tied to a state-scoped military affiliation."
},
"asserted_org_qualifiers": {
"type": "array",
"items": {
"type": "string",
"maxLength": 200,
"minLength": 1
},
"maxItems": 20,
"description": "Narrow conditions the person explicitly asserted; never infer them."
},
"relative_school_org_ids": {
"type": "array",
"items": {
"type": "string",
"pattern": "^[a-z0-9]+(?:-[a-z0-9]+)*$",
"maxLength": 80,
"minLength": 1
},
"maxItems": 20,
"description": "Canonical school ids belonging to the named relative, not the applicant.",
"uniqueItems": true
},
"relative_employer_org_ids": {
"type": "array",
"items": {
"type": "string",
"pattern": "^[a-z0-9]+(?:-[a-z0-9]+)*$",
"maxLength": 80,
"minLength": 1
},
"maxItems": 20,
"description": "Canonical employer ids belonging to the named relative, not the applicant.",
"uniqueItems": true
},
"willing_to_join_association": {
"type": "boolean",
"description": "Whether documented joinable-association actions may be considered."
},
"relative_association_org_ids": {
"type": "array",
"items": {
"type": "string",
"pattern": "^[a-z0-9]+(?:-[a-z0-9]+)*$",
"maxLength": 80,
"minLength": 1
},
"maxItems": 20,
"description": "Canonical association ids belonging to the named relative, not the applicant.",
"uniqueItems": true
}
},
"description": "Confirmed facts before the proposed change.",
"additionalProperties": false
},
"candidate_person": {
"type": "object",
"properties": {
"school": {
"type": "string",
"maxLength": 500,
"minLength": 1,
"description": "Person-supplied school name; school_relationship is needed for a typed positive path."
},
"worship": {
"type": "string",
"maxLength": 500,
"minLength": 1,
"description": "Person-supplied place of worship."
},
"employer": {
"type": "string",
"maxLength": 500,
"minLength": 1,
"description": "Person-supplied employer name; use employer_org_ids after authoritative resolution."
},
"home_zip": {
"type": "string",
"pattern": "^\\d{5}(?:-\\d{4})?$",
"description": "Home ZIP; never inferred from another role."
},
"work_zip": {
"type": "string",
"pattern": "^\\d{5}(?:-\\d{4})?$",
"description": "Worksite ZIP, separate from home and payroll."
},
"home_city": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"description": "Census-recognized home city."
},
"work_city": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"description": "Census-recognized worksite city."
},
"home_state": {
"type": "string",
"pattern": "^(?:[Aa][Ll]|[Aa][Kk]|[Aa][Zz]|[Aa][Rr]|[Cc][Aa]|[Cc][Oo]|[Cc][Tt]|[Dd][Ee]|[Dd][Cc]|[Ff][Ll]|[Gg][Aa]|[Hh][Ii]|[Ii][Dd]|[Ii][Ll]|[Ii][Nn]|[Ii][Aa]|[Kk][Ss]|[Kk][Yy]|[Ll][Aa]|[Mm][Ee]|[Mm][Dd]|[Mm][Aa]|[Mm][Ii]|[Mm][Nn]|[Mm][Ss]|[Mm][Oo]|[Mm][Tt]|[Nn][Ee]|[Nn][Vv]|[Nn][Hh]|[Nn][Jj]|[Nn][Mm]|[Nn][Yy]|[Nn][Cc]|[Nn][Dd]|[Oo][Hh]|[Oo][Kk]|[Oo][Rr]|[Pp][Aa]|[Rr][Ii]|[Ss][Cc]|[Ss][Dd]|[Tt][Nn]|[Tt][Xx]|[Uu][Tt]|[Vv][Tt]|[Vv][Aa]|[Ww][Aa]|[Ww][Vv]|[Ww][Ii]|[Ww][Yy])$",
"description": "Valid 50-state/DC home state."
},
"occupation": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"description": "Person-supplied occupation."
},
"work_state": {
"type": "string",
"pattern": "^(?:[Aa][Ll]|[Aa][Kk]|[Aa][Zz]|[Aa][Rr]|[Cc][Aa]|[Cc][Oo]|[Cc][Tt]|[Dd][Ee]|[Dd][Cc]|[Ff][Ll]|[Gg][Aa]|[Hh][Ii]|[Ii][Dd]|[Ii][Ll]|[Ii][Nn]|[Ii][Aa]|[Kk][Ss]|[Kk][Yy]|[Ll][Aa]|[Mm][Ee]|[Mm][Dd]|[Mm][Aa]|[Mm][Ii]|[Mm][Nn]|[Mm][Ss]|[Mm][Oo]|[Mm][Tt]|[Nn][Ee]|[Nn][Vv]|[Nn][Hh]|[Nn][Jj]|[Nn][Mm]|[Nn][Yy]|[Nn][Cc]|[Nn][Dd]|[Oo][Hh]|[Oo][Kk]|[Oo][Rr]|[Pp][Aa]|[Rr][Ii]|[Ss][Cc]|[Ss][Dd]|[Tt][Nn]|[Tt][Xx]|[Uu][Tt]|[Vv][Tt]|[Vv][Aa]|[Ww][Aa]|[Ww][Vv]|[Ww][Ii]|[Ww][Yy])$",
"description": "Valid 50-state/DC worksite state."
},
"home_county": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"description": "Home county."
},
"payroll_zip": {
"type": "string",
"pattern": "^\\d{5}(?:-\\d{4})?$",
"description": "Payroll-origin ZIP, separate from the worksite."
},
"work_county": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"description": "Worksite county."
},
"associations": {
"type": "array",
"items": {
"type": "string",
"maxLength": 500,
"minLength": 1
},
"maxItems": 20,
"description": "Associations the person already belongs to."
},
"facility_zip": {
"type": "string",
"pattern": "^\\d{5}(?:-\\d{4})?$",
"description": "ZIP where the applicant organization maintains a facility."
},
"payroll_city": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"description": "Census-recognized payroll-origin city."
},
"property_zip": {
"type": "string",
"pattern": "^\\d{5}(?:-\\d{4})?$",
"description": "ZIP where the person owns real property; never inferred from home."
},
"facility_city": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"description": "Census-recognized facility city."
},
"payroll_state": {
"type": "string",
"pattern": "^(?:[Aa][Ll]|[Aa][Kk]|[Aa][Zz]|[Aa][Rr]|[Cc][Aa]|[Cc][Oo]|[Cc][Tt]|[Dd][Ee]|[Dd][Cc]|[Ff][Ll]|[Gg][Aa]|[Hh][Ii]|[Ii][Dd]|[Ii][Ll]|[Ii][Nn]|[Ii][Aa]|[Kk][Ss]|[Kk][Yy]|[Ll][Aa]|[Mm][Ee]|[Mm][Dd]|[Mm][Aa]|[Mm][Ii]|[Mm][Nn]|[Mm][Ss]|[Mm][Oo]|[Mm][Tt]|[Nn][Ee]|[Nn][Vv]|[Nn][Hh]|[Nn][Jj]|[Nn][Mm]|[Nn][Yy]|[Nn][Cc]|[Nn][Dd]|[Oo][Hh]|[Oo][Kk]|[Oo][Rr]|[Pp][Aa]|[Rr][Ii]|[Ss][Cc]|[Ss][Dd]|[Tt][Nn]|[Tt][Xx]|[Uu][Tt]|[Vv][Tt]|[Vv][Aa]|[Ww][Aa]|[Ww][Vv]|[Ww][Ii]|[Ww][Yy])$",
"description": "Valid 50-state/DC payroll-origin state."
},
"property_city": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"description": "Census-recognized city where the person owns real property."
},
"applicant_kind": {
"enum": [
"person",
"trust",
"organization",
"partnership",
"corporation",
"other_legal_entity"
],
"type": "string",
"description": "What the applicant is; absence means a natural person."
},
"facility_state": {
"type": "string",
"pattern": "^(?:[Aa][Ll]|[Aa][Kk]|[Aa][Zz]|[Aa][Rr]|[Cc][Aa]|[Cc][Oo]|[Cc][Tt]|[Dd][Ee]|[Dd][Cc]|[Ff][Ll]|[Gg][Aa]|[Hh][Ii]|[Ii][Dd]|[Ii][Ll]|[Ii][Nn]|[Ii][Aa]|[Kk][Ss]|[Kk][Yy]|[Ll][Aa]|[Mm][Ee]|[Mm][Dd]|[Mm][Aa]|[Mm][Ii]|[Mm][Nn]|[Mm][Ss]|[Mm][Oo]|[Mm][Tt]|[Nn][Ee]|[Nn][Vv]|[Nn][Hh]|[Nn][Jj]|[Nn][Mm]|[Nn][Yy]|[Nn][Cc]|[Nn][Dd]|[Oo][Hh]|[Oo][Kk]|[Oo][Rr]|[Pp][Aa]|[Rr][Ii]|[Ss][Cc]|[Ss][Dd]|[Tt][Nn]|[Tt][Xx]|[Uu][Tt]|[Vv][Tt]|[Vv][Aa]|[Ww][Aa]|[Ww][Vv]|[Ww][Ii]|[Ww][Yy])$",
"description": "Valid 50-state/DC facility state."
},
"payroll_county": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"description": "Payroll-origin county."
},
"property_state": {
"type": "string",
"pattern": "^(?:[Aa][Ll]|[Aa][Kk]|[Aa][Zz]|[Aa][Rr]|[Cc][Aa]|[Cc][Oo]|[Cc][Tt]|[Dd][Ee]|[Dd][Cc]|[Ff][Ll]|[Gg][Aa]|[Hh][Ii]|[Ii][Dd]|[Ii][Ll]|[Ii][Nn]|[Ii][Aa]|[Kk][Ss]|[Kk][Yy]|[Ll][Aa]|[Mm][Ee]|[Mm][Dd]|[Mm][Aa]|[Mm][Ii]|[Mm][Nn]|[Mm][Ss]|[Mm][Oo]|[Mm][Tt]|[Nn][Ee]|[Nn][Vv]|[Nn][Hh]|[Nn][Jj]|[Nn][Mm]|[Nn][Yy]|[Nn][Cc]|[Nn][Dd]|[Oo][Hh]|[Oo][Kk]|[Oo][Rr]|[Pp][Aa]|[Rr][Ii]|[Ss][Cc]|[Ss][Dd]|[Tt][Nn]|[Tt][Xx]|[Uu][Tt]|[Vv][Tt]|[Vv][Aa]|[Ww][Aa]|[Ww][Vv]|[Ww][Ii]|[Ww][Yy])$",
"description": "Valid 50-state/DC property state."
},
"school_org_ids": {
"type": "array",
"items": {
"type": "string",
"pattern": "^[a-z0-9]+(?:-[a-z0-9]+)*$",
"maxLength": 80,
"minLength": 1
},
"maxItems": 20,
"description": "Explicit school ids returned by resolve_eligibility_entities; rates-api revalidates them.",
"uniqueItems": true
},
"facility_county": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"description": "County where the applicant organization maintains a facility."
},
"family_relation": {
"type": "string",
"maxLength": 60,
"minLength": 1,
"description": "Relationship to the relative whose affiliations are supplied."
},
"military_status": {
"enum": [
"active_duty",
"veteran",
"reservist",
"dod_civilian",
"military_family"
],
"type": "string",
"description": "Person-supplied military affiliation."
},
"property_county": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"description": "County where the person owns real property."
},
"worship_org_ids": {
"type": "array",
"items": {
"type": "string",
"pattern": "^[a-z0-9]+(?:-[a-z0-9]+)*$",
"maxLength": 80,
"minLength": 1
},
"maxItems": 20,
"description": "Explicit worship-organization ids returned by resolve_eligibility_entities; rates-api revalidates them.",
"uniqueItems": true
},
"employer_org_ids": {
"type": "array",
"items": {
"type": "string",
"pattern": "^[a-z0-9]+(?:-[a-z0-9]+)*$",
"maxLength": 80,
"minLength": 1
},
"maxItems": 20,
"description": "Explicit employer ids returned by resolve_eligibility_entities; rates-api revalidates type and active-publication authority.",
"uniqueItems": true
},
"relative_schools": {
"type": "array",
"items": {
"type": "string",
"maxLength": 500,
"minLength": 1
},
"maxItems": 20,
"description": "Schools of the named relative, not the applicant."
},
"relative_employers": {
"type": "array",
"items": {
"type": "string",
"maxLength": 500,
"minLength": 1
},
"maxItems": 20,
"description": "Employers of the named relative, not the applicant."
},
"association_org_ids": {
"type": "array",
"items": {
"type": "string",
"pattern": "^[a-z0-9]+(?:-[a-z0-9]+)*$",
"maxLength": 80,
"minLength": 1
},
"maxItems": 20,
"description": "Explicit association ids returned by resolve_eligibility_entities; rates-api revalidates them.",
"uniqueItems": true
},
"school_relationship": {
"enum": [
"student",
"alumni",
"employee"
],
"type": "string",
"description": "How the person relates to the supplied school."
},
"relative_memberships": {
"type": "array",
"items": {
"type": "object",
"required": [
"credit_union_id",
"relation",
"status"
],
"properties": {
"status": {
"enum": [
"current_member",
"deceased_member"
],
"type": "string",
"description": "Confirmed membership status."
},
"relation": {
"type": "string",
"maxLength": 60,
"minLength": 1,
"description": "Relative relationship."
},
"credit_union_id": {
"type": "string",
"maxLength": 300,
"minLength": 1,
"description": "Exact credit-union id."
}
},
"additionalProperties": false
},
"maxItems": 50,
"description": "Confirmed relative memberships, each scoped to one exact institution."
},
"relative_associations": {
"type": "array",
"items": {
"type": "string",
"maxLength": 500,
"minLength": 1
},
"maxItems": 20,
"description": "Associations of the named relative, not the applicant."
},
"military_service_state": {
"type": "string",
"pattern": "^(?:[Aa][Ll]|[Aa][Kk]|[Aa][Zz]|[Aa][Rr]|[Cc][Aa]|[Cc][Oo]|[Cc][Tt]|[Dd][Ee]|[Dd][Cc]|[Ff][Ll]|[Gg][Aa]|[Hh][Ii]|[Ii][Dd]|[Ii][Ll]|[Ii][Nn]|[Ii][Aa]|[Kk][Ss]|[Kk][Yy]|[Ll][Aa]|[Mm][Ee]|[Mm][Dd]|[Mm][Aa]|[Mm][Ii]|[Mm][Nn]|[Mm][Ss]|[Mm][Oo]|[Mm][Tt]|[Nn][Ee]|[Nn][Vv]|[Nn][Hh]|[Nn][Jj]|[Nn][Mm]|[Nn][Yy]|[Nn][Cc]|[Nn][Dd]|[Oo][Hh]|[Oo][Kk]|[Oo][Rr]|[Pp][Aa]|[Rr][Ii]|[Ss][Cc]|[Ss][Dd]|[Tt][Nn]|[Tt][Xx]|[Uu][Tt]|[Vv][Tt]|[Vv][Aa]|[Ww][Aa]|[Ww][Vv]|[Ww][Ii]|[Ww][Yy])$",
"description": "State tied to a state-scoped military affiliation."
},
"asserted_org_qualifiers": {
"type": "array",
"items": {
"type": "string",
"maxLength": 200,
"minLength": 1
},
"maxItems": 20,
"description": "Narrow conditions the person explicitly asserted; never infer them."
},
"relative_school_org_ids": {
"type": "array",
"items": {
"type": "string",
"pattern": "^[a-z0-9]+(?:-[a-z0-9]+)*$",
"maxLength": 80,
"minLength": 1
},
"maxItems": 20,
"description": "Canonical school ids belonging to the named relative, not the applicant.",
"uniqueItems": true
},
"relative_employer_org_ids": {
"type": "array",
"items": {
"type": "string",
"pattern": "^[a-z0-9]+(?:-[a-z0-9]+)*$",
"maxLength": 80,
"minLength": 1
},
"maxItems": 20,
"description": "Canonical employer ids belonging to the named relative, not the applicant.",
"uniqueItems": true
},
"willing_to_join_association": {
"type": "boolean",
"description": "Whether documented joinable-association actions may be considered."
},
"relative_association_org_ids": {
"type": "array",
"items": {
"type": "string",
"pattern": "^[a-z0-9]+(?:-[a-z0-9]+)*$",
"maxLength": 80,
"minLength": 1
},
"maxItems": 20,
"description": "Canonical association ids belonging to the named relative, not the applicant.",
"uniqueItems": true
}
},
"description": "Confirmed facts after the proposed change.",
"additionalProperties": false
}
},
"additionalProperties": false
}Apples-to-apples multi-lender ranking by TOTAL cost of a loan (upfront origination/lender fees + lifetime interest over the holding period), not just the headline rate. Re-ranks real credit union offers and flags when the lowest-rate lender is not the cheapest overall.
| Argument | Type | Description |
|---|---|---|
| fees | object | |
| state* | string | 2-letter US state |
| amount* | number | Loan principal |
| intent | string | default purchase |
| max_lenders | number | cap on ranked rows (default 10, max 25) |
| term_months | number | |
| credit_score | number | |
| product_type* | string | Loan product to rank |
| down_payment_percent | number | |
Subscribe a monitor to a SPECIFIC named credit union's published rate and alert via webhook when that CU changes its rate (vs the aggregate market-best decision). Returns the monitor with a webhook_signing_secret (shown once) and a baseline snapshot of the CU's current rate.
| Argument | Type | Description |
|---|---|---|
| name* | string | Descriptive monitor name. Required. |
| state | string | 2-letter state for the CU published rate. |
| audience | string | Scope offers by WHO they are for: 'business' returns business-audience products (DSCR mortgages, commercial vehicle loans, SBA); 'consumer' excludes them. Omit for both. |
| occupancy | string | MORTGAGE/HELOC: property occupancy. 'investment' returns investor / non-owner-occupied / DSCR pricing; 'secondary' second-home pricing. Omit for standard primary-residence offers. |
| conditions | object | Alert conditions on the named CU rate. Default: any change. |
| webhook_url* | string | HTTPS webhook. Required. |
| loan_program | string | e.g. '30-year-fixed'. |
| product_type | string |
Create a branded rate-email campaign: on a cadence, email the campaign's recipient list the latest rates for one or more states (or a named region preset) under the org's branding, with ONE OR MORE products (1-5, no duplicates). Each product is one of: {category:'mortgage', subtype:'30-year-fixed'|'15-year-fixed'}, {category:'auto', condition:'new'|'used'|'any', term_months?:36|48|60|72|84} (auto = cars only), or {category:'rv'|'boat'|'motorcycle', condition:'new'|'used'|'any'}. Defaults to a single 30-year-fixed mortgage if products is omitted. Created 'paused'; add recipients, then activate via update_email_campaign (activation requires branding display_name + business_address). Requires a Pro plan. Provide exactly one of state_code, state_codes, or region.
| Argument | Type | Description |
|---|---|---|
| name* | string | Campaign label. Required. |
| region | string | Named region preset (e.g. east_coast); expands server-side to its member states. |
| cadence | string | Send cadence (default weekly). |
| products | array | 1-5 products to feature (no duplicates). Each is {category:'mortgage', subtype:'30-year-fixed'|'15-year-fixed'}, {category:'auto', condition:'new'|'used'|'any', term_months?:36|48|60|72|84}, or {category:'rv'|'boat'|'motorcycle', condition:'new'|'used'|'any'}. |
| state_code | string | Legacy single 2-letter US state code (e.g. CA). Prefer state_codes or region for multi-state coverage. |
| state_codes | array |
Create a new decision monitor that watches for rate changes and sends webhook notifications when conditions are met. Returns the monitor with a webhook_signing_secret for verifying webhook payloads.
| Argument | Type | Description |
|---|---|---|
| name* | string | A descriptive name for the monitor. Required. |
| conditions* | array | Array of conditions that must be met to trigger the monitor. Required. |
| webhook_url* | string | The URL to send webhook notifications to. Required. |
| cooldown_hours | number | Minimum hours between webhook triggers (1-168). Defaults to 24. |
| decision_context* | object | The context for evaluating rate changes. Required. |
| subscribed_states | array | Optional array of state codes to monitor. If not provided, monitors all states. |
| subscribed_product_types | array | Optional array of product types to monitor (e.g., ["30yr_fixed", "15yr_fixed"]). |
{
"type": "object",
"required": [
"name",
"decision_context",
"conditions",
"webhook_url"
],
"properties": {
"name": {
"type": "string",
"description": "A descriptive name for the monitor. Required."
},
"conditions": {
"type": "array",
"items": {
"type": "object",
"required": [
"field",
"operator",
"value"
],
"properties": {
"field": {
"enum": [
"rate",
"apr",
"monthly_payment"
],
"type": "string",
"description": "The field to evaluate."
},
"value": {
"type": "number",
"description": "The value to compare against."
},
"operator": {
"enum": [
"lt",
"lte",
"gt",
"gte",
"eq",
"change_pct"
],
"type": "string",
"description": "Comparison operator (lt=less than, lte=less than or equal, gt=greater than, gte=greater than or equal, eq=equal, change_pct=percentage change)."
}
}
},
"description": "Array of conditions that must be met to trigger the monitor. Required."
},
"webhook_url": {
"type": "string",
"description": "The URL to send webhook notifications to. Required."
},
"cooldown_hours": {
"type": "number",
"description": "Minimum hours between webhook triggers (1-168). Defaults to 24."
},
"decision_context": {
"type": "object",
"required": [
"state",
"intent",
"amount"
],
"properties": {
"state": {
"type": "string",
"description": "US state code (2-letter, e.g., CA, TX, NY). Required."
},
"amount": {
"type": "number",
"description": "Loan amount in dollars (minimum 1000). Required."
},
"intent": {
"enum": [
"purchase",
"refinance",
"cash_out",
"balance_transfer",
"new_credit"
],
"type": "string",
"description": "The loan intent. Required."
},
"term_months": {
"type": "number",
"description": "Loan term in months (12-480). Defaults to 360 (30-year mortgage)."
},
"product_type": {
"type": "string",
"description": "Type of loan product. Defaults to \"mortgage\"."
}
},
"description": "The context for evaluating rate changes. Required."
},
"subscribed_states": {
"type": "array",
"items": {
"type": "string"
},
"description": "Optional array of state codes to monitor. If not provided, monitors all states."
},
"subscribed_product_types": {
"type": "array",
"items": {
"type": "string"
},
"description": "Optional array of product types to monitor (e.g., [\"30yr_fixed\", \"15yr_fixed\"])."
}
}
}Permanently delete a saved cohort by id. This action cannot be undone.
| Argument | Type | Description |
|---|---|---|
| id* | string | Cohort id. Required. |
{
"type": "object",
"required": [
"id"
],
"properties": {
"id": {
"type": "string",
"description": "Cohort id. Required."
}
}
}Delete a scheduled digest by id. Stops the recurring email.
| Argument | Type | Description |
|---|---|---|
| id* | string | The digest id to delete. |
{
"type": "object",
"required": [
"id"
],
"properties": {
"id": {
"type": "string",
"description": "The digest id to delete."
}
}
}Delete a branded rate-email campaign and its recipients. This cannot be undone.
| Argument | Type | Description |
|---|---|---|
| id* | string | Campaign id. Required. |
{
"type": "object",
"required": [
"id"
],
"properties": {
"id": {
"type": "string",
"description": "Campaign id. Required."
}
}
}Permanently delete a monitor. This action cannot be undone.
| Argument | Type | Description |
|---|---|---|
| monitor_id* | string | The unique identifier of the monitor to delete. Required. |
{
"type": "object",
"required": [
"monitor_id"
],
"properties": {
"monitor_id": {
"type": "string",
"description": "The unique identifier of the monitor to delete. Required."
}
}
}Delete a saved scenario by id.
| Argument | Type | Description |
|---|---|---|
| id* | string | Scenario id |
{
"type": "object",
"required": [
"id"
],
"properties": {
"id": {
"type": "string",
"description": "Scenario id"
}
}
}Send a test webhook for a monitor using a simulated rate change. This actually delivers an HTTP request to the monitor's configured webhook URL. IMPORTANT: a test delivery is NOT signed with the monitor's signing secret — only a hash of that secret is stored, so test deliveries use a placeholder and will FAIL signature verification. Use this to test payload handling, not signature verification. Only use when the user explicitly requests a test webhook delivery.
| Argument | Type | Description |
|---|---|---|
| monitor_id* | string | The unique identifier of the monitor to test. Required. |
| rate_change* | object | The simulated rate change event. Required. |
{
"type": "object",
"required": [
"monitor_id",
"rate_change"
],
"properties": {
"monitor_id": {
"type": "string",
"description": "The unique identifier of the monitor to test. Required."
},
"rate_change": {
"type": "object",
"required": [
"state",
"product_type",
"previous_rate",
"new_rate"
],
"properties": {
"state": {
"type": "string",
"description": "US state code where the rate changed. Required."
},
"new_rate": {
"type": "number",
"description": "The new rate value. Required."
},
"product_type": {
"type": "string",
"description": "The product type that changed (e.g., \"30yr_fixed\"). Required."
},
"previous_rate": {
"type": "number",
"description": "The previous rate value. Required."
}
},
"description": "The simulated rate change event. Required."
}
}
}Borrower-facing home affordability estimate: given gross income, existing monthly debts, down payment, and front-end/back-end DTI caps, compute the max monthly payment, max loan amount, and max home price. Surfaces the max_loan annuity engine. If no rate is supplied, the current best market rate for the state is used.
| Argument | Type | Description |
|---|---|---|
| rate | number | Optional annual interest rate, e.g. 6.5. If omitted, best market rate is used. |
| state | string | US state code for the market-rate lookup. Default CA. |
| term_months | number | Loan term in months. Default 360. |
| back_end_dti | number | Total-debt DTI cap as a decimal. Default 0.36. |
| down_payment | number | Cash down payment in dollars. Default 0. |
| product_type | string | Product for the market-rate lookup. Default mortgage. |
| front_end_dti | number | Housing-payment DTI cap as a decimal. Default 0.28. |
| income_annual* | number |
Total monthly housing cost (PITI): principal+interest plus property tax, homeowners insurance, PMI, and HOA, so affordability reflects real monthly outlay. If no rate is supplied, the current best market rate for the state is used.
| Argument | Type | Description |
|---|---|---|
| rate | number | Annual interest rate, e.g. 6.5. If omitted, best market rate for the state is used. |
| state | string | 2-letter US state code for the market-rate lookup. Default CA. |
| pmi_rate | number | Annual PMI as % of loan balance. Default 0.5, applied only when LTV > 80%. |
| home_price | number | Purchase price in dollars. Required unless loan_amount is given. |
| loan_amount | number | Optional explicit loan amount; overrides home_price - down_payment. |
| monthly_hoa | number | HOA dues in dollars/month. Default 0. |
| term_months | number | Loan term in months. Default 360. |
| credit_score | number | Optional borrower credit score, used for the market-rate lookup. |
Evaluate a caller-supplied panel of 1-10 named fact profiles for one exact product against one serving snapshot, deduplicating reachable institutions and exact offers. This is descriptive only for the supplied panel: never call it a population estimate, conversion rate, approval forecast, or negative eligibility result. Use neutral profile labels instead of names, emails, account numbers, or other direct identifiers. Profiles are forwarded transiently and are not stored by this tool; unknown remains unknown.
| Argument | Type | Description |
|---|---|---|
| limit | integer | Maximum aggregate institutions and deduplicated offers returned. |
| product* | object | Exact product request used for both eligibility-backed rate evaluation and ranking. |
| profiles* | array | Caller-supplied named panel. Names must be unique within this request. |
{
"type": "object",
"required": [
"profiles",
"product"
],
"properties": {
"limit": {
"type": "integer",
"default": 50,
"maximum": 200,
"minimum": 1,
"description": "Maximum aggregate institutions and deduplicated offers returned."
},
"product": {
"type": "object",
"required": [
"product_type"
],
"properties": {
"amount": {
"type": "number",
"description": "Loan or credit amount in USD.",
"exclusiveMinimum": 0
},
"intent": {
"enum": [
"purchase",
"refinance",
"cash_out",
"balance_transfer",
"new_credit"
],
"type": "string",
"description": "Transaction intent when relevant."
},
"balance": {
"type": "number",
"minimum": 0,
"description": "Deposit balance in USD."
},
"audience": {
"enum": [
"business",
"consumer"
],
"type": "string",
"description": "Product audience."
},
"occupancy": {
"enum": [
"primary",
"secondary",
"investment"
],
"type": "string",
"description": "Property occupancy."
},
"term_months": {
"type": "integer",
"maximum": 600,
"minimum": 1,
"description": "Requested term in months."
},
"product_type": {
"enum": [
"mortgage",
"mortgage_arm",
"auto_loan",
"rv",
"boat",
"motorcycle",
"powersports",
"heloc",
"personal_loan",
"student_loan",
"equipment_loan",
"credit_card",
"savings",
"cd",
"share_certificate",
"money_market",
"ira_cd",
"ira",
"share_savings"
],
"type": "string",
"description": "Exact product family."
},
"vehicle_condition": {
"enum": [
"new",
"used",
"certified_pre_owned",
"any"
],
"type": "string",
"description": "Vehicle condition."
}
},
"description": "Exact product request used for both eligibility-backed rate evaluation and ranking.",
"additionalProperties": false
},
"profiles": {
"type": "array",
"items": {
"type": "object",
"required": [
"name",
"person"
],
"properties": {
"name": {
"type": "string",
"maxLength": 120,
"minLength": 1,
"description": "Unique neutral panel label, such as profile-01; do not put PII here."
},
"person": {
"type": "object",
"properties": {
"school": {
"type": "string",
"maxLength": 500,
"minLength": 1,
"description": "Person-supplied school name; school_relationship is needed for a typed positive path."
},
"worship": {
"type": "string",
"maxLength": 500,
"minLength": 1,
"description": "Person-supplied place of worship."
},
"employer": {
"type": "string",
"maxLength": 500,
"minLength": 1,
"description": "Person-supplied employer name; use employer_org_ids after authoritative resolution."
},
"home_zip": {
"type": "string",
"pattern": "^\\d{5}(?:-\\d{4})?$",
"description": "Home ZIP; never inferred from another role."
},
"work_zip": {
"type": "string",
"pattern": "^\\d{5}(?:-\\d{4})?$",
"description": "Worksite ZIP, separate from home and payroll."
},
"home_city": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"description": "Census-recognized home city."
},
"work_city": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"description": "Census-recognized worksite city."
},
"home_state": {
"type": "string",
"pattern": "^(?:[Aa][Ll]|[Aa][Kk]|[Aa][Zz]|[Aa][Rr]|[Cc][Aa]|[Cc][Oo]|[Cc][Tt]|[Dd][Ee]|[Dd][Cc]|[Ff][Ll]|[Gg][Aa]|[Hh][Ii]|[Ii][Dd]|[Ii][Ll]|[Ii][Nn]|[Ii][Aa]|[Kk][Ss]|[Kk][Yy]|[Ll][Aa]|[Mm][Ee]|[Mm][Dd]|[Mm][Aa]|[Mm][Ii]|[Mm][Nn]|[Mm][Ss]|[Mm][Oo]|[Mm][Tt]|[Nn][Ee]|[Nn][Vv]|[Nn][Hh]|[Nn][Jj]|[Nn][Mm]|[Nn][Yy]|[Nn][Cc]|[Nn][Dd]|[Oo][Hh]|[Oo][Kk]|[Oo][Rr]|[Pp][Aa]|[Rr][Ii]|[Ss][Cc]|[Ss][Dd]|[Tt][Nn]|[Tt][Xx]|[Uu][Tt]|[Vv][Tt]|[Vv][Aa]|[Ww][Aa]|[Ww][Vv]|[Ww][Ii]|[Ww][Yy])$",
"description": "Valid 50-state/DC home state."
},
"occupation": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"description": "Person-supplied occupation."
},
"work_state": {
"type": "string",
"pattern": "^(?:[Aa][Ll]|[Aa][Kk]|[Aa][Zz]|[Aa][Rr]|[Cc][Aa]|[Cc][Oo]|[Cc][Tt]|[Dd][Ee]|[Dd][Cc]|[Ff][Ll]|[Gg][Aa]|[Hh][Ii]|[Ii][Dd]|[Ii][Ll]|[Ii][Nn]|[Ii][Aa]|[Kk][Ss]|[Kk][Yy]|[Ll][Aa]|[Mm][Ee]|[Mm][Dd]|[Mm][Aa]|[Mm][Ii]|[Mm][Nn]|[Mm][Ss]|[Mm][Oo]|[Mm][Tt]|[Nn][Ee]|[Nn][Vv]|[Nn][Hh]|[Nn][Jj]|[Nn][Mm]|[Nn][Yy]|[Nn][Cc]|[Nn][Dd]|[Oo][Hh]|[Oo][Kk]|[Oo][Rr]|[Pp][Aa]|[Rr][Ii]|[Ss][Cc]|[Ss][Dd]|[Tt][Nn]|[Tt][Xx]|[Uu][Tt]|[Vv][Tt]|[Vv][Aa]|[Ww][Aa]|[Ww][Vv]|[Ww][Ii]|[Ww][Yy])$",
"description": "Valid 50-state/DC worksite state."
},
"home_county": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"description": "Home county."
},
"payroll_zip": {
"type": "string",
"pattern": "^\\d{5}(?:-\\d{4})?$",
"description": "Payroll-origin ZIP, separate from the worksite."
},
"work_county": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"description": "Worksite county."
},
"associations": {
"type": "array",
"items": {
"type": "string",
"maxLength": 500,
"minLength": 1
},
"maxItems": 20,
"description": "Associations the person already belongs to."
},
"facility_zip": {
"type": "string",
"pattern": "^\\d{5}(?:-\\d{4})?$",
"description": "ZIP where the applicant organization maintains a facility."
},
"payroll_city": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"description": "Census-recognized payroll-origin city."
},
"property_zip": {
"type": "string",
"pattern": "^\\d{5}(?:-\\d{4})?$",
"description": "ZIP where the person owns real property; never inferred from home."
},
"facility_city": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"description": "Census-recognized facility city."
},
"payroll_state": {
"type": "string",
"pattern": "^(?:[Aa][Ll]|[Aa][Kk]|[Aa][Zz]|[Aa][Rr]|[Cc][Aa]|[Cc][Oo]|[Cc][Tt]|[Dd][Ee]|[Dd][Cc]|[Ff][Ll]|[Gg][Aa]|[Hh][Ii]|[Ii][Dd]|[Ii][Ll]|[Ii][Nn]|[Ii][Aa]|[Kk][Ss]|[Kk][Yy]|[Ll][Aa]|[Mm][Ee]|[Mm][Dd]|[Mm][Aa]|[Mm][Ii]|[Mm][Nn]|[Mm][Ss]|[Mm][Oo]|[Mm][Tt]|[Nn][Ee]|[Nn][Vv]|[Nn][Hh]|[Nn][Jj]|[Nn][Mm]|[Nn][Yy]|[Nn][Cc]|[Nn][Dd]|[Oo][Hh]|[Oo][Kk]|[Oo][Rr]|[Pp][Aa]|[Rr][Ii]|[Ss][Cc]|[Ss][Dd]|[Tt][Nn]|[Tt][Xx]|[Uu][Tt]|[Vv][Tt]|[Vv][Aa]|[Ww][Aa]|[Ww][Vv]|[Ww][Ii]|[Ww][Yy])$",
"description": "Valid 50-state/DC payroll-origin state."
},
"property_city": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"description": "Census-recognized city where the person owns real property."
},
"applicant_kind": {
"enum": [
"person",
"trust",
"organization",
"partnership",
"corporation",
"other_legal_entity"
],
"type": "string",
"description": "What the applicant is; absence means a natural person."
},
"facility_state": {
"type": "string",
"pattern": "^(?:[Aa][Ll]|[Aa][Kk]|[Aa][Zz]|[Aa][Rr]|[Cc][Aa]|[Cc][Oo]|[Cc][Tt]|[Dd][Ee]|[Dd][Cc]|[Ff][Ll]|[Gg][Aa]|[Hh][Ii]|[Ii][Dd]|[Ii][Ll]|[Ii][Nn]|[Ii][Aa]|[Kk][Ss]|[Kk][Yy]|[Ll][Aa]|[Mm][Ee]|[Mm][Dd]|[Mm][Aa]|[Mm][Ii]|[Mm][Nn]|[Mm][Ss]|[Mm][Oo]|[Mm][Tt]|[Nn][Ee]|[Nn][Vv]|[Nn][Hh]|[Nn][Jj]|[Nn][Mm]|[Nn][Yy]|[Nn][Cc]|[Nn][Dd]|[Oo][Hh]|[Oo][Kk]|[Oo][Rr]|[Pp][Aa]|[Rr][Ii]|[Ss][Cc]|[Ss][Dd]|[Tt][Nn]|[Tt][Xx]|[Uu][Tt]|[Vv][Tt]|[Vv][Aa]|[Ww][Aa]|[Ww][Vv]|[Ww][Ii]|[Ww][Yy])$",
"description": "Valid 50-state/DC facility state."
},
"payroll_county": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"description": "Payroll-origin county."
},
"property_state": {
"type": "string",
"pattern": "^(?:[Aa][Ll]|[Aa][Kk]|[Aa][Zz]|[Aa][Rr]|[Cc][Aa]|[Cc][Oo]|[Cc][Tt]|[Dd][Ee]|[Dd][Cc]|[Ff][Ll]|[Gg][Aa]|[Hh][Ii]|[Ii][Dd]|[Ii][Ll]|[Ii][Nn]|[Ii][Aa]|[Kk][Ss]|[Kk][Yy]|[Ll][Aa]|[Mm][Ee]|[Mm][Dd]|[Mm][Aa]|[Mm][Ii]|[Mm][Nn]|[Mm][Ss]|[Mm][Oo]|[Mm][Tt]|[Nn][Ee]|[Nn][Vv]|[Nn][Hh]|[Nn][Jj]|[Nn][Mm]|[Nn][Yy]|[Nn][Cc]|[Nn][Dd]|[Oo][Hh]|[Oo][Kk]|[Oo][Rr]|[Pp][Aa]|[Rr][Ii]|[Ss][Cc]|[Ss][Dd]|[Tt][Nn]|[Tt][Xx]|[Uu][Tt]|[Vv][Tt]|[Vv][Aa]|[Ww][Aa]|[Ww][Vv]|[Ww][Ii]|[Ww][Yy])$",
"description": "Valid 50-state/DC property state."
},
"school_org_ids": {
"type": "array",
"items": {
"type": "string",
"pattern": "^[a-z0-9]+(?:-[a-z0-9]+)*$",
"maxLength": 80,
"minLength": 1
},
"maxItems": 20,
"description": "Explicit school ids returned by resolve_eligibility_entities; rates-api revalidates them.",
"uniqueItems": true
},
"facility_county": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"description": "County where the applicant organization maintains a facility."
},
"family_relation": {
"type": "string",
"maxLength": 60,
"minLength": 1,
"description": "Relationship to the relative whose affiliations are supplied."
},
"military_status": {
"enum": [
"active_duty",
"veteran",
"reservist",
"dod_civilian",
"military_family"
],
"type": "string",
"description": "Person-supplied military affiliation."
},
"property_county": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"description": "County where the person owns real property."
},
"worship_org_ids": {
"type": "array",
"items": {
"type": "string",
"pattern": "^[a-z0-9]+(?:-[a-z0-9]+)*$",
"maxLength": 80,
"minLength": 1
},
"maxItems": 20,
"description": "Explicit worship-organization ids returned by resolve_eligibility_entities; rates-api revalidates them.",
"uniqueItems": true
},
"employer_org_ids": {
"type": "array",
"items": {
"type": "string",
"pattern": "^[a-z0-9]+(?:-[a-z0-9]+)*$",
"maxLength": 80,
"minLength": 1
},
"maxItems": 20,
"description": "Explicit employer ids returned by resolve_eligibility_entities; rates-api revalidates type and active-publication authority.",
"uniqueItems": true
},
"relative_schools": {
"type": "array",
"items": {
"type": "string",
"maxLength": 500,
"minLength": 1
},
"maxItems": 20,
"description": "Schools of the named relative, not the applicant."
},
"relative_employers": {
"type": "array",
"items": {
"type": "string",
"maxLength": 500,
"minLength": 1
},
"maxItems": 20,
"description": "Employers of the named relative, not the applicant."
},
"association_org_ids": {
"type": "array",
"items": {
"type": "string",
"pattern": "^[a-z0-9]+(?:-[a-z0-9]+)*$",
"maxLength": 80,
"minLength": 1
},
"maxItems": 20,
"description": "Explicit association ids returned by resolve_eligibility_entities; rates-api revalidates them.",
"uniqueItems": true
},
"school_relationship": {
"enum": [
"student",
"alumni",
"employee"
],
"type": "string",
"description": "How the person relates to the supplied school."
},
"relative_memberships": {
"type": "array",
"items": {
"type": "object",
"required": [
"credit_union_id",
"relation",
"status"
],
"properties": {
"status": {
"enum": [
"current_member",
"deceased_member"
],
"type": "string",
"description": "Confirmed membership status."
},
"relation": {
"type": "string",
"maxLength": 60,
"minLength": 1,
"description": "Relative relationship."
},
"credit_union_id": {
"type": "string",
"maxLength": 300,
"minLength": 1,
"description": "Exact credit-union id."
}
},
"additionalProperties": false
},
"maxItems": 50,
"description": "Confirmed relative memberships, each scoped to one exact institution."
},
"relative_associations": {
"type": "array",
"items": {
"type": "string",
"maxLength": 500,
"minLength": 1
},
"maxItems": 20,
"description": "Associations of the named relative, not the applicant."
},
"military_service_state": {
"type": "string",
"pattern": "^(?:[Aa][Ll]|[Aa][Kk]|[Aa][Zz]|[Aa][Rr]|[Cc][Aa]|[Cc][Oo]|[Cc][Tt]|[Dd][Ee]|[Dd][Cc]|[Ff][Ll]|[Gg][Aa]|[Hh][Ii]|[Ii][Dd]|[Ii][Ll]|[Ii][Nn]|[Ii][Aa]|[Kk][Ss]|[Kk][Yy]|[Ll][Aa]|[Mm][Ee]|[Mm][Dd]|[Mm][Aa]|[Mm][Ii]|[Mm][Nn]|[Mm][Ss]|[Mm][Oo]|[Mm][Tt]|[Nn][Ee]|[Nn][Vv]|[Nn][Hh]|[Nn][Jj]|[Nn][Mm]|[Nn][Yy]|[Nn][Cc]|[Nn][Dd]|[Oo][Hh]|[Oo][Kk]|[Oo][Rr]|[Pp][Aa]|[Rr][Ii]|[Ss][Cc]|[Ss][Dd]|[Tt][Nn]|[Tt][Xx]|[Uu][Tt]|[Vv][Tt]|[Vv][Aa]|[Ww][Aa]|[Ww][Vv]|[Ww][Ii]|[Ww][Yy])$",
"description": "State tied to a state-scoped military affiliation."
},
"asserted_org_qualifiers": {
"type": "array",
"items": {
"type": "string",
"maxLength": 200,
"minLength": 1
},
"maxItems": 20,
"description": "Narrow conditions the person explicitly asserted; never infer them."
},
"relative_school_org_ids": {
"type": "array",
"items": {
"type": "string",
"pattern": "^[a-z0-9]+(?:-[a-z0-9]+)*$",
"maxLength": 80,
"minLength": 1
},
"maxItems": 20,
"description": "Canonical school ids belonging to the named relative, not the applicant.",
"uniqueItems": true
},
"relative_employer_org_ids": {
"type": "array",
"items": {
"type": "string",
"pattern": "^[a-z0-9]+(?:-[a-z0-9]+)*$",
"maxLength": 80,
"minLength": 1
},
"maxItems": 20,
"description": "Canonical employer ids belonging to the named relative, not the applicant.",
"uniqueItems": true
},
"willing_to_join_association": {
"type": "boolean",
"description": "Whether documented joinable-association actions may be considered."
},
"relative_association_org_ids": {
"type": "array",
"items": {
"type": "string",
"pattern": "^[a-z0-9]+(?:-[a-z0-9]+)*$",
"maxLength": 80,
"minLength": 1
},
"maxItems": 20,
"description": "Canonical association ids belonging to the named relative, not the applicant.",
"uniqueItems": true
}
},
"description": "Explicit caller-supplied person facts. Unknown facts stay absent; do not infer them.",
"additionalProperties": false
}
},
"additionalProperties": false
},
"maxItems": 10,
"minItems": 1,
"description": "Caller-supplied named panel. Names must be unique within this request."
}
},
"additionalProperties": false
}Explain WHY each top lender ranked where it did for a financing decision. Takes a full decision scenario (same shape as get_financing_decision) and returns a structured per-offer cost breakdown (rate, points, fees, lifetime interest), scoring signals, how much each offer beats the next by, and a plain-language summary of the ranking weights. Use this when a user asks why one lender beat another.
| Argument | Type | Description |
|---|---|---|
| state* | string | US state code (2-letter). Required. |
| amount* | number | Loan amount in dollars. Required. |
| intent* | string | The loan intent. |
| term_months | number | Loan term in months. |
| credit_score | number | Borrower's credit score (300-850). |
| product_type | string | Type of financing product. |
| max_providers | number | Maximum number of lenders to explain (1-5). Defaults to 5. |
{
"type": "object",
"required": [
"state",
"intent",
"amount"
],
"properties": {
"state": {
"type": "string",
"description": "US state code (2-letter). Required."
},
"amount": {
"type": "number",
"description": "Loan amount in dollars. Required."
},
"intent": {
"enum": [
"purchase",
"refinance",
"cash_out",
"balance_transfer",
"new_credit"
],
"type": "string",
"description": "The loan intent."
},
"term_months": {
"type": "number",
"description": "Loan term in months."
},
"credit_score": {
"type": "number",
"description": "Borrower's credit score (300-850)."
},
"product_type": {
"enum": [
"mortgage",
"mortgage_arm",
"auto_loan",
"rv",
"boat",
"motorcycle",
"powersports",
"personal_loan",
"heloc",
"credit_card",
"student_loan",
"equipment_loan"
],
"type": "string",
"description": "Type of financing product."
},
"max_providers": {
"type": "number",
"description": "Maximum number of lenders to explain (1-5). Defaults to 5."
}
}
}Turn a person's own words about themselves into the structured facts the eligibility tools accept. Pass their sentence verbatim ("I'm a nurse at a Tulsa hospital, I live in Broken Arrow, my late father was a TTCU member") and this returns each fact it could read, with the exact words it read it from, a confidence, and a needs_confirmation flag. THIS DOES NOT DECIDE ELIGIBILITY and never returns a credit union: it only fills in fields. Show the extracted facts to the user and get confirmation on every fact with needs_confirmation=true (family relationships, relatives' employers and associations, applicant kind, and asserted qualifiers are always flagged, because a wrong reading of those changes the answer). Then pass `person_search_body` — plus whatever the user confirmed — to find_eligible_credit_unions, which is what actually decides. If extraction is unavailable you get facts: [] and no eligibility signal at all; ask the user for fields directly instead. `confidence` is the extraction model's own uncalibrated self-report and gates only autofill — quote `evidence.quote` to the user, not the number. This call costs 3 API units.
| Argument | Type | Description |
|---|---|---|
| text* | string | The person's own words, up to 2000 characters. Do not paraphrase or pre-structure it — the extractor needs the original sentence to anchor evidence spans. |
| known_facts | object | Optional. Fields you already know, in PersonSearch shape. These are echoed as source="supplied" and never overwritten. |
{
"type": "object",
"required": [
"text"
],
"properties": {
"text": {
"type": "string",
"maxLength": 2000,
"description": "The person's own words, up to 2000 characters. Do not paraphrase or pre-structure it — the extractor needs the original sentence to anchor evidence spans."
},
"known_facts": {
"type": "object",
"description": "Optional. Fields you already know, in PersonSearch shape. These are echoed as source=\"supplied\" and never overwritten."
}
}
}Use when someone asks for "credit unions near me," the closest credit union, local credit-union branches, or nearby alternatives to a bank. Given a 5-digit ZIP, returns credit unions ordered by the estimated straight-line distance to each institution's closest NCUA-reported branch. Includes approximate miles, branch address, and profile identifiers for checking rates, services, and membership. Distances use ZIP centers and are not driving distance.
| Argument | Type | Description |
|---|---|---|
| zip* | string | Five-digit US ZIP code used as the center of the nearest-branch search. |
| max_results | number | Maximum credit unions to return (1-25, default 10). |
{
"type": "object",
"required": [
"zip"
],
"properties": {
"zip": {
"type": "string",
"pattern": "^[0-9]{5}$",
"description": "Five-digit US ZIP code used as the center of the nearest-branch search."
},
"max_results": {
"type": "number",
"maximum": 25,
"minimum": 1,
"description": "Maximum credit unions to return (1-25, default 10)."
}
}
}`relative_memberships` carries confirmed current/deceased relative membership scoped to one exact target credit union; one institution is never reused for another. `next_questions.unlocks_cu_count` counts membership decisions an answer may clarify, never guaranteed products. Discovery tool: find candidate credit unions a person may be able to JOIN, from their own facts rather than from a list of institutions. Pass any combination of home, worksite, or payroll geography (these are independent), occupation, employer, school (+school_relationship), associations, military_status, and worship; at least one discriminating fact is required, or pass willing_to_join_association=true as the sole discriminator to search documented joinable-association paths. City facts require their same-role state or a recognized same-role ZIP that uniquely identifies one state, and are accepted only when the closed Census gazetteer resolves them. This evaluates a bounded, prioritized candidate set, not the entire credit-union fleet: read `candidate_limit`, `candidate_set_truncated`, and `candidate_sources`, and never interpret an absent institution as unavailable or ineligible. Returns four buckets within that candidate set — eligible (a verified path already applies), conditionally_eligible (one more step, e.g. joining an association, with the cost and join URL when known), possibly_eligible (a path may apply but a requirement could not be confirmed), and unknown (we could not decide — either we hold no rules for the institution or the supplied facts cannot decide the rules we hold). Every non-positive entry carries a machine-readable `unknown_reason`: `geo_inputs_missing` / `org_inputs_missing` / `inputs_missing` mean ONE MORE FACT FROM THE USER would resolve it, so ask for it and call again; `no_rules` means we hold nothing for that institution and asking will not help; `incomplete_fom`, `fom_completeness_unaffirmed`, `low_confidence_rules` and `unmodeled_condition` mean we hold rules but will not turn a failure against them into a no. Each entry also carries `coverage` — {state, rules_held, last_confirmed_at, fom_affirmed} — describing what we HOLD about the institution as opposed to what we concluded about the person. Each entry carries the credit union id, name, state, confidence, and deterministic reasons. Use this to find supported candidates; use check_membership_eligibility when you already have specific credit_union_ids. Credit unions are never listed as ineligible — absence of evidence is never treated as evidence of absence, and the final membership determination is always the institution's. Every non-positive entry now also carries `missing_facts`: the exact question to ask the person next, the `fact_field` their answer populates, why it matters, and the institution's own words. The response's top-level `next_questions` ranks those questions across all institutions by how many they unlock — ASK THE TOP ONE TO THREE, MERGE THE ANSWERS INTO THE SAME REQUEST BODY, AND CALL AGAIN. Two or three turns is the intended shape of this tool; a single call is a first draft. Stop when `next_questions` is empty, when the top entry's `unlocks_cu_count` is below 2, or after three turns. `unanswerable` lists what no question can fix — institutions we hold no rules for, boundaries we can state but not decide (census tracts, school districts, a radius around an office the page never identifies), and rule sets whose completeness nobody affirmed; do not ask the user about those. Fact fields, in full — supply every one you know: `home_zip`, `home_state`, `home_county`, `home_city`; `work_zip`, `work_state`, `work_county`, `work_city`; `payroll_zip`, `payroll_state`, `payroll_county`, `payroll_city` (payroll can differ from the worksite and is a separate door); `property_zip`, `property_state`, `property_county`, `property_city` (where they OWN property — never inferred from where they live, and an absentee owner qualifies); `facility_zip`, `facility_state`, `facility_county`, `facility_city` (where their business maintains a location); `occupation`; `employer`; `school` plus `school_relationship` (student/alumni/employee — a school name without a relationship affirms nothing); `associations`; `military_status` plus `military_service_state` (state National Guard doors need the state); `worship`; `family_relation` plus `relative_employers`, `relative_schools`, `relative_associations` (a great many people qualify only through a relative — ask); `willing_to_join_association`; `applicant_kind` (person/trust/organization/partnership/corporation — some charters admit entities, and a person is never rejected by an entity-only door, only left unknown); and `asserted_org_qualifiers` (narrowings the person asserts about themselves, e.g. "assigned as a recruiter in Arkansas").
Use when someone asks for the best mortgage, auto-loan, HELOC, personal-loan, student-loan, equipment-loan, or credit-card rates near them and provides a ZIP. Finds the nearest NCUA-reported branch set, keeps credit unions with a current product-matched published rate, and ranks those offers by lowest APR with approximate distance as a tie-breaker. HELOC matching excludes closed-end home-equity loans. This is a local shopping shortlist: distance is straight-line, membership is not guaranteed, and published APR is not personalized approval.
| Argument | Type | Description |
|---|---|---|
| zip* | string | Five-digit US ZIP code used as the center of the nearby-branch search. |
| max_offers | number | Maximum product-matched offers to return (1-8, default 5). |
| term_months | number | Optional comparable loan term. For fixed mortgages, under 300 months selects the 15-year market and 300+ selects 30-year. |
| product_type* | string | Product whose current published rates should be compared. |
| vehicle_condition | string | Auto loans only. Omit to use the new-auto market. |
{
"type": "object",
"required": [
"zip",
"product_type"
],
"properties": {
"zip": {
"type": "string",
"pattern": "^[0-9]{5}$",
"description": "Five-digit US ZIP code used as the center of the nearby-branch search."
},
"max_offers": {
"type": "number",
"maximum": 8,
"minimum": 1,
"description": "Maximum product-matched offers to return (1-8, default 5)."
},
"term_months": {
"type": "number",
"minimum": 1,
"description": "Optional comparable loan term. For fixed mortgages, under 300 months selects the 15-year market and 300+ selects 30-year."
},
"product_type": {
"enum": [
"mortgage",
"mortgage_arm",
"auto_loan",
"heloc",
"personal_loan",
"student_loan",
"equipment_loan",
"credit_card"
],
"type": "string",
"description": "Product whose current published rates should be compared."
},
"vehicle_condition": {
"enum": [
"new",
"used",
"certified_pre_owned",
"cpo"
],
"type": "string",
"description": "Auto loans only. Omit to use the new-auto market."
}
},
"additionalProperties": false
}Find the best fresh, evidence-backed credit-union rates reachable from this person’s membership facts. This composed graph-first operation evaluates the complete active US credit-union fleet BEFORE rates are queried, so a strong out-of-state employer, association, school, military, family, property, work/payroll, or facility door is not lost behind a candidate cap or state-only rate search. `reachable_now` requires a verified membership path, satisfied supplied product dimensions, and fresh evidenced published pricing; `reachable_after_action` requires the same product proof plus a documented membership action. Unknown or mismatched term, intent, vehicle condition, or occupancy remains `unresolved`, never silently matched. `no_published_offer` means no matching fresh evidenced rate was found. Deposits rank published APY only. Lending ranks published APR rows first and separately labeled nominal-rate rows second, never comparing APR and rate as one measure. Every price includes verbatim evidence and as_of, and routed membership results preserve graph/publication lineage and source proof. Use product-aware questions only as bounded facts that may clarify. Published pricing is not approval or guaranteed final availability.
| Argument | Type | Description |
|---|---|---|
| limit | number | Visible offers per bucket, 1-50. Candidate intersection happens before this cap. |
| person* | object | Confirmed person facts accepted by find_eligible_credit_unions, including canonical *_org_ids selected through resolve_eligibility_entities. Unknown facts stay absent and canonical ids are revalidated by rates-api. |
| product* | object | The financial product and matching attributes to route. |
Produce a clean, client-facing markdown rate comparison report a loan officer can share with a buyer. Pass either a saved scenario_id, or an inline client_name + comparison result (from get_financing_decision/compare_products).
| Argument | Type | Description |
|---|---|---|
| result | object | The comparison result to format, if not using scenario_id |
| client_name | string | Client label, if not using scenario_id |
| scenario_id | string | Optional: a saved scenario id to build the report from |
| advisor_name | string | Optional advisor/company name for the report header |
{
"type": "object",
"properties": {
"result": {
"type": "object",
"description": "The comparison result to format, if not using scenario_id"
},
"client_name": {
"type": "string",
"description": "Client label, if not using scenario_id"
},
"scenario_id": {
"type": "string",
"description": "Optional: a saved scenario id to build the report from"
},
"advisor_name": {
"type": "string",
"description": "Optional advisor/company name for the report header"
}
}
}Turn a saved client scenario into a public, branded, shareable URL (https://app.rateapi.dev/r/TOKEN) that anyone can view without logging in. Returns a token and url. The link shows the client name, scenario inputs, and the ranked comparison with a "Powered by RateAPI" footer. Use revoke_share to disable a link later.
| Argument | Type | Description |
|---|---|---|
| scenario_id* | string | The saved scenario id to mint a share link for. Required. |
{
"type": "object",
"required": [
"scenario_id"
],
"properties": {
"scenario_id": {
"type": "string",
"description": "The saved scenario id to mint a share link for. Required."
}
}
}Get rate benchmark statistics (min/median/max APR) across all institutions. Use this for market analysis, comparing user quotes against market rates, or building benchmark dashboards. Returns statistics for mortgages (30yr fixed, 15yr fixed, and `mortgage_arm` — one bucket covering every adjustable-rate mortgage regardless of initial fixed period), auto loans (new/used — cars only), RV/boat/motorcycle/powersports (first-class vehicle categories), HELOCs, and personal loans. Each product shows the lowest APR institution, median APR, and count of institutions.
| Argument | Type | Description |
|---|---|---|
| state | string | Filter to a specific US state (2-letter code). If omitted, returns nationwide benchmarks. |
| product_type | string | Filter to a specific product type. If omitted, returns benchmarks for all product types. |
{
"type": "object",
"properties": {
"state": {
"type": "string",
"description": "Filter to a specific US state (2-letter code). If omitted, returns nationwide benchmarks."
},
"product_type": {
"enum": [
"mortgage_30yr",
"mortgage_15yr",
"mortgage_arm",
"auto_loan_new",
"auto_loan_used",
"rv",
"boat",
"motorcycle",
"powersports",
"heloc",
"personal_loan",
"student_loan"
],
"type": "string",
"description": "Filter to a specific product type. If omitted, returns benchmarks for all product types."
}
}
}Get a single saved cohort by id, including all members and the last scan snapshot (triage list).
| Argument | Type | Description |
|---|---|---|
| id* | string | Cohort id. Required. |
{
"type": "object",
"required": [
"id"
],
"properties": {
"id": {
"type": "string",
"description": "Cohort id. Required."
}
}
}Introspect what mortgage/loan data the API covers BEFORE scanning — which states, lenders, and product types are present, row counts per segment, and last-updated freshness per segment. Returns a coverage matrix so an agent can pick a scannable state/product before calling scan_savings or get_financing_decision. Mirrors the /meta global counts, expanded into a per-segment matrix. Boats, RVs, motorcycles, and powersports are first-class product categories; auto means cars.
| Argument | Type | Description |
|---|---|---|
| state | string | Optional 2-letter US state code to scope the matrix to a single state. |
| group_by | string | Optional segmentation axis. Default 'state'. |
| freshness_days | number | Optional uniform staleness window in days (1-90). OMIT to use per-category freshness windows — supplying a value overrides every category and is echoed back as freshness_mode=override. |
| product_category | string | Optional. Restrict the matrix to one product category. Omit for all. |
{
"type": "object",
"required": [],
"properties": {
"state": {
"type": "string",
"description": "Optional 2-letter US state code to scope the matrix to a single state."
},
"group_by": {
"enum": [
"state",
"product",
"state_product"
],
"type": "string",
"description": "Optional segmentation axis. Default 'state'."
},
"freshness_days": {
"type": "number",
"description": "Optional uniform staleness window in days (1-90). OMIT to use per-category freshness windows — supplying a value overrides every category and is echoed back as freshness_mode=override."
},
"product_category": {
"enum": [
"mortgage",
"auto",
"rv",
"boat",
"motorcycle",
"powersports",
"heloc",
"personal",
"credit_card",
"student",
"equipment"
],
"type": "string",
"description": "Optional. Restrict the matrix to one product category. Omit for all."
}
}
}Reference tool: Get a credit union's rates, membership eligibility, and source-labelled NCUA quarterly profile: members, assets, year opened, charter, reported services, and branch locations. Eligibility annotates published criteria and never asserts that an individual is ineligible; profile facts are regulatory snapshots, not live prices. Use this when a user asks about a specific credit union. For personalized rate recommendations, use get_financing_decision instead.
| Argument | Type | Description |
|---|---|---|
| slug* | string | Credit union slug (URL-friendly name, e.g., "navy-federal-credit-union"). Required. |
| state* | string | US state code (2-letter, e.g., CA, TX, NY). Required. |
{
"type": "object",
"required": [
"state",
"slug"
],
"properties": {
"slug": {
"type": "string",
"description": "Credit union slug (URL-friendly name, e.g., \"navy-federal-credit-union\"). Required."
},
"state": {
"type": "string",
"description": "US state code (2-letter, e.g., CA, TX, NY). Required."
}
}
}Best/median/spread credit-union deposit APY by product, term, and state, with per-CU peer ranking. Pass the MCP field `product` using one exact underscore value: savings, cd, share_certificate, money_market, ira_cd, ira, or share_savings. The MCP server translates it to REST `product_category`; do not send `product_category`, `mma`, or `money-market` to this tool. Deposits quote APY (no APR); CDs/share certificates include term. Current + recent data; history is retention-bounded.
| Argument | Type | Description |
|---|---|---|
| limit | number | Top N credit unions to rank (default 10, clamp 1..50). |
| state | string | 2-letter US state code; omit for nationwide. |
| metric | string | Deposits rank by APY, highest first. No APR. |
| product | string | MCP field for the deposit product category. Use an exact enum value such as `money_market`; do not use REST field name `product_category`, `mma`, or `money-market`. Omit for all deposit types. |
| term_months | number | For CD/share_certificate/ira_cd: filter to a specific term (savings_term_months). |
{
"type": "object",
"properties": {
"limit": {
"type": "number",
"description": "Top N credit unions to rank (default 10, clamp 1..50)."
},
"state": {
"type": "string",
"description": "2-letter US state code; omit for nationwide."
},
"metric": {
"enum": [
"apy"
],
"type": "string",
"description": "Deposits rank by APY, highest first. No APR."
},
"product": {
"enum": [
"savings",
"cd",
"share_certificate",
"money_market",
"ira_cd",
"ira",
"share_savings"
],
"type": "string",
"description": "MCP field for the deposit product category. Use an exact enum value such as `money_market`; do not use REST field name `product_category`, `mma`, or `money-market`. Omit for all deposit types."
},
"term_months": {
"type": "number",
"description": "For CD/share_certificate/ira_cd: filter to a specific term (savings_term_months)."
}
}
}Deposit beta (repricing sensitivity) = change in deposit APY per 100bps change in a benchmark/market rate — the core credit-union/bank ALM & interest-rate-risk (IRR) model input. Pass the MCP field `product` using an exact underscore value such as `money_market`; do not send `product_category`, `mma`, or `money-market`. Derived from RateAPI's retained published deposit-rate history. SHORT-WINDOW / retention-bounded: full-cycle beta needs multi-year history (roadmap) — results ship with an explicit confidence/depth caveat. Deposits quote APY, never APR. Aggregate published rates only — never member/borrower data.
| Argument | Type | Description |
|---|---|---|
| state | string | 2-letter US state code |
| window | string | |
| product* | string | Required MCP product field. Use one exact underscore enum value; money market is `money_market`, never `mma` or `money-market`. |
| group_by | string | |
| benchmark | string | |
| term_months | number |
{
"type": "object",
"required": [
"product"
],
"properties": {
"state": {
"type": "string",
"description": "2-letter US state code"
},
"window": {
"enum": [
"90d",
"180d",
"365d"
],
"type": "string",
"default": "180d"
},
"product": {
"enum": [
"savings",
"cd",
"share_certificate",
"money_market",
"ira_cd"
],
"type": "string",
"description": "Required MCP product field. Use one exact underscore enum value; money market is `money_market`, never `mma` or `money-market`."
},
"group_by": {
"enum": [
"overall",
"state",
"cu"
],
"type": "string",
"default": "overall"
},
"benchmark": {
"enum": [
"cd_top_quartile",
"treasury",
"fed_funds"
],
"type": "string",
"default": "cd_top_quartile"
},
"term_months": {
"type": "number"
}
}
}DOCS: return the full text of one RateAPI documentation page by slug (from search_docs) or by its published URL. Documentation only — it describes the contract, not live rates. Available slugs: quickstart, authentication, rate-limits-and-pricing, coverage, freshness, evidence-and-methodology, quoting-rules, eligibility, endpoints, mcp-server, products-and-parameters, errors-and-troubleshooting, deprecation-policy.
| Argument | Type | Description |
|---|---|---|
| url | string | Alternatively, the canonical published URL of the page. |
| slug | string | The page identifier returned by search_docs. |
{
"type": "object",
"properties": {
"url": {
"type": "string",
"description": "Alternatively, the canonical published URL of the page."
},
"slug": {
"enum": [
"quickstart",
"authentication",
"rate-limits-and-pricing",
"coverage",
"freshness",
"evidence-and-methodology",
"quoting-rules",
"eligibility",
"endpoints",
"mcp-server",
"products-and-parameters",
"errors-and-troubleshooting",
"deprecation-policy"
],
"type": "string",
"description": "The page identifier returned by search_docs."
}
}
}Read the bounded, cursor-paginated feed of currently active eligibility publication replacements since an ISO timestamp. Use it to invalidate caches keyed by credit_union_id or publication identity. It exposes aggregate publication metadata only: no personal facts, no historical verdict, and no claim that a person is eligible or ineligible.
| Argument | Type | Description |
|---|---|---|
| limit | integer | Maximum publication changes returned. |
| since* | string | Exclusive ISO 8601 activation boundary with an offset. |
| cursor | string | Opaque next_cursor from the prior page; do not construct or modify it. |
{
"type": "object",
"required": [
"since"
],
"properties": {
"limit": {
"type": "integer",
"default": 100,
"maximum": 200,
"minimum": 1,
"description": "Maximum publication changes returned."
},
"since": {
"type": "string",
"format": "date-time",
"maxLength": 64,
"description": "Exclusive ISO 8601 activation boundary with an offset."
},
"cursor": {
"type": "string",
"maxLength": 1000,
"minLength": 1,
"description": "Opaque next_cursor from the prior page; do not construct or modify it."
}
},
"additionalProperties": false
}Enterprise RateAPI Routes coverage: how many US credit unions RateAPI holds live, verbatim-evidenced membership rules for (and what share of the active fleet that is), how the rules split by kind, how many counties, states and employers they name, verification status, and freshness. The `authority` object distinguishes exact immutable active publications from older graph and flat compatibility records; `evidence_sources` reports the public source mix. Returns a dated `headline` sentence that can be quoted verbatim. Use this BEFORE find_eligible_credit_unions or check_membership_eligibility when the user asks how complete, authoritative, or fresh the eligibility data is. Aggregate only — no institution-level rows; those come from the eligibility tools. Never reports credit data: the rule schema has no condition kind for credit score, income or debt. An institution absent from the graph is undecided, never ineligible.
No arguments.
{
"type": "object",
"properties": {}
}Get the organization's current email branding (display name, logo URL, brand color, intro, business address, reply-to).
No arguments.
{
"type": "object",
"properties": {}
}Get data extraction statistics showing the scale and health of rate data collection. Use this to understand extraction volumes, product coverage, and data freshness. Supports filtering by date range and product type. Great for building transparency dashboards or monitoring data collection health.
| Argument | Type | Description |
|---|---|---|
| endTime | string | End of the time range. Supports ISO8601 or relative times. Defaults to "now". |
| startTime | string | Start of the time range. Supports ISO8601 (e.g., "2024-01-15T00:00:00Z") or relative times ("now-24h", "now-7d", "now-1m"). Defaults to "now-24h". |
| product_type | string | Filter statistics to a specific product type. If omitted, returns stats for all product types. |
{
"type": "object",
"properties": {
"endTime": {
"type": "string",
"description": "End of the time range. Supports ISO8601 or relative times. Defaults to \"now\"."
},
"startTime": {
"type": "string",
"description": "Start of the time range. Supports ISO8601 (e.g., \"2024-01-15T00:00:00Z\") or relative times (\"now-24h\", \"now-7d\", \"now-1m\"). Defaults to \"now-24h\"."
},
"product_type": {
"enum": [
"mortgage",
"auto_loan",
"rv",
"boat",
"motorcycle",
"powersports",
"personal_loan",
"heloc",
"credit_card",
"student_loan",
"equipment_loan"
],
"type": "string",
"description": "Filter statistics to a specific product type. If omitted, returns stats for all product types."
}
}
}RECOMMENDED WHEN SHOPPING: Get personalized financing recommendations for ANY loan or credit product across every major type: mortgages (30yr/15yr/20yr/10yr fixed and ARMs), auto loans (new/used/CPO, 36-84 month terms), RV/boat/motorcycle/powersports loans, HELOCs (fixed/variable), personal loans (secured/unsecured), student loans, equipment loans, and credit cards (rewards, cash_back, secured, balance_transfer, low_rate, business, platinum, student). Analyzes current market offers and returns actionable recommendations with explanations. Use this instead of looking up raw rates when the user is asking "what rate can I get?" and does NOT yet have an offer. IMPORTANT: if the user ALREADY has a quoted rate and is asking whether it is good/fair/competitive ("I was quoted 6.9%, is that any good?"), call rate_sanity_check instead — it returns a percentile verdict on their specific number, which is what that question is actually asking. Provide the user's state, intent (purchase/refinance/cash_out/balance_transfer/new_credit), and amount for personalized advice.
| Argument | Type | Description |
|---|---|---|
| zip | string | User's US 5-digit ZIP or ZIP+4. Resolves to a county server-side for membership-eligibility matching; its crosswalk state must agree with state. |
| state* | string | Valid 50-state/DC code (2-letter, e.g., CA, TX, NY). Required; lowercase is accepted and normalized. |
| amount* | number | Loan amount in dollars (minimum 1000). Required. |
| county | string | User's county for membership-eligibility matching (credit union field-of-membership). Helps flag which lenders the user can actually join. |
Loan-officer competitive-landscape report: ranked roster of the top N lenders publishing a given mortgage product in a state today — per-lender rows (name, best APR/rate, product, position, bps above the leader) — plus the market min/median/max. The market median is INSTITUTION-level — one vote per lender, using each lender's best APR (basis = total_lenders, not market.count) — so a lender publishing a large rate matrix cannot pull it. Extends get_benchmarks (which returns only min/median/max + the single lowest institution) with the full ranked table.
| Argument | Type | Description |
|---|---|---|
| limit | number | Top N lenders to return (default 10, clamped 1..50) |
| state* | string | 2-letter US state code, e.g. CA, TX, NY |
| metric | string | Rank by apr (default) or rate |
| product* | string | Mortgage product |
| include_institution_context | boolean | Include compact NCUA member, location, asset, founding-year, and selected service facts per lender. |
{
"type": "object",
"required": [
"state",
"product"
],
"properties": {
"limit": {
"type": "number",
"description": "Top N lenders to return (default 10, clamped 1..50)"
},
"state": {
"type": "string",
"description": "2-letter US state code, e.g. CA, TX, NY"
},
"metric": {
"enum": [
"apr",
"rate"
],
"type": "string",
"description": "Rank by apr (default) or rate"
},
"product": {
"enum": [
"30yr_fixed",
"15yr_fixed"
],
"type": "string",
"description": "Mortgage product"
},
"include_institution_context": {
"type": "boolean",
"description": "Include compact NCUA member, location, asset, founding-year, and selected service facts per lender."
}
}
}Get detailed information about a specific monitor by its ID.
| Argument | Type | Description |
|---|---|---|
| monitor_id* | string | The unique identifier of the monitor. Required. |
{
"type": "object",
"required": [
"monitor_id"
],
"properties": {
"monitor_id": {
"type": "string",
"description": "The unique identifier of the monitor. Required."
}
}
}Get rollup stats for the account's rate monitors: total, active, and webhooks sent. Complements list_monitors.
No arguments.
{
"type": "object",
"properties": {}
}Evaluate one person across 1-19 explicit loan or deposit selectors using one exhaustive eligibility snapshot. Returns separate membership, published availability, product suitability, published pricing, underwriting, and approval layers. Lead only with reachable_now or reachable_after_action; unresolved and no_published_price are unknown, never a denial. Published APY, APR, or clearly labeled nominal rate is not a personalized quote, underwriting result, preapproval, commitment, or guarantee. Every returned published price carries source evidence and as_of.
| Argument | Type | Description |
|---|---|---|
| person* | object | Explicit caller-supplied person facts. Unknown facts stay absent; do not infer them. |
| products* | array | One to nineteen unique explicit product selectors. Do not invent missing scenario facts. |
| total_limit | integer | Maximum detail rows across all selectors; must be at least the selector count. Default 50. |
| limit_per_product | integer | Maximum detail rows for each selector, subject to the total and plan caps. Default 5. |
{
"type": "object",
"required": [
"person",
"products"
],
"properties": {
"person": {
"type": "object",
"properties": {
"school": {
"type": "string",
"maxLength": 500,
"minLength": 1,
"description": "Person-supplied school name; school_relationship is needed for a typed positive path."
},
"worship": {
"type": "string",
"maxLength": 500,
"minLength": 1,
"description": "Person-supplied place of worship."
},
"employer": {
"type": "string",
"maxLength": 500,
"minLength": 1,
"description": "Person-supplied employer name; use employer_org_ids after authoritative resolution."
},
"home_zip": {
"type": "string",
"pattern": "^\\d{5}(?:-\\d{4})?$",
"description": "Home ZIP; never inferred from another role."
},
"work_zip": {
"type": "string",
"pattern": "^\\d{5}(?:-\\d{4})?$",
"description": "Worksite ZIP, separate from home and payroll."
},
"home_city": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"description": "Census-recognized home city."
},
"work_city": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"description": "Census-recognized worksite city."
},
"home_state": {
"type": "string",
"pattern": "^(?:[Aa][Ll]|[Aa][Kk]|[Aa][Zz]|[Aa][Rr]|[Cc][Aa]|[Cc][Oo]|[Cc][Tt]|[Dd][Ee]|[Dd][Cc]|[Ff][Ll]|[Gg][Aa]|[Hh][Ii]|[Ii][Dd]|[Ii][Ll]|[Ii][Nn]|[Ii][Aa]|[Kk][Ss]|[Kk][Yy]|[Ll][Aa]|[Mm][Ee]|[Mm][Dd]|[Mm][Aa]|[Mm][Ii]|[Mm][Nn]|[Mm][Ss]|[Mm][Oo]|[Mm][Tt]|[Nn][Ee]|[Nn][Vv]|[Nn][Hh]|[Nn][Jj]|[Nn][Mm]|[Nn][Yy]|[Nn][Cc]|[Nn][Dd]|[Oo][Hh]|[Oo][Kk]|[Oo][Rr]|[Pp][Aa]|[Rr][Ii]|[Ss][Cc]|[Ss][Dd]|[Tt][Nn]|[Tt][Xx]|[Uu][Tt]|[Vv][Tt]|[Vv][Aa]|[Ww][Aa]|[Ww][Vv]|[Ww][Ii]|[Ww][Yy])$",
"description": "Valid 50-state/DC home state."
},
"occupation": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"description": "Person-supplied occupation."
},
"work_state": {
"type": "string",
"pattern": "^(?:[Aa][Ll]|[Aa][Kk]|[Aa][Zz]|[Aa][Rr]|[Cc][Aa]|[Cc][Oo]|[Cc][Tt]|[Dd][Ee]|[Dd][Cc]|[Ff][Ll]|[Gg][Aa]|[Hh][Ii]|[Ii][Dd]|[Ii][Ll]|[Ii][Nn]|[Ii][Aa]|[Kk][Ss]|[Kk][Yy]|[Ll][Aa]|[Mm][Ee]|[Mm][Dd]|[Mm][Aa]|[Mm][Ii]|[Mm][Nn]|[Mm][Ss]|[Mm][Oo]|[Mm][Tt]|[Nn][Ee]|[Nn][Vv]|[Nn][Hh]|[Nn][Jj]|[Nn][Mm]|[Nn][Yy]|[Nn][Cc]|[Nn][Dd]|[Oo][Hh]|[Oo][Kk]|[Oo][Rr]|[Pp][Aa]|[Rr][Ii]|[Ss][Cc]|[Ss][Dd]|[Tt][Nn]|[Tt][Xx]|[Uu][Tt]|[Vv][Tt]|[Vv][Aa]|[Ww][Aa]|[Ww][Vv]|[Ww][Ii]|[Ww][Yy])$",
"description": "Valid 50-state/DC worksite state."
},
"home_county": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"description": "Home county."
},
"payroll_zip": {
"type": "string",
"pattern": "^\\d{5}(?:-\\d{4})?$",
"description": "Payroll-origin ZIP, separate from the worksite."
},
"work_county": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"description": "Worksite county."
},
"associations": {
"type": "array",
"items": {
"type": "string",
"maxLength": 500,
"minLength": 1
},
"maxItems": 20,
"description": "Associations the person already belongs to."
},
"facility_zip": {
"type": "string",
"pattern": "^\\d{5}(?:-\\d{4})?$",
"description": "ZIP where the applicant organization maintains a facility."
},
"payroll_city": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"description": "Census-recognized payroll-origin city."
},
"property_zip": {
"type": "string",
"pattern": "^\\d{5}(?:-\\d{4})?$",
"description": "ZIP where the person owns real property; never inferred from home."
},
"facility_city": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"description": "Census-recognized facility city."
},
"payroll_state": {
"type": "string",
"pattern": "^(?:[Aa][Ll]|[Aa][Kk]|[Aa][Zz]|[Aa][Rr]|[Cc][Aa]|[Cc][Oo]|[Cc][Tt]|[Dd][Ee]|[Dd][Cc]|[Ff][Ll]|[Gg][Aa]|[Hh][Ii]|[Ii][Dd]|[Ii][Ll]|[Ii][Nn]|[Ii][Aa]|[Kk][Ss]|[Kk][Yy]|[Ll][Aa]|[Mm][Ee]|[Mm][Dd]|[Mm][Aa]|[Mm][Ii]|[Mm][Nn]|[Mm][Ss]|[Mm][Oo]|[Mm][Tt]|[Nn][Ee]|[Nn][Vv]|[Nn][Hh]|[Nn][Jj]|[Nn][Mm]|[Nn][Yy]|[Nn][Cc]|[Nn][Dd]|[Oo][Hh]|[Oo][Kk]|[Oo][Rr]|[Pp][Aa]|[Rr][Ii]|[Ss][Cc]|[Ss][Dd]|[Tt][Nn]|[Tt][Xx]|[Uu][Tt]|[Vv][Tt]|[Vv][Aa]|[Ww][Aa]|[Ww][Vv]|[Ww][Ii]|[Ww][Yy])$",
"description": "Valid 50-state/DC payroll-origin state."
},
"property_city": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"description": "Census-recognized city where the person owns real property."
},
"applicant_kind": {
"enum": [
"person",
"trust",
"organization",
"partnership",
"corporation",
"other_legal_entity"
],
"type": "string",
"description": "What the applicant is; absence means a natural person."
},
"facility_state": {
"type": "string",
"pattern": "^(?:[Aa][Ll]|[Aa][Kk]|[Aa][Zz]|[Aa][Rr]|[Cc][Aa]|[Cc][Oo]|[Cc][Tt]|[Dd][Ee]|[Dd][Cc]|[Ff][Ll]|[Gg][Aa]|[Hh][Ii]|[Ii][Dd]|[Ii][Ll]|[Ii][Nn]|[Ii][Aa]|[Kk][Ss]|[Kk][Yy]|[Ll][Aa]|[Mm][Ee]|[Mm][Dd]|[Mm][Aa]|[Mm][Ii]|[Mm][Nn]|[Mm][Ss]|[Mm][Oo]|[Mm][Tt]|[Nn][Ee]|[Nn][Vv]|[Nn][Hh]|[Nn][Jj]|[Nn][Mm]|[Nn][Yy]|[Nn][Cc]|[Nn][Dd]|[Oo][Hh]|[Oo][Kk]|[Oo][Rr]|[Pp][Aa]|[Rr][Ii]|[Ss][Cc]|[Ss][Dd]|[Tt][Nn]|[Tt][Xx]|[Uu][Tt]|[Vv][Tt]|[Vv][Aa]|[Ww][Aa]|[Ww][Vv]|[Ww][Ii]|[Ww][Yy])$",
"description": "Valid 50-state/DC facility state."
},
"payroll_county": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"description": "Payroll-origin county."
},
"property_state": {
"type": "string",
"pattern": "^(?:[Aa][Ll]|[Aa][Kk]|[Aa][Zz]|[Aa][Rr]|[Cc][Aa]|[Cc][Oo]|[Cc][Tt]|[Dd][Ee]|[Dd][Cc]|[Ff][Ll]|[Gg][Aa]|[Hh][Ii]|[Ii][Dd]|[Ii][Ll]|[Ii][Nn]|[Ii][Aa]|[Kk][Ss]|[Kk][Yy]|[Ll][Aa]|[Mm][Ee]|[Mm][Dd]|[Mm][Aa]|[Mm][Ii]|[Mm][Nn]|[Mm][Ss]|[Mm][Oo]|[Mm][Tt]|[Nn][Ee]|[Nn][Vv]|[Nn][Hh]|[Nn][Jj]|[Nn][Mm]|[Nn][Yy]|[Nn][Cc]|[Nn][Dd]|[Oo][Hh]|[Oo][Kk]|[Oo][Rr]|[Pp][Aa]|[Rr][Ii]|[Ss][Cc]|[Ss][Dd]|[Tt][Nn]|[Tt][Xx]|[Uu][Tt]|[Vv][Tt]|[Vv][Aa]|[Ww][Aa]|[Ww][Vv]|[Ww][Ii]|[Ww][Yy])$",
"description": "Valid 50-state/DC property state."
},
"school_org_ids": {
"type": "array",
"items": {
"type": "string",
"pattern": "^[a-z0-9]+(?:-[a-z0-9]+)*$",
"maxLength": 80,
"minLength": 1
},
"maxItems": 20,
"description": "Explicit school ids returned by resolve_eligibility_entities; rates-api revalidates them.",
"uniqueItems": true
},
"facility_county": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"description": "County where the applicant organization maintains a facility."
},
"family_relation": {
"type": "string",
"maxLength": 60,
"minLength": 1,
"description": "Relationship to the relative whose affiliations are supplied."
},
"military_status": {
"enum": [
"active_duty",
"veteran",
"reservist",
"dod_civilian",
"military_family"
],
"type": "string",
"description": "Person-supplied military affiliation."
},
"property_county": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"description": "County where the person owns real property."
},
"worship_org_ids": {
"type": "array",
"items": {
"type": "string",
"pattern": "^[a-z0-9]+(?:-[a-z0-9]+)*$",
"maxLength": 80,
"minLength": 1
},
"maxItems": 20,
"description": "Explicit worship-organization ids returned by resolve_eligibility_entities; rates-api revalidates them.",
"uniqueItems": true
},
"employer_org_ids": {
"type": "array",
"items": {
"type": "string",
"pattern": "^[a-z0-9]+(?:-[a-z0-9]+)*$",
"maxLength": 80,
"minLength": 1
},
"maxItems": 20,
"description": "Explicit employer ids returned by resolve_eligibility_entities; rates-api revalidates type and active-publication authority.",
"uniqueItems": true
},
"relative_schools": {
"type": "array",
"items": {
"type": "string",
"maxLength": 500,
"minLength": 1
},
"maxItems": 20,
"description": "Schools of the named relative, not the applicant."
},
"relative_employers": {
"type": "array",
"items": {
"type": "string",
"maxLength": 500,
"minLength": 1
},
"maxItems": 20,
"description": "Employers of the named relative, not the applicant."
},
"association_org_ids": {
"type": "array",
"items": {
"type": "string",
"pattern": "^[a-z0-9]+(?:-[a-z0-9]+)*$",
"maxLength": 80,
"minLength": 1
},
"maxItems": 20,
"description": "Explicit association ids returned by resolve_eligibility_entities; rates-api revalidates them.",
"uniqueItems": true
},
"school_relationship": {
"enum": [
"student",
"alumni",
"employee"
],
"type": "string",
"description": "How the person relates to the supplied school."
},
"relative_memberships": {
"type": "array",
"items": {
"type": "object",
"required": [
"credit_union_id",
"relation",
"status"
],
"properties": {
"status": {
"enum": [
"current_member",
"deceased_member"
],
"type": "string",
"description": "Confirmed membership status."
},
"relation": {
"type": "string",
"maxLength": 60,
"minLength": 1,
"description": "Relative relationship."
},
"credit_union_id": {
"type": "string",
"maxLength": 300,
"minLength": 1,
"description": "Exact credit-union id."
}
},
"additionalProperties": false
},
"maxItems": 50,
"description": "Confirmed relative memberships, each scoped to one exact institution."
},
"relative_associations": {
"type": "array",
"items": {
"type": "string",
"maxLength": 500,
"minLength": 1
},
"maxItems": 20,
"description": "Associations of the named relative, not the applicant."
},
"military_service_state": {
"type": "string",
"pattern": "^(?:[Aa][Ll]|[Aa][Kk]|[Aa][Zz]|[Aa][Rr]|[Cc][Aa]|[Cc][Oo]|[Cc][Tt]|[Dd][Ee]|[Dd][Cc]|[Ff][Ll]|[Gg][Aa]|[Hh][Ii]|[Ii][Dd]|[Ii][Ll]|[Ii][Nn]|[Ii][Aa]|[Kk][Ss]|[Kk][Yy]|[Ll][Aa]|[Mm][Ee]|[Mm][Dd]|[Mm][Aa]|[Mm][Ii]|[Mm][Nn]|[Mm][Ss]|[Mm][Oo]|[Mm][Tt]|[Nn][Ee]|[Nn][Vv]|[Nn][Hh]|[Nn][Jj]|[Nn][Mm]|[Nn][Yy]|[Nn][Cc]|[Nn][Dd]|[Oo][Hh]|[Oo][Kk]|[Oo][Rr]|[Pp][Aa]|[Rr][Ii]|[Ss][Cc]|[Ss][Dd]|[Tt][Nn]|[Tt][Xx]|[Uu][Tt]|[Vv][Tt]|[Vv][Aa]|[Ww][Aa]|[Ww][Vv]|[Ww][Ii]|[Ww][Yy])$",
"description": "State tied to a state-scoped military affiliation."
},
"asserted_org_qualifiers": {
"type": "array",
"items": {
"type": "string",
"maxLength": 200,
"minLength": 1
},
"maxItems": 20,
"description": "Narrow conditions the person explicitly asserted; never infer them."
},
"relative_school_org_ids": {
"type": "array",
"items": {
"type": "string",
"pattern": "^[a-z0-9]+(?:-[a-z0-9]+)*$",
"maxLength": 80,
"minLength": 1
},
"maxItems": 20,
"description": "Canonical school ids belonging to the named relative, not the applicant.",
"uniqueItems": true
},
"relative_employer_org_ids": {
"type": "array",
"items": {
"type": "string",
"pattern": "^[a-z0-9]+(?:-[a-z0-9]+)*$",
"maxLength": 80,
"minLength": 1
},
"maxItems": 20,
"description": "Canonical employer ids belonging to the named relative, not the applicant.",
"uniqueItems": true
},
"willing_to_join_association": {
"type": "boolean",
"description": "Whether documented joinable-association actions may be considered."
},
"relative_association_org_ids": {
"type": "array",
"items": {
"type": "string",
"pattern": "^[a-z0-9]+(?:-[a-z0-9]+)*$",
"maxLength": 80,
"minLength": 1
},
"maxItems": 20,
"description": "Canonical association ids belonging to the named relative, not the applicant.",
"uniqueItems": true
}
},
"description": "Explicit caller-supplied person facts. Unknown facts stay absent; do not infer them.",
"additionalProperties": false
},
"products": {
"type": "array",
"items": {
"type": "object",
"required": [
"product_type"
],
"properties": {
"amount": {
"type": "number",
"description": "Loan or credit amount in USD.",
"exclusiveMinimum": 0
},
"intent": {
"enum": [
"purchase",
"refinance",
"cash_out",
"balance_transfer",
"new_credit"
],
"type": "string",
"description": "Transaction intent when relevant."
},
"balance": {
"type": "number",
"minimum": 0,
"description": "Deposit balance in USD."
},
"audience": {
"enum": [
"business",
"consumer"
],
"type": "string",
"description": "Product audience."
},
"occupancy": {
"enum": [
"primary",
"secondary",
"investment"
],
"type": "string",
"description": "Property occupancy."
},
"term_months": {
"type": "integer",
"maximum": 600,
"minimum": 1,
"description": "Requested term in months."
},
"product_type": {
"enum": [
"mortgage",
"mortgage_arm",
"auto_loan",
"rv",
"boat",
"motorcycle",
"powersports",
"heloc",
"personal_loan",
"student_loan",
"equipment_loan",
"credit_card",
"savings",
"cd",
"share_certificate",
"money_market",
"ira_cd",
"ira",
"share_savings"
],
"type": "string",
"description": "Exact product family."
},
"vehicle_condition": {
"enum": [
"new",
"used",
"certified_pre_owned",
"any"
],
"type": "string",
"description": "Vehicle condition."
}
},
"description": "Exact product request used for both eligibility-backed rate evaluation and ranking.",
"additionalProperties": false
},
"maxItems": 19,
"minItems": 1,
"description": "One to nineteen unique explicit product selectors. Do not invent missing scenario facts.",
"uniqueItems": true
},
"total_limit": {
"type": "integer",
"maximum": 100,
"minimum": 1,
"description": "Maximum detail rows across all selectors; must be at least the selector count. Default 50."
},
"limit_per_product": {
"type": "integer",
"maximum": 10,
"minimum": 1,
"description": "Maximum detail rows for each selector, subject to the total and plan caps. Default 5."
}
},
"additionalProperties": false
}Get non-personal, evidence-bound membership-access metadata for up to 50 exact deposit product references. Returns active-publication path kinds and documented joinable-association actions alongside the current evidenced product rate. This does NOT decide whether a person is eligible, easy to qualify, approved, or within a published balance/audience constraint; unavailable evidence stays unavailable.
| Argument | Type | Description |
|---|---|---|
| products* | array | Exact deposit product references; no fuzzy product matching is performed. |
{
"type": "object",
"required": [
"products"
],
"properties": {
"products": {
"type": "array",
"items": {
"type": "object",
"required": [
"credit_union_id",
"product_type",
"product_name"
],
"properties": {
"balance": {
"type": "number",
"minimum": 0,
"description": "Optional balance used only to report fit with published bounds."
},
"audience": {
"enum": [
"consumer",
"business"
],
"type": "string",
"description": "Optional requested audience."
},
"term_months": {
"type": "integer",
"maximum": 600,
"minimum": 1,
"description": "Exact term when applicable."
},
"product_name": {
"type": "string",
"maxLength": 500,
"minLength": 1,
"description": "Verbatim stable product name."
},
"product_type": {
"enum": [
"savings",
"cd",
"share_certificate",
"money_market",
"ira_cd",
"ira",
"share_savings"
],
"type": "string",
"description": "Exact deposit product family."
},
"credit_union_id": {
"type": "string",
"maxLength": 240,
"minLength": 1,
"description": "Exact credit-union id."
}
},
"additionalProperties": false
},
"maxItems": 50,
"minItems": 1,
"description": "Exact deposit product references; no fuzzy product matching is performed."
}
},
"additionalProperties": false
}Compare the LIVE market rate distribution now vs ~1/2/4 weeks ago for a product and state. Returns now/then min, median, max, count plus the median and min delta and a direction (down/up/flat). Bounded by data retention — if no comparable historical snapshot exists, then is null with an explanatory note. Use this to show how rates have moved recently.
| Argument | Type | Description |
|---|---|---|
| since | string | How far back to compare against. Defaults to "1w". |
| state* | string | US state code (2-letter, e.g., CA, TX). Required. |
| product_type* | string | Type of financing product. Required. |
{
"type": "object",
"required": [
"product_type",
"state"
],
"properties": {
"since": {
"enum": [
"1w",
"2w",
"4w"
],
"type": "string",
"description": "How far back to compare against. Defaults to \"1w\"."
},
"state": {
"type": "string",
"description": "US state code (2-letter, e.g., CA, TX). Required."
},
"product_type": {
"enum": [
"auto_loan",
"rv",
"boat",
"motorcycle",
"powersports",
"mortgage",
"heloc",
"personal_loan",
"student_loan",
"equipment_loan"
],
"type": "string",
"description": "Type of financing product. Required."
}
}
}Historical rate time-series: a date-ranged array of {date, min/median/max APR, count} points per product/state for dashboards, charts, backtests, and timing confidence — bounded by data retention. Differs from get_rate_delta (a single now-vs-then comparison): this returns the full series. Boats, RVs, motorcycles, and powersports are first-class product types; auto_loan means cars. Calls the /v1/rate-history public API (single source of truth).
| Argument | Type | Description |
|---|---|---|
| state* | string | US state code (2-letter, e.g., CA, TX). Required. |
| window | string | Lookback window. Default "90d". Bounded by data retention. |
| interval | string | Bucket granularity per point. Default "week". |
| product_type* | string | Type of financing product. Required. |
| vehicle_condition | string | auto_loan only; selects the benchmark bucket. Default "new". |
{
"type": "object",
"required": [
"product_type",
"state"
],
"properties": {
"state": {
"type": "string",
"description": "US state code (2-letter, e.g., CA, TX). Required."
},
"window": {
"enum": [
"30d",
"60d",
"90d",
"180d",
"365d"
],
"type": "string",
"description": "Lookback window. Default \"90d\". Bounded by data retention."
},
"interval": {
"enum": [
"day",
"week"
],
"type": "string",
"description": "Bucket granularity per point. Default \"week\"."
},
"product_type": {
"enum": [
"auto_loan",
"rv",
"boat",
"motorcycle",
"powersports",
"mortgage",
"heloc",
"personal_loan",
"credit_card",
"student_loan",
"equipment_loan"
],
"type": "string",
"description": "Type of financing product. Required."
},
"vehicle_condition": {
"enum": [
"new",
"used",
"cpo"
],
"type": "string",
"description": "auto_loan only; selects the benchmark bucket. Default \"new\"."
}
}
}Get a single saved scenario by id (inputs + stored comparison).
| Argument | Type | Description |
|---|---|---|
| id* | string | Scenario id |
{
"type": "object",
"required": [
"id"
],
"properties": {
"id": {
"type": "string",
"description": "Scenario id"
}
}
}Check the calling account's API usage and remaining quota for this month (tier, used, remaining, limit, reset date). Use BEFORE running many calls to avoid hitting rate limits.
No arguments.
{
"type": "object",
"properties": {}
}List saved cohorts for the account (newest first). Returns id, name, member count, and last scan time. Keeps the payload small — use get_cohort for full member detail.
No arguments.
{
"type": "object",
"properties": {}
}Reference tool: Discover credit unions by state or nearest to a 5-digit ZIP. State listings include rate availability, member count, and reported location count. ZIP discovery ranks NCUA-reported branches by estimated straight-line miles from the ZIP center. For personalized rate recommendations, use get_financing_decision instead.
| Argument | Type | Description |
|---|---|---|
| zip | string | Optional: Find the closest credit unions by NCUA-reported branch location. Distances are ZIP-centroid straight-line estimates. When supplied, ZIP discovery takes precedence over state listing. |
| state | string | Optional: Filter to a specific state (2-letter code). If not provided, returns all states. |
{
"type": "object",
"properties": {
"zip": {
"type": "string",
"pattern": "^[0-9]{5}$",
"description": "Optional: Find the closest credit unions by NCUA-reported branch location. Distances are ZIP-centroid straight-line estimates. When supplied, ZIP discovery takes precedence over state listing."
},
"state": {
"type": "string",
"description": "Optional: Filter to a specific state (2-letter code). If not provided, returns all states."
}
}
}Recall past financing decisions made on this account (audit log). Filter by request_id to look up a specific prior decision, or paginate with limit/offset.
| Argument | Type | Description |
|---|---|---|
| limit | number | Max rows (default 20, max 100) |
| offset | number | Pagination offset |
| request_id | string | Optional: look up a specific decision by its request_id |
{
"type": "object",
"properties": {
"limit": {
"type": "number",
"description": "Max rows (default 20, max 100)"
},
"offset": {
"type": "number",
"description": "Pagination offset"
},
"request_id": {
"type": "string",
"description": "Optional: look up a specific decision by its request_id"
}
}
}List the account's scheduled digests (cohort, email, cadence, enabled, last run).
No arguments.
{
"type": "object",
"properties": {}
}List the organization's branded rate-email campaigns (name, criteria, cadence, status, last run).
No arguments.
{
"type": "object",
"properties": {}
}List all monitors associated with your API key. Supports pagination and filtering by status.
| Argument | Type | Description |
|---|---|---|
| limit | number | Maximum number of monitors to return (1-100). Defaults to 20. |
| offset | number | Number of monitors to skip for pagination. Defaults to 0. |
| status | string | Filter monitors by status. |
{
"type": "object",
"properties": {
"limit": {
"type": "number",
"description": "Maximum number of monitors to return (1-100). Defaults to 20."
},
"offset": {
"type": "number",
"description": "Number of monitors to skip for pagination. Defaults to 0."
},
"status": {
"enum": [
"active",
"paused",
"disabled"
],
"type": "string",
"description": "Filter monitors by status."
}
}
}List the rate alerts subscribed for a given email (status, product, state, intent, target, last notified).
| Argument | Type | Description |
|---|---|---|
| email* | string | The email whose alerts to list. Required. |
{
"type": "object",
"required": [
"email"
],
"properties": {
"email": {
"type": "string",
"description": "The email whose alerts to list. Required."
}
}
}List and filter raw rate rows (the core data primitive) by product, state, lender, and term with limit/offset pagination. Boats, RVs, motorcycles, and powersports are first-class product types; auto_loan means cars.
| Argument | Type | Description |
|---|---|---|
| sort | string | Default apr_asc |
| limit | number | 1-500, default 50 |
| state | string | 2-letter US state code; omit for all states |
| lender | string | Filter by credit-union name (substring, case-insensitive) |
| offset | number | Pagination offset, default 0 |
| max_apr | number | |
| min_apr | number | |
| audience | string | WHO the product is for, orthogonal to product type: 'business' returns business-audience products across every category (DSCR mortgages, business deposits, SBA loans); 'consumer' excludes them. |
| term_months | number | |
List saved client scenarios for the account, newest first.
No arguments.
{
"type": "object",
"properties": {}
}List all hosted shareable report links for the account, newest first. Returns token, scenario_id, client_name, views, last_viewed_at, revoked, created_at, and url for each share. Use this to see view analytics and manage which links are still live.
No arguments.
{
"type": "object",
"properties": {}
}Org-scoped webhook delivery observability for the authenticated API key. Lists the per-event webhook delivery log for your monitors — each row shows status (delivered/failed/pending), HTTP response code, error, response time, the destination URL, and timestamp — with a roll-up summary (total/delivered/failed/pending). Use this to surface SILENT webhook failures (a delivery that never reached your endpoint). Filter by monitor_id and/or status. To replay a failed (or any) delivery, set redeliver_id to that row's id; the original payload is re-sent verbatim and the replay is itself audited. Distinct from deliver_test_webhook, which sends a brand-new simulated event.
| Argument | Type | Description |
|---|---|---|
| limit | integer | |
| offset | integer | |
| status | string | Filter by delivery outcome. |
| monitor_id | string | Filter to one monitor. |
| redeliver_id | integer | If set, replay the delivery with this audit-log id instead of listing (maps to action:redeliver, delivery_id). |
{
"type": "object",
"properties": {
"limit": {
"type": "integer",
"default": 50,
"maximum": 100,
"minimum": 1
},
"offset": {
"type": "integer",
"default": 0,
"minimum": 0
},
"status": {
"enum": [
"delivered",
"failed",
"pending"
],
"type": "string",
"description": "Filter by delivery outcome."
},
"monitor_id": {
"type": "string",
"description": "Filter to one monitor."
},
"redeliver_id": {
"type": "integer",
"description": "If set, replay the delivery with this audit-log id instead of listing (maps to action:redeliver, delivery_id)."
}
},
"additionalProperties": false
}Estimate the largest loan a borrower can afford from income and a target debt-to-income (DTI) ratio. Returns max monthly payment, max loan amount, and the rate used. If no rate is supplied, the current best market rate for the product/state is used.
| Argument | Type | Description |
|---|---|---|
| dti* | number | Target debt-to-income ratio as a decimal, e.g. 0.36 |
| rate | number | Optional annual interest rate, e.g. 6.5. If omitted, best market rate is used. |
| state | string | US state code (used to look up a market rate when rate is omitted) |
| term_months* | number | Loan term in months (e.g. 360) |
| product_type | string | Product for the market-rate lookup, default mortgage |
| income_annual* | number | Gross annual income in dollars |
| existing_monthly_debt | number | Optional existing monthly debt payments to subtract |
{
"type": "object",
"required": [
"income_annual",
"dti",
"term_months"
],
"properties": {
"dti": {
"type": "number",
"description": "Target debt-to-income ratio as a decimal, e.g. 0.36"
},
"rate": {
"type": "number",
"description": "Optional annual interest rate, e.g. 6.5. If omitted, best market rate is used."
},
"state": {
"type": "string",
"description": "US state code (used to look up a market rate when rate is omitted)"
},
"term_months": {
"type": "number",
"description": "Loan term in months (e.g. 360)"
},
"product_type": {
"type": "string",
"description": "Product for the market-rate lookup, default mortgage"
},
"income_annual": {
"type": "number",
"description": "Gross annual income in dollars"
},
"existing_monthly_debt": {
"type": "number",
"description": "Optional existing monthly debt payments to subtract"
}
}
}Given a discount-points / lender-credit tradeoff menu for a candidate loan, returns break-even months, lifetime savings, and the optimal point-spend. The points analog of refinance_break_even.
| Argument | Type | Description |
|---|---|---|
| state | string | Optional 2-letter state (validated only if supplied). |
| options* | array | Points/lender-credit tradeoff menu to evaluate. |
| base_rate* | number | The no-points (par) interest rate, percent, e.g. 6.75. |
| hold_months | number | Expected time-in-loan horizon for lifetime savings; defaults to term_months. |
| loan_amount* | number | Loan principal in dollars (>0). |
| term_months* | number | Loan term in months, e.g. 360. |
{
"type": "object",
"required": [
"loan_amount",
"term_months",
"base_rate",
"options"
],
"properties": {
"state": {
"type": "string",
"description": "Optional 2-letter state (validated only if supplied)."
},
"options": {
"type": "array",
"items": {
"type": "object",
"required": [
"points",
"rate"
],
"properties": {
"rate": {
"type": "number",
"description": "Resulting interest rate at that point spend, percent."
},
"points": {
"type": "number",
"description": "Discount points as % of loan (positive) or lender credit (negative); 1 = 1% of loan."
}
}
},
"maxItems": 25,
"minItems": 1,
"description": "Points/lender-credit tradeoff menu to evaluate."
},
"base_rate": {
"type": "number",
"description": "The no-points (par) interest rate, percent, e.g. 6.75."
},
"hold_months": {
"type": "number",
"description": "Expected time-in-loan horizon for lifetime savings; defaults to term_months."
},
"loan_amount": {
"type": "number",
"description": "Loan principal in dollars (>0)."
},
"term_months": {
"type": "number",
"default": 360,
"description": "Loan term in months, e.g. 360."
}
}
}For low-down-payment borrowers (LTV > 80%): projects when private mortgage insurance (PMI) drops off, the total PMI paid until then, and how much extra monthly principal cancels PMI sooner. Reuses the same amortization + PMI logic as estimate_monthly_cost. If no rate is supplied, the current best market rate for the state is used. Use for 'when does my PMI go away / how do I get rid of PMI faster?' questions.
| Argument | Type | Description |
|---|---|---|
| rate | number | Annual rate %, e.g. 6.5. Omit -> best market rate for state. |
| state | string | 2-letter code for market-rate lookup. Default CA. |
| pmi_rate | number | Annual PMI as % of loan balance. Default 0.5. |
| home_price | number | Purchase/appraised price. Required unless loan_amount given. |
| loan_amount | number | Optional explicit loan; overrides home_price - down_payment. |
| term_months | number | Loan term in months. Default 360. |
| credit_score | number | Optional, for market-rate lookup. |
| down_payment | number |
RECOMMENDED WHEN THE USER ALREADY HAS A QUOTE: answers "is this rate any good?" for a specific number a borrower was offered. Use this whenever someone says they were quoted / offered / approved at a rate and wants to know if it is fair, good, competitive, high, or a rip-off — e.g. "I got offered 6.9% on a 30-year in Ohio, is that fair?", "my dealer quoted 8.4% on a used car loan", "is 7.1% high for a HELOC in TX?". Given a product_type, state, and rate (and optional apr/fees/amount/term_months), returns the percentile of the quote within the live market distribution, a verdict (market_leading, plausible, suspicious_low, overpriced), whether it falls below the known product rate floor, and the market min/median/max with an as_of date. Prefer this over get_financing_decision for quote-in-hand questions: the user wants a verdict on THEIR number, not a list of other offers. Set include_better_offers=true to get named statewide lenders beating the quote. When the user provides a ZIP, set include_nearby_offers=true to pair product-matched rates with the closest credit unions by NCUA-reported branch location; distances are straight-line ZIP-center estimates, never driving distance. Every response also returns `share_url` — a link to this same check on rateapi.dev that the borrower can send to their lender or broker. Surface it whenever the user might act on the result; it re-runs against live rates when opened, so it never goes stale. NOTE: this is the BORROWER-side tool; check_competitive_position is the lender-side equivalent for benchmarking a lender's own published pricing. If the quote is an ADJUSTABLE-rate mortgage (the user says ARM / adjustable / "5/1" / "5/5" / "7/1"), pass product_type=mortgage_arm rather than mortgage — ARMs are scored against their own market. Caveat to surface to the user: the comparison does not currently segment by credit score, LTV, or points, and quoted fees are not folded into the APR comparison.
| Argument | Type | Description |
|---|---|---|
| apr | number | The quoted APR as a percentage. Optional — falls back to rate if omitted. |
Tell a borrower whether refinancing is worth it. Compares their current rate against the best real market offer and returns monthly savings, lifetime savings, and break-even months. Use for 'should I refinance?' questions.
| Argument | Type | Description |
|---|---|---|
| state* | string | US state code |
| balance* | number | Current loan balance in dollars |
| term_months* | number | Remaining or new term in months |
| credit_score | number | Optional borrower credit score |
| current_rate* | number | Borrower's current interest rate, e.g. 7.25 |
| product_type* | string | mortgage | auto | heloc | personal_loan | student_loan |
| closing_costs | number | Lender fees / closing costs in dollars (default 0) |
{
"type": "object",
"required": [
"state",
"product_type",
"balance",
"term_months",
"current_rate"
],
"properties": {
"state": {
"type": "string",
"description": "US state code"
},
"balance": {
"type": "number",
"description": "Current loan balance in dollars"
},
"term_months": {
"type": "number",
"description": "Remaining or new term in months"
},
"credit_score": {
"type": "number",
"description": "Optional borrower credit score"
},
"current_rate": {
"type": "number",
"description": "Borrower's current interest rate, e.g. 7.25"
},
"product_type": {
"type": "string",
"description": "mortgage | auto | heloc | personal_loan | student_loan"
},
"closing_costs": {
"type": "number",
"description": "Lender fees / closing costs in dollars (default 0)"
}
}
}Remove one recipient from a campaign by recipient id.
| Argument | Type | Description |
|---|---|---|
| id* | string | Campaign id. Required. |
| recipient_id* | string | Recipient id. Required. |
{
"type": "object",
"required": [
"id",
"recipient_id"
],
"properties": {
"id": {
"type": "string",
"description": "Campaign id. Required."
},
"recipient_id": {
"type": "string",
"description": "Recipient id. Required."
}
}
}Resolve up to 50 typed organization names for canonical eligibility input. Only one exact normalized active-publication match with confidence of at least 0.8 is authoritative (`resolved`); a lower-confidence exact match remains `unresolved`, multiple exact matches are `ambiguous`, and prefix candidates are suggestions only. Never convert an unresolved, ambiguous, or suggested candidate into a person fact. Resolution identifies an organization and never establishes eligibility.
| Argument | Type | Description |
|---|---|---|
| inputs* | array | Typed values to resolve in stable input order. |
| candidate_limit | integer | Maximum exact matches or prefix suggestions returned per input. |
{
"type": "object",
"required": [
"inputs"
],
"properties": {
"inputs": {
"type": "array",
"items": {
"type": "object",
"required": [
"value",
"entity_type"
],
"properties": {
"value": {
"type": "string",
"maxLength": 120,
"minLength": 2,
"description": "Organization name as supplied by the user."
},
"entity_type": {
"enum": [
"employer",
"association",
"school",
"worship"
],
"type": "string",
"description": "Asserted exact organization type."
}
},
"additionalProperties": false
},
"maxItems": 50,
"minItems": 1,
"description": "Typed values to resolve in stable input order."
},
"candidate_limit": {
"type": "integer",
"default": 5,
"maximum": 10,
"minimum": 1,
"description": "Maximum exact matches or prefix suggestions returned per input."
}
},
"additionalProperties": false
}Revoke a hosted shareable report link by its token. Once revoked, the public URL returns a 404 and no longer exposes the report. This action cannot be undone.
| Argument | Type | Description |
|---|---|---|
| token* | string | The share token to revoke. Required. |
{
"type": "object",
"required": [
"token"
],
"properties": {
"token": {
"type": "string",
"description": "The share token to revoke. Required."
}
}
}Save a named cohort ("book of business") — a list of borrower scenarios you want to track and re-scan over time. Each member has a label and a scenario (product_type, state, intent, amount, term_months, optional credit_score and current_offer). Returns the created cohort. Use scan_portfolio later to re-price every member against the live market.
| Argument | Type | Description |
|---|---|---|
| name* | string | Cohort name, e.g. "Q2 refi prospects". Required. |
| members* | array | List of cohort members (max ~50). |
{
"type": "object",
"required": [
"name",
"members"
],
"properties": {
"name": {
"type": "string",
"description": "Cohort name, e.g. \"Q2 refi prospects\". Required."
},
"members": {
"type": "array",
"items": {
"type": "object",
"required": [
"label",
"scenario"
],
"properties": {
"label": {
"type": "string",
"description": "Member label, e.g. \"Smith — $400k purchase\"."
},
"scenario": {
"type": "object",
"description": "A financing scenario: { product_type, state, intent, amount, term_months, credit_score?, current_offer?:{rate,apr,amount,term_months} }."
}
}
},
"description": "List of cohort members (max ~50)."
}
}
}Save a rate comparison for a named client so it can be recalled later (a lightweight CRM for loan officers). Pass the client label and the inputs/results you want to keep.
| Argument | Type | Description |
|---|---|---|
| input* | object | The scenario inputs (product, amount, state, term, etc.) |
| client_name* | string | Client/scenario label, e.g. "Smith — $400k purchase, CA" |
| result_snapshot* | any | The comparison result to store (object from get_financing_decision/compare_products) |
{
"type": "object",
"required": [
"client_name",
"input",
"result_snapshot"
],
"properties": {
"input": {
"type": "object",
"description": "The scenario inputs (product, amount, state, term, etc.)"
},
"client_name": {
"type": "string",
"description": "Client/scenario label, e.g. \"Smith — $400k purchase, CA\""
},
"result_snapshot": {
"description": "The comparison result to store (object from get_financing_decision/compare_products)"
}
}
}Re-scan every member of a saved cohort against the live decision engine to find each member's current best offer. Returns a triage list (label, best lender, best APR, monthly payment, optional savings vs current) and a diff vs the previous scan (who's new, whose best lender changed, APR deltas). Persists the new snapshot. Use this to refresh a book of business and surface what changed.
| Argument | Type | Description |
|---|---|---|
| id* | string | Cohort id to scan. Required. |
{
"type": "object",
"required": [
"id"
],
"properties": {
"id": {
"type": "string",
"description": "Cohort id to scan. Required."
}
}
}Scan a list of existing debts and find, for EACH debt, the best qualifying market refinance offer. Returns a ranked "savings stack" with monthly and lifetime savings (net of typical closing costs) per debt plus whether refinancing is worth it, and overall totals. Use this to find refinance opportunities across a borrower's whole debt portfolio.
| Argument | Type | Description |
|---|---|---|
| debts* | array | List of existing debts to evaluate for refinancing. |
| state* | string | US state code (2-letter, e.g., TX). Required. |
| credit_score | number | Borrower's credit score (300-850). Recommended for accurate matching. |
{
"type": "object",
"required": [
"state",
"debts"
],
"properties": {
"debts": {
"type": "array",
"items": {
"type": "object",
"required": [
"product_type",
"balance",
"current_rate",
"term_months"
],
"properties": {
"balance": {
"type": "number",
"description": "Outstanding balance in dollars."
},
"term_months": {
"type": "number",
"description": "Remaining term in months."
},
"current_rate": {
"type": "number",
"description": "Current interest rate as a percentage (e.g., 7.9)."
},
"product_type": {
"enum": [
"auto_loan",
"rv",
"boat",
"motorcycle",
"powersports",
"mortgage",
"heloc",
"personal_loan",
"student_loan",
"equipment_loan"
],
"type": "string",
"description": "Type of the existing debt."
}
}
},
"description": "List of existing debts to evaluate for refinancing."
},
"state": {
"type": "string",
"description": "US state code (2-letter, e.g., TX). Required."
},
"credit_score": {
"type": "number",
"description": "Borrower's credit score (300-850). Recommended for accurate matching."
}
}
}Set up a recurring digest: on a cadence (default weekly), automatically re-scan a saved cohort and EMAIL the loan officer a triage of which clients have a new opportunity (best lender changed, crossed a threshold). Turns a one-time portfolio scan into a standing operation. Requires a cohort_id (from save_cohort/list_cohorts) and a delivery email.
| Argument | Type | Description |
|---|---|---|
| email* | string | Where to send the digest. |
| cadence | string | weekly (default) or daily. |
| cohort_id* | string | The cohort to scan on a schedule (from list_cohorts). |
{
"type": "object",
"required": [
"cohort_id",
"email"
],
"properties": {
"email": {
"type": "string",
"description": "Where to send the digest."
},
"cadence": {
"type": "string",
"description": "weekly (default) or daily."
},
"cohort_id": {
"type": "string",
"description": "The cohort to scan on a schedule (from list_cohorts)."
}
}
}DOCS: search the RateAPI documentation (authentication, rate limits and pricing, coverage, freshness, methodology, eligibility, endpoint map, product parameters, errors, the MCP server itself, and the rules for quoting the data). Use this whenever the question is about the API rather than about a rate — "how do I authenticate?", "what does rate_phase mean?", "which endpoint gives deposit APYs?", "how fresh is this?", "what does it cost?" — instead of guessing at parameters or inventing endpoints. Returns ranked pages with an excerpt; call get_doc for the full text. This tool NEVER returns rates.
| Argument | Type | Description |
|---|---|---|
| limit | number | Maximum pages to return (1-12). Defaults to 5. |
| query* | string | What you want to know about the API, in plain words (e.g. "oauth", "how fresh are rates", "429 error"). |
{
"type": "object",
"required": [
"query"
],
"properties": {
"limit": {
"type": "number",
"description": "Maximum pages to return (1-12). Defaults to 5."
},
"query": {
"type": "string",
"description": "What you want to know about the API, in plain words (e.g. \"oauth\", \"how fresh are rates\", \"429 error\")."
}
}
}Browse or search canonical employers, associations, schools, or worship organizations that appear in positive conditions in current active eligibility publications. Omit query to browse by active-publication graph connectivity; that order is NOT popularity, quality, or a recommendation. With query, normalized exact matches rank before bounded prefix matches. A returned organization is a selectable fact, NOT proof that this person can join any credit union; use resolve_eligibility_entities for authoritative selection, then pass the returned org_id in the matching *_org_ids field to an eligibility tool. This authenticated discovery never loads a client-side corpus and accepts no personal profile.
| Argument | Type | Description |
|---|---|---|
| limit | integer | Maximum results; the response discloses truncation. |
| query | string | Optional organization name or prefix, 2-120 characters. Omit to browse by active-publication connectivity. |
| types | array | Exact public organization types to search. Omit for all four types. |
{
"type": "object",
"required": [],
"properties": {
"limit": {
"type": "integer",
"default": 10,
"maximum": 10,
"minimum": 1,
"description": "Maximum results; the response discloses truncation."
},
"query": {
"type": "string",
"maxLength": 120,
"minLength": 2,
"description": "Optional organization name or prefix, 2-120 characters. Omit to browse by active-publication connectivity."
},
"types": {
"type": "array",
"items": {
"enum": [
"employer",
"association",
"school",
"worship"
],
"type": "string"
},
"maxItems": 4,
"minItems": 1,
"description": "Exact public organization types to search. Omit for all four types.",
"uniqueItems": true
}
},
"additionalProperties": false
}Send a campaign to ALL of its recipients immediately (one full send, the same path the daily cron uses). The campaign must be active. Honors suppressions and the per-org daily cap, resets the cadence clock (the next scheduled send counts from now), and is guarded against double-fires. Returns { run_id, sent, suppressed, failed }.
| Argument | Type | Description |
|---|---|---|
| id* | string | Campaign id. Required. |
{
"type": "object",
"required": [
"id"
],
"properties": {
"id": {
"type": "string",
"description": "Campaign id. Required."
}
}
}Send a one-off test render of a campaign (with live rates and the org's branding) to the organization owner's email. Does not affect the campaign schedule.
| Argument | Type | Description |
|---|---|---|
| id* | string | Campaign id. Required. |
{
"type": "object",
"required": [
"id"
],
"properties": {
"id": {
"type": "string",
"description": "Campaign id. Required."
}
}
}Set the organization's white-label email branding: display name (used as the From name and CAN-SPAM advertiser identity), brand color (#hex), default intro text, business_address (CAN-SPAM physical address — required before a campaign can be activated), and reply_to_email. Requires a Pro plan. (Logo upload is app-only — not available over MCP.)
| Argument | Type | Description |
|---|---|---|
| intro_text | string | Default intro paragraph for campaign emails. |
| brand_color | string | Accent color as a #hex string (e.g. #00b368). |
| display_name | string | The lender/brand name shown as the email sender and advertiser. |
| reply_to_email | string | Optional Reply-To address for campaign emails. |
| business_address | string | Physical mailing address of the advertiser (CAN-SPAM). |
| logo_background_color | string | Solid backdrop behind the logo in the email header, as a 6-digit #hex (e.g. #0d1b2a). Useful when the logo is white. Omit or null for the white default. |
{
"type": "object",
"properties": {
"intro_text": {
"type": "string",
"description": "Default intro paragraph for campaign emails."
},
"brand_color": {
"type": "string",
"description": "Accent color as a #hex string (e.g. #00b368)."
},
"display_name": {
"type": "string",
"description": "The lender/brand name shown as the email sender and advertiser."
},
"reply_to_email": {
"type": "string",
"description": "Optional Reply-To address for campaign emails."
},
"business_address": {
"type": "string",
"description": "Physical mailing address of the advertiser (CAN-SPAM)."
},
"logo_background_color": {
"type": "string",
"description": "Solid backdrop behind the logo in the email header, as a 6-digit #hex (e.g. #0d1b2a). Useful when the logo is white. Omit or null for the white default."
}
}
}Run a what-if sweep over a financing decision. Holds a scenario fixed while sweeping one input (credit_score, down_payment_percent, or rate_shift_bps) across a from/to/step range, returning a grid of best_lender / best_apr / monthly_payment at each value plus any flip_points where the winning lender changes. Use this to show how rate eligibility or affordability changes with credit score, down payment, or a market rate shift.
| Argument | Type | Description |
|---|---|---|
| sweep* | object | The input to sweep and its range. |
| scenario* | object | The fixed financing scenario. |
{
"type": "object",
"required": [
"scenario",
"sweep"
],
"properties": {
"sweep": {
"type": "object",
"required": [
"field",
"from",
"to",
"step"
],
"properties": {
"to": {
"type": "number",
"description": "End value (inclusive)."
},
"from": {
"type": "number",
"description": "Start value (inclusive)."
},
"step": {
"type": "number",
"description": "Increment between values."
},
"field": {
"enum": [
"credit_score",
"down_payment_percent",
"rate_shift_bps"
],
"type": "string",
"description": "Which input to vary across the grid."
}
},
"description": "The input to sweep and its range."
},
"scenario": {
"type": "object",
"required": [
"product_type",
"state",
"intent",
"amount"
],
"properties": {
"state": {
"type": "string",
"description": "US state code (2-letter)."
},
"amount": {
"type": "number",
"description": "Loan amount in dollars."
},
"intent": {
"enum": [
"purchase",
"refinance",
"cash_out",
"balance_transfer",
"new_credit"
],
"type": "string",
"description": "The loan intent."
},
"term_months": {
"type": "number",
"description": "Loan term in months."
},
"credit_score": {
"type": "number",
"description": "Baseline credit score (used unless swept)."
},
"product_type": {
"enum": [
"mortgage",
"mortgage_arm",
"auto_loan",
"rv",
"boat",
"motorcycle",
"powersports",
"personal_loan",
"heloc",
"credit_card",
"student_loan",
"equipment_loan"
],
"type": "string",
"description": "Type of financing product."
},
"down_payment_percent": {
"type": "number",
"description": "Baseline down payment percent (used unless swept)."
}
},
"description": "The fixed financing scenario."
}
}
}Test a monitor with a simulated rate change to see if it would trigger. No webhook is sent. It is not a pure dry run: the simulation IS recorded, as a monitor_evaluations row (and a webhook audit row) flagged is_simulation = 1, so it appears in the monitor's history clearly marked as a simulation. It does not touch the monitor's cooldown or last_triggered_at. Use deliver_test_webhook to actually send a test webhook.
| Argument | Type | Description |
|---|---|---|
| monitor_id* | string | The unique identifier of the monitor to simulate. Required. |
| rate_change* | object | The simulated rate change event. Required. |
{
"type": "object",
"required": [
"monitor_id",
"rate_change"
],
"properties": {
"monitor_id": {
"type": "string",
"description": "The unique identifier of the monitor to simulate. Required."
},
"rate_change": {
"type": "object",
"required": [
"state",
"product_type",
"previous_rate",
"new_rate"
],
"properties": {
"state": {
"type": "string",
"description": "US state code where the rate changed. Required."
},
"new_rate": {
"type": "number",
"description": "The new rate value. Required."
},
"product_type": {
"type": "string",
"description": "The product type that changed (e.g., \"30yr_fixed\"). Required."
},
"previous_rate": {
"type": "number",
"description": "The previous rate value. Required."
}
},
"description": "The simulated rate change event. Required."
}
}
}Subscribe a consumer to an EMAIL rate alert: notify them when the live market meets their target (rate/apr/monthly_payment crossing a threshold). Consent-first — sends a double-opt-in confirmation email; the alert only activates after the recipient confirms. One-click unsubscribe in every email (CAN-SPAM). Stores only email + alert criteria. Provide exactly one of state, states, or region.
| Argument | Type | Description |
|---|---|---|
| email* | string | Consumer email address to send the alert to. Required. |
| state | string | Legacy single US state code (2-letter, e.g., CA, TX, NY). Prefer states or region for multi-state alerts. |
| amount | number | Loan amount in dollars. Optional. |
| intent* | string | The loan intent. Required. |
| region | string | Named region preset (e.g. east_coast); expands server-side to its member states. |
| states | array | 2-letter US state codes (up to 25) — best rates are ranked ACROSS all of them, not per state. |
| target* | object | The condition that triggers the alert. Required. |
| term_months | number |
One-click unsubscribe via the per-alert token embedded in every email.
| Argument | Type | Description |
|---|---|---|
| token* | string | The unsubscribe token from the email. Required. |
{
"type": "object",
"required": [
"token"
],
"properties": {
"token": {
"type": "string",
"description": "The unsubscribe token from the email. Required."
}
}
}Update a campaign's name, geography, cadence, intro override, products, or status. products (if given) is the full replacement set (1-5, same union as create_email_campaign). Any geography field replaces the campaign's whole state selection. Set status 'active' to start sending (requires branding display_name + business_address) or 'paused' to stop. Provide exactly one of state_code, state_codes, or region.
| Argument | Type | Description |
|---|---|---|
| id* | string | Campaign id. Required. |
| name | string | |
| region | string | Named region preset (e.g. east_coast); expands server-side to its member states. |
| status | string | |
| cadence | string | |
| products | array | Full replacement product set (1-5, no duplicates); same shapes as create_email_campaign. |
| state_code | string | Legacy single 2-letter US state code. Prefer state_codes or region. |
| state_codes | array | 2-letter US state codes (up to 25) — best rates are ranked ACROSS all of them, not per state. |
| intro_text_override |
Update an existing monitor. Only provided fields will be updated.
| Argument | Type | Description |
|---|---|---|
| name | string | New name for the monitor. |
| status | string | New status for the monitor. |
| conditions | array | New array of conditions. |
| monitor_id* | string | The unique identifier of the monitor to update. Required. |
| webhook_url | string | New webhook URL. |
| cooldown_hours | number | New cooldown period in hours (1-168). |
{
"type": "object",
"required": [
"monitor_id"
],
"properties": {
"name": {
"type": "string",
"description": "New name for the monitor."
},
"status": {
"enum": [
"active",
"paused",
"disabled"
],
"type": "string",
"description": "New status for the monitor."
},
"conditions": {
"type": "array",
"items": {
"type": "object",
"required": [
"field",
"operator",
"value"
],
"properties": {
"field": {
"enum": [
"rate",
"apr",
"monthly_payment"
],
"type": "string"
},
"value": {
"type": "number"
},
"operator": {
"enum": [
"lt",
"lte",
"gt",
"gte",
"eq",
"change_pct"
],
"type": "string"
}
}
},
"description": "New array of conditions."
},
"monitor_id": {
"type": "string",
"description": "The unique identifier of the monitor to update. Required."
},
"webhook_url": {
"type": "string",
"description": "New webhook URL."
},
"cooldown_hours": {
"type": "number",
"description": "New cooldown period in hours (1-168)."
}
}
}| rent_growth_rate |
| number |
| Annual rent growth as %. Default 3.0. |
| selling_cost_pct | number | Selling costs as % of sale price. Default 6.0. |
| marginal_tax_rate | number | Marginal tax rate as %, used to model mortgage-interest/property-tax deduction. Default 0 (no deduction). |
| property_tax_rate | number | Annual property tax as % of home value. Default 1.1. |
| holding_period_years | number | How many years you plan to own. Default 7. |
| home_appreciation_rate | number | Annual home appreciation as %. Default 3.0. |
| investment_return_rate | number | Opportunity cost return on invested savings as %. Default 5.0. |
{
"type": "object",
"required": [
"home_price",
"monthly_rent"
],
"properties": {
"rate": {
"type": "number",
"description": "Annual interest rate, e.g. 6.5. If omitted, best market rate for the state is used."
},
"state": {
"type": "string",
"description": "2-letter US state code for the market-rate lookup. Default CA."
},
"pmi_rate": {
"type": "number",
"description": "Annual PMI as % of loan balance. Default 0.5, applied only when LTV > 80%."
},
"home_price": {
"type": "number",
"description": "Purchase price in dollars. Required."
},
"monthly_hoa": {
"type": "number",
"description": "HOA dues in dollars/month. Default 0."
},
"term_months": {
"type": "number",
"description": "Loan term in months. Default 360."
},
"down_payment": {
"type": "number",
"description": "Cash down payment in dollars. Default 20% of home_price."
},
"monthly_rent": {
"type": "number",
"description": "Current monthly rent in dollars. Required."
},
"annual_insurance": {
"type": "number",
"description": "Homeowners insurance in dollars/year. Default max(800, 0.35% of home price)."
},
"closing_cost_pct": {
"type": "number",
"description": "Buying closing costs as % of home price. Default 3.0."
},
"maintenance_rate": {
"type": "number",
"description": "Annual maintenance as % of home value. Default 1.0."
},
"rent_growth_rate": {
"type": "number",
"description": "Annual rent growth as %. Default 3.0."
},
"selling_cost_pct": {
"type": "number",
"description": "Selling costs as % of sale price. Default 6.0."
},
"marginal_tax_rate": {
"type": "number",
"description": "Marginal tax rate as %, used to model mortgage-interest/property-tax deduction. Default 0 (no deduction)."
},
"property_tax_rate": {
"type": "number",
"description": "Annual property tax as % of home value. Default 1.1."
},
"holding_period_years": {
"type": "number",
"description": "How many years you plan to own. Default 7."
},
"home_appreciation_rate": {
"type": "number",
"description": "Annual home appreciation as %. Default 3.0."
},
"investment_return_rate": {
"type": "number",
"description": "Opportunity cost return on invested savings as %. Default 5.0."
}
}
}| rate_shift_bps |
| number |
| Hypothetical bps move if waiting; default derived from observed movement |
{
"type": "object",
"required": [
"product_type",
"state",
"loan_amount"
],
"properties": {
"since": {
"enum": [
"1w",
"2w",
"4w"
],
"type": "string",
"description": "Movement window (default 4w)"
},
"state": {
"type": "string",
"description": "2-letter US state code"
},
"loan_amount": {
"type": "number",
"description": "Loan amount in dollars — drives break-even sensitivity"
},
"term_months": {
"type": "number",
"description": "Loan term in months (default 360 for mortgage)"
},
"current_rate": {
"type": "number",
"description": "Borrower's existing or quoted rate %, enables refi-now framing"
},
"product_type": {
"enum": [
"mortgage",
"mortgage_arm",
"auto_loan",
"rv",
"boat",
"motorcycle",
"powersports",
"heloc",
"personal_loan",
"credit_card",
"student_loan",
"equipment_loan"
],
"type": "string",
"description": "Loan product"
},
"closing_costs": {
"type": "number",
"description": "Closing/refi costs in dollars (default 0)"
},
"rate_shift_bps": {
"type": "number",
"description": "Hypothetical bps move if waiting; default derived from observed movement"
}
}
}| number |
| $ to exercise float-down; default 0 |
| float_down_rate | number | optional explicit floated rate % |
| lock_expiration_date* | string | ISO date YYYY-MM-DD |
{
"type": "object",
"required": [
"product_type",
"state",
"loan_amount",
"lock_expiration_date",
"locked_rate"
],
"properties": {
"since": {
"enum": [
"1w",
"2w",
"4w"
],
"type": "string",
"description": "movement window; default 4w"
},
"state": {
"type": "string",
"description": "2-letter state code"
},
"loan_amount": {
"type": "number"
},
"locked_rate": {
"type": "number",
"description": "% already locked"
},
"term_months": {
"type": "number",
"description": "default 360"
},
"product_type": {
"enum": [
"mortgage",
"mortgage_arm",
"auto_loan",
"rv",
"boat",
"motorcycle",
"powersports",
"heloc",
"personal_loan",
"credit_card",
"student_loan",
"equipment_loan"
],
"type": "string"
},
"float_down_bps": {
"type": "number",
"description": "optional improvement in bps if float_down_rate omitted"
},
"float_down_cost": {
"type": "number",
"description": "$ to exercise float-down; default 0"
},
"float_down_rate": {
"type": "number",
"description": "optional explicit floated rate %"
},
"lock_expiration_date": {
"type": "string",
"description": "ISO date YYYY-MM-DD"
}
}
}| extra_monthly_payment | number | Optional extra principal paid each month. Drives the payoff-acceleration analysis (months saved, interest saved). |
| extra_one_time_payment | number | Optional one-time extra principal payment. |
{
"type": "object",
"required": [
"loan_amount",
"term_months"
],
"properties": {
"rate": {
"type": "number",
"description": "Annual interest rate as a percent (e.g. 6.5). If omitted, the market rate is resolved from real credit-union offers via the decision engine."
},
"state": {
"type": "string",
"description": "2-letter US state code; required only when rate is omitted (for market-rate lookup)."
},
"loan_amount": {
"type": "number",
"description": "Loan principal in dollars (required, > 0)."
},
"term_months": {
"type": "number",
"description": "Loan term in months, e.g. 360 or 180 (required)."
},
"credit_score": {
"type": "number",
"description": "Optional borrower credit score used to qualify the market offer."
},
"product_type": {
"enum": [
"mortgage",
"auto_loan",
"rv",
"boat",
"motorcycle",
"powersports",
"heloc",
"personal_loan",
"student_loan",
"equipment_loan"
],
"type": "string",
"description": "Loan product; required only when rate is omitted. Default mortgage."
},
"schedule_granularity": {
"enum": [
"year",
"month"
],
"type": "string",
"description": "Schedule row granularity. Default year."
},
"extra_monthly_payment": {
"type": "number",
"description": "Optional extra principal paid each month. Drives the payoff-acceleration analysis (months saved, interest saved)."
},
"extra_one_time_payment": {
"type": "number",
"description": "Optional one-time extra principal payment."
}
}
}| Argument | Type | Description |
|---|---|---|
| zip | string | User's US 5-digit ZIP or ZIP+4. Resolves to a county server-side; when state is supplied, the ZIP crosswalk must agree with it. |
| state | string | User's valid 50-state/DC code for geographic field-of-membership matching. Lowercase is accepted and normalized. |
| county | string | User's home county for residence matching. Original name; home_county is an equivalent merge-and-retry alias. |
| school | string | User's school/college/university. Supply school_relationship too; the school name alone does not affirm eligibility. |
| worship | string | User's place of worship, matched against worship-org affinity lists (yields likely_eligible). |
| employer | string | User's employer, matched against credit union employer/SEG membership lists. |
| home_zip | string | Alias for zip, accepted so missing_facts can be merged into this same tool request. It must agree with state/home_state when either is supplied; conflicting duplicate forms are rejected. |
| work_zip | string | User's US 5-digit work ZIP or ZIP+4. Resolves to a work county server-side; when work_state is supplied, the crosswalk must agree with it. |
| home_city | string | User's Census-recognized home city. Requires state or a recognized zip that uniquely identifies one state; unresolved labels are rejected rather than guessed. |
| work_city | string | Census-recognized city where the user works. Requires work_state or a recognized work_zip that uniquely identifies one state. |
| home_state | string | Alias for state, accepted so missing_facts can be merged into this same tool request. Conflicting duplicate forms are rejected. |
| occupation | string | User's occupation, matched against trade/industry/profession (TIP) charters. |
| work_state | string | Valid 50-state/DC code where the user works, for work-area membership matching. Lowercase is accepted and normalized. |
| home_county | string | Alias for county, accepted so missing_facts can be merged into this same tool request. Conflicting duplicate forms are rejected. |
| payroll_zip | string | ZIP from which the user's employer issues payroll. This is distinct from the worksite ZIP. |
| work_county | string | County where the user works, for work-area membership matching. |
| facility_zip | string | ZIP where the user's business maintains a location. Distinct from the worksite ZIP. |
| payroll_city | string | Census-recognized payroll city. Requires payroll_state or a recognized payroll_zip that uniquely identifies one state. |
| property_zip | string | ZIP where the user OWNS REAL PROPERTY. A door of its own — never inferred from where they live, and an absentee owner qualifies. |
| facility_city | string | Census-recognized city where the user's business maintains a location. Requires facility_state or a recognized facility_zip that uniquely identifies one state. |
| payroll_state | string | Valid state code from which the user's employer issues payroll. This is distinct from work_state. |
| property_city | string | Census-recognized city where the user owns real property. Requires property_state or a recognized property_zip that uniquely identifies one state. |
| applicant_kind | string | What the applicant IS. Some charters admit entities as well as people. Absent means a natural person; a person is never rejected by an entity-only door, only left unknown. |
| facility_state | string | State where the user's business maintains a location. |
| payroll_county | string | County from which the user's employer issues payroll. This is distinct from work_county. |
| property_state | string | State where the user owns real property. Distinct from home_state. |
| school_org_ids | array | Canonical school ids selected through resolve_eligibility_entities; never populate these from prose extraction. |
| facility_county | string | County where the user's business maintains a location. |
| family_relation | string | How the user relates to a RELATIVE whose own affiliations may qualify them (e.g. 'spouse', 'child', 'immediate family'). Required alongside relative_employers/relative_schools/relative_associations — without it there is nobody for those organizations to belong to. Many SEG lists read 'Employees of the following companies AND THEIR IMMEDIATE FAMILIES are eligible'; this is how that door is answered. |
| military_status | string | User's military affiliation, matched against military field-of-membership (yields eligible_via_military). |
| property_county | string | County where the user owns real property. Distinct from home_county. |
| worship_org_ids | array | Canonical worship-organization ids selected through resolve_eligibility_entities. |
| credit_union_ids* | array | Credit union ids to check (1-50), e.g. from get_financing_decision offers or list_credit_unions. Required. |
| employer_org_ids | array | Canonical employer ids selected through resolve_eligibility_entities. The API revalidates entity type and active-publication authority before use. |
| relative_schools | array | Schools the RELATIVE named by family_relation attends. Optional; same unknown-by-default contract as relative_employers. |
| relative_employers | array | Employers of the RELATIVE named by family_relation (not the user's own employer). Optional; omitting it leaves compound family doors undecided (unknown), never negative. |
| association_org_ids | array | Canonical association ids selected through resolve_eligibility_entities; each is type- and publication-revalidated. |
| school_relationship | string | How the user relates to the named school. Required with school to affirm a typed student, alumni, or school-employee path. |
| relative_memberships | array | Confirmed relative memberships scoped to one exact credit union. A membership at one institution is never reused for another; omit unconfirmed memberships and the corresponding family door remains unknown. |
| relative_associations | array | Associations the RELATIVE named by family_relation belongs to. Optional; same unknown-by-default contract as relative_employers. |
| military_service_state | string | The state the user serves, or served, in. State National Guard doors ("Oklahoma National Guard") need this; without it such a door reads unknown. |
| asserted_org_qualifiers | array | Narrowings the user asserts about themselves, quoted back from a missing_facts question (e.g. "assigned as Recruiters or ROTC Instructors within the State of Arkansas"). Absence caps a narrowed door rather than closing it. |
| relative_school_org_ids | array | Canonical school ids for the relative named by family_relation, never for the applicant. |
| relative_employer_org_ids | array | Canonical employer ids for the relative named by family_relation, never for the applicant. |
| relative_association_org_ids | array | Canonical association ids for the relative named by family_relation, never for the applicant. |
{
"type": "object",
"required": [
"credit_union_ids"
],
"properties": {
"zip": {
"type": "string",
"pattern": "^\\d{5}(?:-\\d{4})?$",
"description": "User's US 5-digit ZIP or ZIP+4. Resolves to a county server-side; when state is supplied, the ZIP crosswalk must agree with it."
},
"state": {
"type": "string",
"pattern": "^(?:[Aa][Ll]|[Aa][Kk]|[Aa][Zz]|[Aa][Rr]|[Cc][Aa]|[Cc][Oo]|[Cc][Tt]|[Dd][Ee]|[Dd][Cc]|[Ff][Ll]|[Gg][Aa]|[Hh][Ii]|[Ii][Dd]|[Ii][Ll]|[Ii][Nn]|[Ii][Aa]|[Kk][Ss]|[Kk][Yy]|[Ll][Aa]|[Mm][Ee]|[Mm][Dd]|[Mm][Aa]|[Mm][Ii]|[Mm][Nn]|[Mm][Ss]|[Mm][Oo]|[Mm][Tt]|[Nn][Ee]|[Nn][Vv]|[Nn][Hh]|[Nn][Jj]|[Nn][Mm]|[Nn][Yy]|[Nn][Cc]|[Nn][Dd]|[Oo][Hh]|[Oo][Kk]|[Oo][Rr]|[Pp][Aa]|[Rr][Ii]|[Ss][Cc]|[Ss][Dd]|[Tt][Nn]|[Tt][Xx]|[Uu][Tt]|[Vv][Tt]|[Vv][Aa]|[Ww][Aa]|[Ww][Vv]|[Ww][Ii]|[Ww][Yy])$",
"description": "User's valid 50-state/DC code for geographic field-of-membership matching. Lowercase is accepted and normalized."
},
"county": {
"type": "string",
"description": "User's home county for residence matching. Original name; home_county is an equivalent merge-and-retry alias."
},
"school": {
"type": "string",
"description": "User's school/college/university. Supply school_relationship too; the school name alone does not affirm eligibility."
},
"worship": {
"type": "string",
"description": "User's place of worship, matched against worship-org affinity lists (yields likely_eligible)."
},
"employer": {
"type": "string",
"description": "User's employer, matched against credit union employer/SEG membership lists."
},
"home_zip": {
"type": "string",
"pattern": "^\\d{5}(?:-\\d{4})?$",
"description": "Alias for zip, accepted so missing_facts can be merged into this same tool request. It must agree with state/home_state when either is supplied; conflicting duplicate forms are rejected."
},
"work_zip": {
"type": "string",
"pattern": "^\\d{5}(?:-\\d{4})?$",
"description": "User's US 5-digit work ZIP or ZIP+4. Resolves to a work county server-side; when work_state is supplied, the crosswalk must agree with it."
},
"home_city": {
"type": "string",
"description": "User's Census-recognized home city. Requires state or a recognized zip that uniquely identifies one state; unresolved labels are rejected rather than guessed."
},
"work_city": {
"type": "string",
"description": "Census-recognized city where the user works. Requires work_state or a recognized work_zip that uniquely identifies one state."
},
"home_state": {
"type": "string",
"pattern": "^(?:[Aa][Ll]|[Aa][Kk]|[Aa][Zz]|[Aa][Rr]|[Cc][Aa]|[Cc][Oo]|[Cc][Tt]|[Dd][Ee]|[Dd][Cc]|[Ff][Ll]|[Gg][Aa]|[Hh][Ii]|[Ii][Dd]|[Ii][Ll]|[Ii][Nn]|[Ii][Aa]|[Kk][Ss]|[Kk][Yy]|[Ll][Aa]|[Mm][Ee]|[Mm][Dd]|[Mm][Aa]|[Mm][Ii]|[Mm][Nn]|[Mm][Ss]|[Mm][Oo]|[Mm][Tt]|[Nn][Ee]|[Nn][Vv]|[Nn][Hh]|[Nn][Jj]|[Nn][Mm]|[Nn][Yy]|[Nn][Cc]|[Nn][Dd]|[Oo][Hh]|[Oo][Kk]|[Oo][Rr]|[Pp][Aa]|[Rr][Ii]|[Ss][Cc]|[Ss][Dd]|[Tt][Nn]|[Tt][Xx]|[Uu][Tt]|[Vv][Tt]|[Vv][Aa]|[Ww][Aa]|[Ww][Vv]|[Ww][Ii]|[Ww][Yy])$",
"description": "Alias for state, accepted so missing_facts can be merged into this same tool request. Conflicting duplicate forms are rejected."
},
"occupation": {
"type": "string",
"description": "User's occupation, matched against trade/industry/profession (TIP) charters."
},
"work_state": {
"type": "string",
"pattern": "^(?:[Aa][Ll]|[Aa][Kk]|[Aa][Zz]|[Aa][Rr]|[Cc][Aa]|[Cc][Oo]|[Cc][Tt]|[Dd][Ee]|[Dd][Cc]|[Ff][Ll]|[Gg][Aa]|[Hh][Ii]|[Ii][Dd]|[Ii][Ll]|[Ii][Nn]|[Ii][Aa]|[Kk][Ss]|[Kk][Yy]|[Ll][Aa]|[Mm][Ee]|[Mm][Dd]|[Mm][Aa]|[Mm][Ii]|[Mm][Nn]|[Mm][Ss]|[Mm][Oo]|[Mm][Tt]|[Nn][Ee]|[Nn][Vv]|[Nn][Hh]|[Nn][Jj]|[Nn][Mm]|[Nn][Yy]|[Nn][Cc]|[Nn][Dd]|[Oo][Hh]|[Oo][Kk]|[Oo][Rr]|[Pp][Aa]|[Rr][Ii]|[Ss][Cc]|[Ss][Dd]|[Tt][Nn]|[Tt][Xx]|[Uu][Tt]|[Vv][Tt]|[Vv][Aa]|[Ww][Aa]|[Ww][Vv]|[Ww][Ii]|[Ww][Yy])$",
"description": "Valid 50-state/DC code where the user works, for work-area membership matching. Lowercase is accepted and normalized."
},
"home_county": {
"type": "string",
"description": "Alias for county, accepted so missing_facts can be merged into this same tool request. Conflicting duplicate forms are rejected."
},
"payroll_zip": {
"type": "string",
"pattern": "^\\d{5}(?:-\\d{4})?$",
"description": "ZIP from which the user's employer issues payroll. This is distinct from the worksite ZIP."
},
"work_county": {
"type": "string",
"description": "County where the user works, for work-area membership matching."
},
"facility_zip": {
"type": "string",
"pattern": "^\\d{5}(?:-\\d{4})?$",
"description": "ZIP where the user's business maintains a location. Distinct from the worksite ZIP."
},
"payroll_city": {
"type": "string",
"description": "Census-recognized payroll city. Requires payroll_state or a recognized payroll_zip that uniquely identifies one state."
},
"property_zip": {
"type": "string",
"pattern": "^\\d{5}(?:-\\d{4})?$",
"description": "ZIP where the user OWNS REAL PROPERTY. A door of its own — never inferred from where they live, and an absentee owner qualifies."
},
"facility_city": {
"type": "string",
"description": "Census-recognized city where the user's business maintains a location. Requires facility_state or a recognized facility_zip that uniquely identifies one state."
},
"payroll_state": {
"type": "string",
"pattern": "^(?:[Aa][Ll]|[Aa][Kk]|[Aa][Zz]|[Aa][Rr]|[Cc][Aa]|[Cc][Oo]|[Cc][Tt]|[Dd][Ee]|[Dd][Cc]|[Ff][Ll]|[Gg][Aa]|[Hh][Ii]|[Ii][Dd]|[Ii][Ll]|[Ii][Nn]|[Ii][Aa]|[Kk][Ss]|[Kk][Yy]|[Ll][Aa]|[Mm][Ee]|[Mm][Dd]|[Mm][Aa]|[Mm][Ii]|[Mm][Nn]|[Mm][Ss]|[Mm][Oo]|[Mm][Tt]|[Nn][Ee]|[Nn][Vv]|[Nn][Hh]|[Nn][Jj]|[Nn][Mm]|[Nn][Yy]|[Nn][Cc]|[Nn][Dd]|[Oo][Hh]|[Oo][Kk]|[Oo][Rr]|[Pp][Aa]|[Rr][Ii]|[Ss][Cc]|[Ss][Dd]|[Tt][Nn]|[Tt][Xx]|[Uu][Tt]|[Vv][Tt]|[Vv][Aa]|[Ww][Aa]|[Ww][Vv]|[Ww][Ii]|[Ww][Yy])$",
"description": "Valid state code from which the user's employer issues payroll. This is distinct from work_state."
},
"property_city": {
"type": "string",
"description": "Census-recognized city where the user owns real property. Requires property_state or a recognized property_zip that uniquely identifies one state."
},
"applicant_kind": {
"enum": [
"person",
"trust",
"organization",
"partnership",
"corporation",
"other_legal_entity"
],
"type": "string",
"description": "What the applicant IS. Some charters admit entities as well as people. Absent means a natural person; a person is never rejected by an entity-only door, only left unknown."
},
"facility_state": {
"type": "string",
"pattern": "^(?:[Aa][Ll]|[Aa][Kk]|[Aa][Zz]|[Aa][Rr]|[Cc][Aa]|[Cc][Oo]|[Cc][Tt]|[Dd][Ee]|[Dd][Cc]|[Ff][Ll]|[Gg][Aa]|[Hh][Ii]|[Ii][Dd]|[Ii][Ll]|[Ii][Nn]|[Ii][Aa]|[Kk][Ss]|[Kk][Yy]|[Ll][Aa]|[Mm][Ee]|[Mm][Dd]|[Mm][Aa]|[Mm][Ii]|[Mm][Nn]|[Mm][Ss]|[Mm][Oo]|[Mm][Tt]|[Nn][Ee]|[Nn][Vv]|[Nn][Hh]|[Nn][Jj]|[Nn][Mm]|[Nn][Yy]|[Nn][Cc]|[Nn][Dd]|[Oo][Hh]|[Oo][Kk]|[Oo][Rr]|[Pp][Aa]|[Rr][Ii]|[Ss][Cc]|[Ss][Dd]|[Tt][Nn]|[Tt][Xx]|[Uu][Tt]|[Vv][Tt]|[Vv][Aa]|[Ww][Aa]|[Ww][Vv]|[Ww][Ii]|[Ww][Yy])$",
"description": "State where the user's business maintains a location."
},
"payroll_county": {
"type": "string",
"description": "County from which the user's employer issues payroll. This is distinct from work_county."
},
"property_state": {
"type": "string",
"pattern": "^(?:[Aa][Ll]|[Aa][Kk]|[Aa][Zz]|[Aa][Rr]|[Cc][Aa]|[Cc][Oo]|[Cc][Tt]|[Dd][Ee]|[Dd][Cc]|[Ff][Ll]|[Gg][Aa]|[Hh][Ii]|[Ii][Dd]|[Ii][Ll]|[Ii][Nn]|[Ii][Aa]|[Kk][Ss]|[Kk][Yy]|[Ll][Aa]|[Mm][Ee]|[Mm][Dd]|[Mm][Aa]|[Mm][Ii]|[Mm][Nn]|[Mm][Ss]|[Mm][Oo]|[Mm][Tt]|[Nn][Ee]|[Nn][Vv]|[Nn][Hh]|[Nn][Jj]|[Nn][Mm]|[Nn][Yy]|[Nn][Cc]|[Nn][Dd]|[Oo][Hh]|[Oo][Kk]|[Oo][Rr]|[Pp][Aa]|[Rr][Ii]|[Ss][Cc]|[Ss][Dd]|[Tt][Nn]|[Tt][Xx]|[Uu][Tt]|[Vv][Tt]|[Vv][Aa]|[Ww][Aa]|[Ww][Vv]|[Ww][Ii]|[Ww][Yy])$",
"description": "State where the user owns real property. Distinct from home_state."
},
"school_org_ids": {
"type": "array",
"items": {
"type": "string",
"pattern": "^[a-z0-9]+(?:-[a-z0-9]+)*$",
"maxLength": 80,
"minLength": 1
},
"maxItems": 20,
"description": "Canonical school ids selected through resolve_eligibility_entities; never populate these from prose extraction.",
"uniqueItems": true
},
"facility_county": {
"type": "string",
"description": "County where the user's business maintains a location."
},
"family_relation": {
"type": "string",
"description": "How the user relates to a RELATIVE whose own affiliations may qualify them (e.g. 'spouse', 'child', 'immediate family'). Required alongside relative_employers/relative_schools/relative_associations — without it there is nobody for those organizations to belong to. Many SEG lists read 'Employees of the following companies AND THEIR IMMEDIATE FAMILIES are eligible'; this is how that door is answered."
},
"military_status": {
"enum": [
"active_duty",
"veteran",
"reservist",
"dod_civilian",
"military_family"
],
"type": "string",
"description": "User's military affiliation, matched against military field-of-membership (yields eligible_via_military)."
},
"property_county": {
"type": "string",
"description": "County where the user owns real property. Distinct from home_county."
},
"worship_org_ids": {
"type": "array",
"items": {
"type": "string",
"pattern": "^[a-z0-9]+(?:-[a-z0-9]+)*$",
"maxLength": 80,
"minLength": 1
},
"maxItems": 20,
"description": "Canonical worship-organization ids selected through resolve_eligibility_entities.",
"uniqueItems": true
},
"credit_union_ids": {
"type": "array",
"items": {
"type": "string"
},
"maxItems": 50,
"minItems": 1,
"description": "Credit union ids to check (1-50), e.g. from get_financing_decision offers or list_credit_unions. Required."
},
"employer_org_ids": {
"type": "array",
"items": {
"type": "string",
"pattern": "^[a-z0-9]+(?:-[a-z0-9]+)*$",
"maxLength": 80,
"minLength": 1
},
"maxItems": 20,
"description": "Canonical employer ids selected through resolve_eligibility_entities. The API revalidates entity type and active-publication authority before use.",
"uniqueItems": true
},
"relative_schools": {
"type": "array",
"items": {
"type": "string"
},
"description": "Schools the RELATIVE named by family_relation attends. Optional; same unknown-by-default contract as relative_employers."
},
"relative_employers": {
"type": "array",
"items": {
"type": "string"
},
"description": "Employers of the RELATIVE named by family_relation (not the user's own employer). Optional; omitting it leaves compound family doors undecided (unknown), never negative."
},
"association_org_ids": {
"type": "array",
"items": {
"type": "string",
"pattern": "^[a-z0-9]+(?:-[a-z0-9]+)*$",
"maxLength": 80,
"minLength": 1
},
"maxItems": 20,
"description": "Canonical association ids selected through resolve_eligibility_entities; each is type- and publication-revalidated.",
"uniqueItems": true
},
"school_relationship": {
"enum": [
"student",
"alumni",
"employee"
],
"type": "string",
"description": "How the user relates to the named school. Required with school to affirm a typed student, alumni, or school-employee path."
},
"relative_memberships": {
"type": "array",
"items": {
"type": "object",
"required": [
"credit_union_id",
"relation",
"status"
],
"properties": {
"status": {
"enum": [
"current_member",
"deceased_member"
],
"type": "string"
},
"relation": {
"type": "string",
"description": "The relative's relationship to the applicant."
},
"credit_union_id": {
"type": "string",
"description": "The exact target credit union id."
}
},
"additionalProperties": false
},
"maxItems": 50,
"description": "Confirmed relative memberships scoped to one exact credit union. A membership at one institution is never reused for another; omit unconfirmed memberships and the corresponding family door remains unknown."
},
"relative_associations": {
"type": "array",
"items": {
"type": "string"
},
"description": "Associations the RELATIVE named by family_relation belongs to. Optional; same unknown-by-default contract as relative_employers."
},
"military_service_state": {
"type": "string",
"pattern": "^(?:[Aa][Ll]|[Aa][Kk]|[Aa][Zz]|[Aa][Rr]|[Cc][Aa]|[Cc][Oo]|[Cc][Tt]|[Dd][Ee]|[Dd][Cc]|[Ff][Ll]|[Gg][Aa]|[Hh][Ii]|[Ii][Dd]|[Ii][Ll]|[Ii][Nn]|[Ii][Aa]|[Kk][Ss]|[Kk][Yy]|[Ll][Aa]|[Mm][Ee]|[Mm][Dd]|[Mm][Aa]|[Mm][Ii]|[Mm][Nn]|[Mm][Ss]|[Mm][Oo]|[Mm][Tt]|[Nn][Ee]|[Nn][Vv]|[Nn][Hh]|[Nn][Jj]|[Nn][Mm]|[Nn][Yy]|[Nn][Cc]|[Nn][Dd]|[Oo][Hh]|[Oo][Kk]|[Oo][Rr]|[Pp][Aa]|[Rr][Ii]|[Ss][Cc]|[Ss][Dd]|[Tt][Nn]|[Tt][Xx]|[Uu][Tt]|[Vv][Tt]|[Vv][Aa]|[Ww][Aa]|[Ww][Vv]|[Ww][Ii]|[Ww][Yy])$",
"description": "The state the user serves, or served, in. State National Guard doors (\"Oklahoma National Guard\") need this; without it such a door reads unknown."
},
"asserted_org_qualifiers": {
"type": "array",
"items": {
"type": "string"
},
"maxItems": 20,
"description": "Narrowings the user asserts about themselves, quoted back from a missing_facts question (e.g. \"assigned as Recruiters or ROTC Instructors within the State of Arkansas\"). Absence caps a narrowed door rather than closing it."
},
"relative_school_org_ids": {
"type": "array",
"items": {
"type": "string",
"pattern": "^[a-z0-9]+(?:-[a-z0-9]+)*$",
"maxLength": 80,
"minLength": 1
},
"maxItems": 20,
"description": "Canonical school ids for the relative named by family_relation, never for the applicant.",
"uniqueItems": true
},
"relative_employer_org_ids": {
"type": "array",
"items": {
"type": "string",
"pattern": "^[a-z0-9]+(?:-[a-z0-9]+)*$",
"maxLength": 80,
"minLength": 1
},
"maxItems": 20,
"description": "Canonical employer ids for the relative named by family_relation, never for the applicant.",
"uniqueItems": true
},
"relative_association_org_ids": {
"type": "array",
"items": {
"type": "string",
"pattern": "^[a-z0-9]+(?:-[a-z0-9]+)*$",
"maxLength": 80,
"minLength": 1
},
"maxItems": 20,
"description": "Canonical association ids for the relative named by family_relation, never for the applicant.",
"uniqueItems": true
}
}
}{
"type": "object",
"required": [
"state",
"amount",
"product_types"
],
"properties": {
"state": {
"type": "string",
"description": "US state code, e.g. \"CA\""
},
"amount": {
"type": "number",
"description": "Loan/credit amount in dollars"
},
"intent": {
"type": "string",
"description": "purchase | refinance | cash_out | balance_transfer | new_credit"
},
"term_months": {
"type": "number",
"description": "Optional loan term in months"
},
"credit_score": {
"type": "number",
"description": "Optional borrower credit score"
},
"product_types": {
"type": "array",
"items": {
"type": "string"
},
"description": "Products to compare, e.g. [\"mortgage\",\"heloc\"]. Any of: mortgage, mortgage_arm, auto, rv, boat, motorcycle, powersports, heloc, personal_loan, credit_card, student_loan. \"mortgage\" is fixed-rate and \"mortgage_arm\" is adjustable — comparing them side by side is meaningful, but they are never blended into one ranking. Boats/RVs/motorcycles/powersports are first-class product types; auto means cars."
}
}
}| holding_period_months |
| number |
| Horizon for total-cost; defaults to term_months |
{
"type": "object",
"required": [
"product_type",
"state",
"amount"
],
"properties": {
"fees": {
"type": "object",
"properties": {
"flat_fees": {
"type": "number"
},
"origination_percent": {
"type": "number"
}
}
},
"state": {
"type": "string",
"description": "2-letter US state"
},
"amount": {
"type": "number",
"description": "Loan principal"
},
"intent": {
"enum": [
"purchase",
"refinance"
],
"type": "string",
"description": "default purchase"
},
"max_lenders": {
"type": "number",
"description": "cap on ranked rows (default 10, max 25)"
},
"term_months": {
"type": "number"
},
"credit_score": {
"type": "number"
},
"product_type": {
"enum": [
"mortgage",
"auto_loan",
"rv",
"boat",
"motorcycle",
"powersports",
"personal_loan",
"heloc",
"student_loan",
"equipment_loan"
],
"type": "string",
"description": "Loan product to rank"
},
"down_payment_percent": {
"type": "number"
},
"holding_period_months": {
"type": "number",
"description": "Horizon for total-cost; defaults to term_months"
}
}
}| Default mortgage. |
| cooldown_hours | number | 1-168, default 24. |
| target_credit_union* | object | The specific credit union whose published rate to watch. Required. |
{
"type": "object",
"required": [
"name",
"target_credit_union",
"webhook_url"
],
"properties": {
"name": {
"type": "string",
"description": "Descriptive monitor name. Required."
},
"state": {
"type": "string",
"description": "2-letter state for the CU published rate."
},
"audience": {
"enum": [
"business",
"consumer"
],
"type": "string",
"description": "Scope offers by WHO they are for: 'business' returns business-audience products (DSCR mortgages, commercial vehicle loans, SBA); 'consumer' excludes them. Omit for both."
},
"occupancy": {
"enum": [
"primary",
"secondary",
"investment"
],
"type": "string",
"description": "MORTGAGE/HELOC: property occupancy. 'investment' returns investor / non-owner-occupied / DSCR pricing; 'secondary' second-home pricing. Omit for standard primary-residence offers."
},
"conditions": {
"type": "object",
"properties": {
"min_change_bps": {
"type": "number",
"description": "Min basis-point move to alert. Default 0."
},
"change_direction": {
"enum": [
"up",
"down",
"any"
],
"type": "string"
}
},
"description": "Alert conditions on the named CU rate. Default: any change."
},
"webhook_url": {
"type": "string",
"description": "HTTPS webhook. Required."
},
"loan_program": {
"type": "string",
"description": "e.g. '30-year-fixed'."
},
"product_type": {
"enum": [
"mortgage",
"auto_loan",
"rv",
"boat",
"motorcycle",
"powersports",
"heloc",
"personal_loan",
"credit_card",
"student_loan",
"equipment_loan"
],
"type": "string",
"description": "Default mortgage."
},
"cooldown_hours": {
"type": "number",
"description": "1-168, default 24."
},
"target_credit_union": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Optional human label / lookup by name."
},
"credit_union_id": {
"type": "string",
"description": "CU id from list_credit_unions/get_credit_union."
}
},
"description": "The specific credit union whose published rate to watch. Required."
}
}
}| 2-letter US state codes (up to 25) — best rates are ranked ACROSS all of them, not per state. |
| intro_text_override | string | Per-campaign intro; falls back to branding intro_text. |
{
"type": "object",
"required": [
"name"
],
"properties": {
"name": {
"type": "string",
"description": "Campaign label. Required."
},
"region": {
"enum": [
"east_coast",
"west_coast",
"midwest",
"south",
"northeast",
"southeast",
"southwest",
"mountain_west",
"new_england",
"mid_atlantic",
"pacific_northwest"
],
"type": "string",
"description": "Named region preset (e.g. east_coast); expands server-side to its member states."
},
"cadence": {
"enum": [
"daily",
"weekly",
"monthly"
],
"type": "string",
"description": "Send cadence (default weekly)."
},
"products": {
"type": "array",
"items": {
"type": "object"
},
"description": "1-5 products to feature (no duplicates). Each is {category:'mortgage', subtype:'30-year-fixed'|'15-year-fixed'}, {category:'auto', condition:'new'|'used'|'any', term_months?:36|48|60|72|84}, or {category:'rv'|'boat'|'motorcycle', condition:'new'|'used'|'any'}."
},
"state_code": {
"type": "string",
"description": "Legacy single 2-letter US state code (e.g. CA). Prefer state_codes or region for multi-state coverage."
},
"state_codes": {
"type": "array",
"items": {
"type": "string"
},
"maxItems": 25,
"description": "2-letter US state codes (up to 25) — best rates are ranked ACROSS all of them, not per state."
},
"intro_text_override": {
"type": "string",
"description": "Per-campaign intro; falls back to branding intro_text."
}
}
}| Gross annual income in dollars |
| monthly_debts | number | Existing recurring monthly debt payments. Default 0. |
{
"type": "object",
"required": [
"income_annual"
],
"properties": {
"rate": {
"type": "number",
"description": "Optional annual interest rate, e.g. 6.5. If omitted, best market rate is used."
},
"state": {
"type": "string",
"description": "US state code for the market-rate lookup. Default CA."
},
"term_months": {
"type": "number",
"description": "Loan term in months. Default 360."
},
"back_end_dti": {
"type": "number",
"description": "Total-debt DTI cap as a decimal. Default 0.36."
},
"down_payment": {
"type": "number",
"description": "Cash down payment in dollars. Default 0."
},
"product_type": {
"type": "string",
"description": "Product for the market-rate lookup. Default mortgage."
},
"front_end_dti": {
"type": "number",
"description": "Housing-payment DTI cap as a decimal. Default 0.28."
},
"income_annual": {
"type": "number",
"description": "Gross annual income in dollars"
},
"monthly_debts": {
"type": "number",
"description": "Existing recurring monthly debt payments. Default 0."
}
}
}| down_payment | number | Cash down payment in dollars. Default 0. loan_amount = home_price - down_payment. |
| annual_insurance | number | Homeowners insurance in dollars/year. Default max(800, 0.35% of home price). |
| property_tax_rate | number | Annual property tax as % of home value. Default 1.1. |
{
"type": "object",
"required": [],
"properties": {
"rate": {
"type": "number",
"description": "Annual interest rate, e.g. 6.5. If omitted, best market rate for the state is used."
},
"state": {
"type": "string",
"description": "2-letter US state code for the market-rate lookup. Default CA."
},
"pmi_rate": {
"type": "number",
"description": "Annual PMI as % of loan balance. Default 0.5, applied only when LTV > 80%."
},
"home_price": {
"type": "number",
"description": "Purchase price in dollars. Required unless loan_amount is given."
},
"loan_amount": {
"type": "number",
"description": "Optional explicit loan amount; overrides home_price - down_payment."
},
"monthly_hoa": {
"type": "number",
"description": "HOA dues in dollars/month. Default 0."
},
"term_months": {
"type": "number",
"description": "Loan term in months. Default 360."
},
"credit_score": {
"type": "number",
"description": "Optional borrower credit score, used for the market-rate lookup."
},
"down_payment": {
"type": "number",
"description": "Cash down payment in dollars. Default 0. loan_amount = home_price - down_payment."
},
"annual_insurance": {
"type": "number",
"description": "Homeowners insurance in dollars/year. Default max(800, 0.35% of home price)."
},
"property_tax_rate": {
"type": "number",
"description": "Annual property tax as % of home value. Default 1.1."
}
}
}| Argument | Type | Description |
|---|---|---|
| limit | number | Maximum entries per bucket (1-200). Default 50. |
| school | string | User's school/college/university, resolved to a canonical organization. Supply school_relationship too; a name alone is not a positive match. |
| worship | string | User's place of worship, resolved to a canonical organization. |
| employer | string | User's employer, resolved to a canonical organization for SEG matching. |
| home_zip | string | User's US 5-digit home ZIP or ZIP+4. Resolves to candidate counties; when home_state is supplied, the crosswalk must agree with it. |
| work_zip | string | User's US 5-digit work ZIP or ZIP+4. Resolves to candidate work counties; when work_state is supplied, the crosswalk must agree with it. |
| home_city | string | User's Census-recognized home city. Requires home_state or a recognized home_zip that uniquely identifies one state; unresolved labels are rejected rather than guessed. |
| work_city | string | Census-recognized city where the user works. Requires work_state or a recognized work_zip that uniquely identifies one state. |
| home_state | string | User's valid 50-state/DC code (e.g., CA, TX, NY). Lowercase is accepted and normalized. |
| occupation | string | User's occupation, matched against trade, industry, and profession fields of membership. |
| work_state | string | Valid 50-state/DC code where the user works (e.g., CA, TX, NY). Lowercase is accepted and normalized. |
| home_county | string | User's county. Wins over the ZIP-derived counties when supplied. |
| payroll_zip | string | ZIP from which the user's employer issues payroll; distinct from the worksite ZIP. When payroll_state is supplied, the ZIP must agree with it. |
| work_county | string | County where the user works. Wins over work-ZIP-derived counties when supplied. |
| associations | array | Associations, unions, or member organizations the user already belongs to. |
| facility_zip | string | ZIP where the user's business maintains a location. Distinct from the worksite ZIP. |
| payroll_city | string | Census-recognized city from which payroll is issued. Requires payroll_state or a recognized payroll_zip that uniquely identifies one state. |
| property_zip | string | ZIP where the user OWNS REAL PROPERTY. A door of its own — never inferred from where they live, and an absentee owner qualifies. |
| facility_city | string | Census-recognized city where the user's business maintains a location. Requires facility_state or a recognized facility_zip that uniquely identifies one state. |
| payroll_state | string | State from which the user's employer issues payroll; distinct from work_state. |
| property_city | string | Census-recognized city where the user owns real property. Requires property_state or a recognized property_zip that uniquely identifies one state. |
| applicant_kind | string | What the applicant IS. Some charters admit entities as well as people. Absent means a natural person; a person is never rejected by an entity-only door, only left unknown. |
| facility_state | string | State where the user's business maintains a location. |
| payroll_county | string | County from which the user's employer issues payroll; distinct from work_county. |
| property_state | string | State where the user owns real property. Distinct from home_state. |
| school_org_ids | array | Canonical school ids selected through resolve_eligibility_entities; never populate these from prose extraction. |
| facility_county | string | County where the user's business maintains a location. |
| family_relation | string | How the user relates to a RELATIVE whose own affiliations may qualify them (e.g. 'spouse', 'child', 'immediate family'). Required alongside relative_employers/relative_schools/relative_associations — without it there is nobody for those organizations to belong to. Many SEG lists read 'Employees of the following companies AND THEIR IMMEDIATE FAMILIES are eligible'; this is how that door is answered. |
| military_status | string | User's military affiliation, matched against military fields of membership. |
| property_county | string | County where the user owns real property. Distinct from home_county. |
| worship_org_ids | array | Canonical worship-organization ids selected through resolve_eligibility_entities. |
| employer_org_ids | array | Canonical employer ids selected through resolve_eligibility_entities. The API revalidates entity type and active-publication authority before use. |
| relative_schools | array | Schools the RELATIVE named by family_relation attends. Optional; same unknown-by-default contract as relative_employers. |
| relative_employers | array | Employers of the RELATIVE named by family_relation (not the user's own employer). Optional; omitting it leaves compound family doors undecided (unknown), never negative. |
| association_org_ids | array | Canonical association ids selected through resolve_eligibility_entities; each is type- and publication-revalidated. |
| school_relationship | string | How the user relates to the school. Required with school to affirm a typed student, alumni, or school-employee path. |
| relative_memberships | array | Confirmed relative memberships scoped to one exact credit union. A membership at one institution is never reused for another; omit unconfirmed memberships and the corresponding family door remains unknown. |
| relative_associations | array | Associations the RELATIVE named by family_relation belongs to. Optional; same unknown-by-default contract as relative_employers. |
| military_service_state | string | The state the user serves, or served, in. State National Guard doors ("Oklahoma National Guard") need this; without it such a door reads unknown. |
| asserted_org_qualifiers | array | Narrowings the user asserts about themselves, quoted back from a missing_facts question (e.g. "assigned as Recruiters or ROTC Instructors within the State of Arkansas"). Absence caps a narrowed door rather than closing it. |
| relative_school_org_ids | array | Canonical school ids for the relative named by family_relation, never for the applicant. |
| relative_employer_org_ids | array | Canonical employer ids for the relative named by family_relation, never for the applicant. |
| willing_to_join_association | boolean | Set true to search documented joinable-association paths (valid as the sole discriminator). Set false only to suppress paths that require joining an association; false alone is not a discriminating search fact. |
| relative_association_org_ids | array | Canonical association ids for the relative named by family_relation, never for the applicant. |
{
"type": "object",
"properties": {
"limit": {
"type": "number",
"description": "Maximum entries per bucket (1-200). Default 50."
},
"school": {
"type": "string",
"description": "User's school/college/university, resolved to a canonical organization. Supply school_relationship too; a name alone is not a positive match."
},
"worship": {
"type": "string",
"description": "User's place of worship, resolved to a canonical organization."
},
"employer": {
"type": "string",
"description": "User's employer, resolved to a canonical organization for SEG matching."
},
"home_zip": {
"type": "string",
"pattern": "^\\d{5}(?:-\\d{4})?$",
"description": "User's US 5-digit home ZIP or ZIP+4. Resolves to candidate counties; when home_state is supplied, the crosswalk must agree with it."
},
"work_zip": {
"type": "string",
"pattern": "^\\d{5}(?:-\\d{4})?$",
"description": "User's US 5-digit work ZIP or ZIP+4. Resolves to candidate work counties; when work_state is supplied, the crosswalk must agree with it."
},
"home_city": {
"type": "string",
"description": "User's Census-recognized home city. Requires home_state or a recognized home_zip that uniquely identifies one state; unresolved labels are rejected rather than guessed."
},
"work_city": {
"type": "string",
"description": "Census-recognized city where the user works. Requires work_state or a recognized work_zip that uniquely identifies one state."
},
"home_state": {
"type": "string",
"pattern": "^(?:[Aa][Ll]|[Aa][Kk]|[Aa][Zz]|[Aa][Rr]|[Cc][Aa]|[Cc][Oo]|[Cc][Tt]|[Dd][Ee]|[Dd][Cc]|[Ff][Ll]|[Gg][Aa]|[Hh][Ii]|[Ii][Dd]|[Ii][Ll]|[Ii][Nn]|[Ii][Aa]|[Kk][Ss]|[Kk][Yy]|[Ll][Aa]|[Mm][Ee]|[Mm][Dd]|[Mm][Aa]|[Mm][Ii]|[Mm][Nn]|[Mm][Ss]|[Mm][Oo]|[Mm][Tt]|[Nn][Ee]|[Nn][Vv]|[Nn][Hh]|[Nn][Jj]|[Nn][Mm]|[Nn][Yy]|[Nn][Cc]|[Nn][Dd]|[Oo][Hh]|[Oo][Kk]|[Oo][Rr]|[Pp][Aa]|[Rr][Ii]|[Ss][Cc]|[Ss][Dd]|[Tt][Nn]|[Tt][Xx]|[Uu][Tt]|[Vv][Tt]|[Vv][Aa]|[Ww][Aa]|[Ww][Vv]|[Ww][Ii]|[Ww][Yy])$",
"description": "User's valid 50-state/DC code (e.g., CA, TX, NY). Lowercase is accepted and normalized."
},
"occupation": {
"type": "string",
"description": "User's occupation, matched against trade, industry, and profession fields of membership."
},
"work_state": {
"type": "string",
"pattern": "^(?:[Aa][Ll]|[Aa][Kk]|[Aa][Zz]|[Aa][Rr]|[Cc][Aa]|[Cc][Oo]|[Cc][Tt]|[Dd][Ee]|[Dd][Cc]|[Ff][Ll]|[Gg][Aa]|[Hh][Ii]|[Ii][Dd]|[Ii][Ll]|[Ii][Nn]|[Ii][Aa]|[Kk][Ss]|[Kk][Yy]|[Ll][Aa]|[Mm][Ee]|[Mm][Dd]|[Mm][Aa]|[Mm][Ii]|[Mm][Nn]|[Mm][Ss]|[Mm][Oo]|[Mm][Tt]|[Nn][Ee]|[Nn][Vv]|[Nn][Hh]|[Nn][Jj]|[Nn][Mm]|[Nn][Yy]|[Nn][Cc]|[Nn][Dd]|[Oo][Hh]|[Oo][Kk]|[Oo][Rr]|[Pp][Aa]|[Rr][Ii]|[Ss][Cc]|[Ss][Dd]|[Tt][Nn]|[Tt][Xx]|[Uu][Tt]|[Vv][Tt]|[Vv][Aa]|[Ww][Aa]|[Ww][Vv]|[Ww][Ii]|[Ww][Yy])$",
"description": "Valid 50-state/DC code where the user works (e.g., CA, TX, NY). Lowercase is accepted and normalized."
},
"home_county": {
"type": "string",
"description": "User's county. Wins over the ZIP-derived counties when supplied."
},
"payroll_zip": {
"type": "string",
"pattern": "^\\d{5}(?:-\\d{4})?$",
"description": "ZIP from which the user's employer issues payroll; distinct from the worksite ZIP. When payroll_state is supplied, the ZIP must agree with it."
},
"work_county": {
"type": "string",
"description": "County where the user works. Wins over work-ZIP-derived counties when supplied."
},
"associations": {
"type": "array",
"items": {
"type": "string"
},
"maxItems": 20,
"description": "Associations, unions, or member organizations the user already belongs to."
},
"facility_zip": {
"type": "string",
"pattern": "^\\d{5}(?:-\\d{4})?$",
"description": "ZIP where the user's business maintains a location. Distinct from the worksite ZIP."
},
"payroll_city": {
"type": "string",
"description": "Census-recognized city from which payroll is issued. Requires payroll_state or a recognized payroll_zip that uniquely identifies one state."
},
"property_zip": {
"type": "string",
"pattern": "^\\d{5}(?:-\\d{4})?$",
"description": "ZIP where the user OWNS REAL PROPERTY. A door of its own — never inferred from where they live, and an absentee owner qualifies."
},
"facility_city": {
"type": "string",
"description": "Census-recognized city where the user's business maintains a location. Requires facility_state or a recognized facility_zip that uniquely identifies one state."
},
"payroll_state": {
"type": "string",
"pattern": "^(?:[Aa][Ll]|[Aa][Kk]|[Aa][Zz]|[Aa][Rr]|[Cc][Aa]|[Cc][Oo]|[Cc][Tt]|[Dd][Ee]|[Dd][Cc]|[Ff][Ll]|[Gg][Aa]|[Hh][Ii]|[Ii][Dd]|[Ii][Ll]|[Ii][Nn]|[Ii][Aa]|[Kk][Ss]|[Kk][Yy]|[Ll][Aa]|[Mm][Ee]|[Mm][Dd]|[Mm][Aa]|[Mm][Ii]|[Mm][Nn]|[Mm][Ss]|[Mm][Oo]|[Mm][Tt]|[Nn][Ee]|[Nn][Vv]|[Nn][Hh]|[Nn][Jj]|[Nn][Mm]|[Nn][Yy]|[Nn][Cc]|[Nn][Dd]|[Oo][Hh]|[Oo][Kk]|[Oo][Rr]|[Pp][Aa]|[Rr][Ii]|[Ss][Cc]|[Ss][Dd]|[Tt][Nn]|[Tt][Xx]|[Uu][Tt]|[Vv][Tt]|[Vv][Aa]|[Ww][Aa]|[Ww][Vv]|[Ww][Ii]|[Ww][Yy])$",
"description": "State from which the user's employer issues payroll; distinct from work_state."
},
"property_city": {
"type": "string",
"description": "Census-recognized city where the user owns real property. Requires property_state or a recognized property_zip that uniquely identifies one state."
},
"applicant_kind": {
"enum": [
"person",
"trust",
"organization",
"partnership",
"corporation",
"other_legal_entity"
],
"type": "string",
"description": "What the applicant IS. Some charters admit entities as well as people. Absent means a natural person; a person is never rejected by an entity-only door, only left unknown."
},
"facility_state": {
"type": "string",
"pattern": "^(?:[Aa][Ll]|[Aa][Kk]|[Aa][Zz]|[Aa][Rr]|[Cc][Aa]|[Cc][Oo]|[Cc][Tt]|[Dd][Ee]|[Dd][Cc]|[Ff][Ll]|[Gg][Aa]|[Hh][Ii]|[Ii][Dd]|[Ii][Ll]|[Ii][Nn]|[Ii][Aa]|[Kk][Ss]|[Kk][Yy]|[Ll][Aa]|[Mm][Ee]|[Mm][Dd]|[Mm][Aa]|[Mm][Ii]|[Mm][Nn]|[Mm][Ss]|[Mm][Oo]|[Mm][Tt]|[Nn][Ee]|[Nn][Vv]|[Nn][Hh]|[Nn][Jj]|[Nn][Mm]|[Nn][Yy]|[Nn][Cc]|[Nn][Dd]|[Oo][Hh]|[Oo][Kk]|[Oo][Rr]|[Pp][Aa]|[Rr][Ii]|[Ss][Cc]|[Ss][Dd]|[Tt][Nn]|[Tt][Xx]|[Uu][Tt]|[Vv][Tt]|[Vv][Aa]|[Ww][Aa]|[Ww][Vv]|[Ww][Ii]|[Ww][Yy])$",
"description": "State where the user's business maintains a location."
},
"payroll_county": {
"type": "string",
"description": "County from which the user's employer issues payroll; distinct from work_county."
},
"property_state": {
"type": "string",
"pattern": "^(?:[Aa][Ll]|[Aa][Kk]|[Aa][Zz]|[Aa][Rr]|[Cc][Aa]|[Cc][Oo]|[Cc][Tt]|[Dd][Ee]|[Dd][Cc]|[Ff][Ll]|[Gg][Aa]|[Hh][Ii]|[Ii][Dd]|[Ii][Ll]|[Ii][Nn]|[Ii][Aa]|[Kk][Ss]|[Kk][Yy]|[Ll][Aa]|[Mm][Ee]|[Mm][Dd]|[Mm][Aa]|[Mm][Ii]|[Mm][Nn]|[Mm][Ss]|[Mm][Oo]|[Mm][Tt]|[Nn][Ee]|[Nn][Vv]|[Nn][Hh]|[Nn][Jj]|[Nn][Mm]|[Nn][Yy]|[Nn][Cc]|[Nn][Dd]|[Oo][Hh]|[Oo][Kk]|[Oo][Rr]|[Pp][Aa]|[Rr][Ii]|[Ss][Cc]|[Ss][Dd]|[Tt][Nn]|[Tt][Xx]|[Uu][Tt]|[Vv][Tt]|[Vv][Aa]|[Ww][Aa]|[Ww][Vv]|[Ww][Ii]|[Ww][Yy])$",
"description": "State where the user owns real property. Distinct from home_state."
},
"school_org_ids": {
"type": "array",
"items": {
"type": "string",
"pattern": "^[a-z0-9]+(?:-[a-z0-9]+)*$",
"maxLength": 80,
"minLength": 1
},
"maxItems": 20,
"description": "Canonical school ids selected through resolve_eligibility_entities; never populate these from prose extraction.",
"uniqueItems": true
},
"facility_county": {
"type": "string",
"description": "County where the user's business maintains a location."
},
"family_relation": {
"type": "string",
"description": "How the user relates to a RELATIVE whose own affiliations may qualify them (e.g. 'spouse', 'child', 'immediate family'). Required alongside relative_employers/relative_schools/relative_associations — without it there is nobody for those organizations to belong to. Many SEG lists read 'Employees of the following companies AND THEIR IMMEDIATE FAMILIES are eligible'; this is how that door is answered."
},
"military_status": {
"enum": [
"active_duty",
"veteran",
"reservist",
"dod_civilian",
"military_family"
],
"type": "string",
"description": "User's military affiliation, matched against military fields of membership."
},
"property_county": {
"type": "string",
"description": "County where the user owns real property. Distinct from home_county."
},
"worship_org_ids": {
"type": "array",
"items": {
"type": "string",
"pattern": "^[a-z0-9]+(?:-[a-z0-9]+)*$",
"maxLength": 80,
"minLength": 1
},
"maxItems": 20,
"description": "Canonical worship-organization ids selected through resolve_eligibility_entities.",
"uniqueItems": true
},
"employer_org_ids": {
"type": "array",
"items": {
"type": "string",
"pattern": "^[a-z0-9]+(?:-[a-z0-9]+)*$",
"maxLength": 80,
"minLength": 1
},
"maxItems": 20,
"description": "Canonical employer ids selected through resolve_eligibility_entities. The API revalidates entity type and active-publication authority before use.",
"uniqueItems": true
},
"relative_schools": {
"type": "array",
"items": {
"type": "string"
},
"description": "Schools the RELATIVE named by family_relation attends. Optional; same unknown-by-default contract as relative_employers."
},
"relative_employers": {
"type": "array",
"items": {
"type": "string"
},
"description": "Employers of the RELATIVE named by family_relation (not the user's own employer). Optional; omitting it leaves compound family doors undecided (unknown), never negative."
},
"association_org_ids": {
"type": "array",
"items": {
"type": "string",
"pattern": "^[a-z0-9]+(?:-[a-z0-9]+)*$",
"maxLength": 80,
"minLength": 1
},
"maxItems": 20,
"description": "Canonical association ids selected through resolve_eligibility_entities; each is type- and publication-revalidated.",
"uniqueItems": true
},
"school_relationship": {
"enum": [
"student",
"alumni",
"employee"
],
"type": "string",
"description": "How the user relates to the school. Required with school to affirm a typed student, alumni, or school-employee path."
},
"relative_memberships": {
"type": "array",
"items": {
"type": "object",
"required": [
"credit_union_id",
"relation",
"status"
],
"properties": {
"status": {
"enum": [
"current_member",
"deceased_member"
],
"type": "string"
},
"relation": {
"type": "string",
"description": "The relative's relationship to the applicant."
},
"credit_union_id": {
"type": "string",
"description": "The exact target credit union id."
}
},
"additionalProperties": false
},
"maxItems": 50,
"description": "Confirmed relative memberships scoped to one exact credit union. A membership at one institution is never reused for another; omit unconfirmed memberships and the corresponding family door remains unknown."
},
"relative_associations": {
"type": "array",
"items": {
"type": "string"
},
"description": "Associations the RELATIVE named by family_relation belongs to. Optional; same unknown-by-default contract as relative_employers."
},
"military_service_state": {
"type": "string",
"pattern": "^(?:[Aa][Ll]|[Aa][Kk]|[Aa][Zz]|[Aa][Rr]|[Cc][Aa]|[Cc][Oo]|[Cc][Tt]|[Dd][Ee]|[Dd][Cc]|[Ff][Ll]|[Gg][Aa]|[Hh][Ii]|[Ii][Dd]|[Ii][Ll]|[Ii][Nn]|[Ii][Aa]|[Kk][Ss]|[Kk][Yy]|[Ll][Aa]|[Mm][Ee]|[Mm][Dd]|[Mm][Aa]|[Mm][Ii]|[Mm][Nn]|[Mm][Ss]|[Mm][Oo]|[Mm][Tt]|[Nn][Ee]|[Nn][Vv]|[Nn][Hh]|[Nn][Jj]|[Nn][Mm]|[Nn][Yy]|[Nn][Cc]|[Nn][Dd]|[Oo][Hh]|[Oo][Kk]|[Oo][Rr]|[Pp][Aa]|[Rr][Ii]|[Ss][Cc]|[Ss][Dd]|[Tt][Nn]|[Tt][Xx]|[Uu][Tt]|[Vv][Tt]|[Vv][Aa]|[Ww][Aa]|[Ww][Vv]|[Ww][Ii]|[Ww][Yy])$",
"description": "The state the user serves, or served, in. State National Guard doors (\"Oklahoma National Guard\") need this; without it such a door reads unknown."
},
"asserted_org_qualifiers": {
"type": "array",
"items": {
"type": "string"
},
"maxItems": 20,
"description": "Narrowings the user asserts about themselves, quoted back from a missing_facts question (e.g. \"assigned as Recruiters or ROTC Instructors within the State of Arkansas\"). Absence caps a narrowed door rather than closing it."
},
"relative_school_org_ids": {
"type": "array",
"items": {
"type": "string",
"pattern": "^[a-z0-9]+(?:-[a-z0-9]+)*$",
"maxLength": 80,
"minLength": 1
},
"maxItems": 20,
"description": "Canonical school ids for the relative named by family_relation, never for the applicant.",
"uniqueItems": true
},
"relative_employer_org_ids": {
"type": "array",
"items": {
"type": "string",
"pattern": "^[a-z0-9]+(?:-[a-z0-9]+)*$",
"maxLength": 80,
"minLength": 1
},
"maxItems": 20,
"description": "Canonical employer ids for the relative named by family_relation, never for the applicant.",
"uniqueItems": true
},
"willing_to_join_association": {
"type": "boolean",
"description": "Set true to search documented joinable-association paths (valid as the sole discriminator). Set false only to suppress paths that require joining an association; false alone is not a discriminating search fact."
},
"relative_association_org_ids": {
"type": "array",
"items": {
"type": "string",
"pattern": "^[a-z0-9]+(?:-[a-z0-9]+)*$",
"maxLength": 80,
"minLength": 1
},
"maxItems": 20,
"description": "Canonical association ids for the relative named by family_relation, never for the applicant.",
"uniqueItems": true
}
}
}{
"type": "object",
"required": [
"person",
"product"
],
"properties": {
"limit": {
"type": "number",
"description": "Visible offers per bucket, 1-50. Candidate intersection happens before this cap."
},
"person": {
"type": "object",
"properties": {
"school": {
"type": "string",
"description": "User's school/college/university, resolved to a canonical organization. Supply school_relationship too; a name alone is not a positive match."
},
"worship": {
"type": "string",
"description": "User's place of worship, resolved to a canonical organization."
},
"employer": {
"type": "string",
"description": "User's employer, resolved to a canonical organization for SEG matching."
},
"home_zip": {
"type": "string",
"pattern": "^\\d{5}(?:-\\d{4})?$",
"description": "User's US 5-digit home ZIP or ZIP+4. Resolves to candidate counties; when home_state is supplied, the crosswalk must agree with it."
},
"work_zip": {
"type": "string",
"pattern": "^\\d{5}(?:-\\d{4})?$",
"description": "User's US 5-digit work ZIP or ZIP+4. Resolves to candidate work counties; when work_state is supplied, the crosswalk must agree with it."
},
"home_city": {
"type": "string",
"description": "User's Census-recognized home city. Requires home_state or a recognized home_zip that uniquely identifies one state; unresolved labels are rejected rather than guessed."
},
"work_city": {
"type": "string",
"description": "Census-recognized city where the user works. Requires work_state or a recognized work_zip that uniquely identifies one state."
},
"home_state": {
"type": "string",
"pattern": "^(?:[Aa][Ll]|[Aa][Kk]|[Aa][Zz]|[Aa][Rr]|[Cc][Aa]|[Cc][Oo]|[Cc][Tt]|[Dd][Ee]|[Dd][Cc]|[Ff][Ll]|[Gg][Aa]|[Hh][Ii]|[Ii][Dd]|[Ii][Ll]|[Ii][Nn]|[Ii][Aa]|[Kk][Ss]|[Kk][Yy]|[Ll][Aa]|[Mm][Ee]|[Mm][Dd]|[Mm][Aa]|[Mm][Ii]|[Mm][Nn]|[Mm][Ss]|[Mm][Oo]|[Mm][Tt]|[Nn][Ee]|[Nn][Vv]|[Nn][Hh]|[Nn][Jj]|[Nn][Mm]|[Nn][Yy]|[Nn][Cc]|[Nn][Dd]|[Oo][Hh]|[Oo][Kk]|[Oo][Rr]|[Pp][Aa]|[Rr][Ii]|[Ss][Cc]|[Ss][Dd]|[Tt][Nn]|[Tt][Xx]|[Uu][Tt]|[Vv][Tt]|[Vv][Aa]|[Ww][Aa]|[Ww][Vv]|[Ww][Ii]|[Ww][Yy])$",
"description": "User's valid 50-state/DC code (e.g., CA, TX, NY). Lowercase is accepted and normalized."
},
"occupation": {
"type": "string",
"description": "User's occupation, matched against trade, industry, and profession fields of membership."
},
"work_state": {
"type": "string",
"pattern": "^(?:[Aa][Ll]|[Aa][Kk]|[Aa][Zz]|[Aa][Rr]|[Cc][Aa]|[Cc][Oo]|[Cc][Tt]|[Dd][Ee]|[Dd][Cc]|[Ff][Ll]|[Gg][Aa]|[Hh][Ii]|[Ii][Dd]|[Ii][Ll]|[Ii][Nn]|[Ii][Aa]|[Kk][Ss]|[Kk][Yy]|[Ll][Aa]|[Mm][Ee]|[Mm][Dd]|[Mm][Aa]|[Mm][Ii]|[Mm][Nn]|[Mm][Ss]|[Mm][Oo]|[Mm][Tt]|[Nn][Ee]|[Nn][Vv]|[Nn][Hh]|[Nn][Jj]|[Nn][Mm]|[Nn][Yy]|[Nn][Cc]|[Nn][Dd]|[Oo][Hh]|[Oo][Kk]|[Oo][Rr]|[Pp][Aa]|[Rr][Ii]|[Ss][Cc]|[Ss][Dd]|[Tt][Nn]|[Tt][Xx]|[Uu][Tt]|[Vv][Tt]|[Vv][Aa]|[Ww][Aa]|[Ww][Vv]|[Ww][Ii]|[Ww][Yy])$",
"description": "Valid 50-state/DC code where the user works (e.g., CA, TX, NY). Lowercase is accepted and normalized."
},
"home_county": {
"type": "string",
"description": "User's county. Wins over the ZIP-derived counties when supplied."
},
"payroll_zip": {
"type": "string",
"pattern": "^\\d{5}(?:-\\d{4})?$",
"description": "ZIP from which the user's employer issues payroll; distinct from the worksite ZIP. When payroll_state is supplied, the ZIP must agree with it."
},
"work_county": {
"type": "string",
"description": "County where the user works. Wins over work-ZIP-derived counties when supplied."
},
"associations": {
"type": "array",
"items": {
"type": "string"
},
"maxItems": 20,
"description": "Associations, unions, or member organizations the user already belongs to."
},
"facility_zip": {
"type": "string",
"pattern": "^\\d{5}(?:-\\d{4})?$",
"description": "ZIP where the user's business maintains a location. Distinct from the worksite ZIP."
},
"payroll_city": {
"type": "string",
"description": "Census-recognized city from which payroll is issued. Requires payroll_state or a recognized payroll_zip that uniquely identifies one state."
},
"property_zip": {
"type": "string",
"pattern": "^\\d{5}(?:-\\d{4})?$",
"description": "ZIP where the user OWNS REAL PROPERTY. A door of its own — never inferred from where they live, and an absentee owner qualifies."
},
"facility_city": {
"type": "string",
"description": "Census-recognized city where the user's business maintains a location. Requires facility_state or a recognized facility_zip that uniquely identifies one state."
},
"payroll_state": {
"type": "string",
"pattern": "^(?:[Aa][Ll]|[Aa][Kk]|[Aa][Zz]|[Aa][Rr]|[Cc][Aa]|[Cc][Oo]|[Cc][Tt]|[Dd][Ee]|[Dd][Cc]|[Ff][Ll]|[Gg][Aa]|[Hh][Ii]|[Ii][Dd]|[Ii][Ll]|[Ii][Nn]|[Ii][Aa]|[Kk][Ss]|[Kk][Yy]|[Ll][Aa]|[Mm][Ee]|[Mm][Dd]|[Mm][Aa]|[Mm][Ii]|[Mm][Nn]|[Mm][Ss]|[Mm][Oo]|[Mm][Tt]|[Nn][Ee]|[Nn][Vv]|[Nn][Hh]|[Nn][Jj]|[Nn][Mm]|[Nn][Yy]|[Nn][Cc]|[Nn][Dd]|[Oo][Hh]|[Oo][Kk]|[Oo][Rr]|[Pp][Aa]|[Rr][Ii]|[Ss][Cc]|[Ss][Dd]|[Tt][Nn]|[Tt][Xx]|[Uu][Tt]|[Vv][Tt]|[Vv][Aa]|[Ww][Aa]|[Ww][Vv]|[Ww][Ii]|[Ww][Yy])$",
"description": "State from which the user's employer issues payroll; distinct from work_state."
},
"property_city": {
"type": "string",
"description": "Census-recognized city where the user owns real property. Requires property_state or a recognized property_zip that uniquely identifies one state."
},
"applicant_kind": {
"enum": [
"person",
"trust",
"organization",
"partnership",
"corporation",
"other_legal_entity"
],
"type": "string",
"description": "What the applicant IS. Some charters admit entities as well as people. Absent means a natural person; a person is never rejected by an entity-only door, only left unknown."
},
"facility_state": {
"type": "string",
"pattern": "^(?:[Aa][Ll]|[Aa][Kk]|[Aa][Zz]|[Aa][Rr]|[Cc][Aa]|[Cc][Oo]|[Cc][Tt]|[Dd][Ee]|[Dd][Cc]|[Ff][Ll]|[Gg][Aa]|[Hh][Ii]|[Ii][Dd]|[Ii][Ll]|[Ii][Nn]|[Ii][Aa]|[Kk][Ss]|[Kk][Yy]|[Ll][Aa]|[Mm][Ee]|[Mm][Dd]|[Mm][Aa]|[Mm][Ii]|[Mm][Nn]|[Mm][Ss]|[Mm][Oo]|[Mm][Tt]|[Nn][Ee]|[Nn][Vv]|[Nn][Hh]|[Nn][Jj]|[Nn][Mm]|[Nn][Yy]|[Nn][Cc]|[Nn][Dd]|[Oo][Hh]|[Oo][Kk]|[Oo][Rr]|[Pp][Aa]|[Rr][Ii]|[Ss][Cc]|[Ss][Dd]|[Tt][Nn]|[Tt][Xx]|[Uu][Tt]|[Vv][Tt]|[Vv][Aa]|[Ww][Aa]|[Ww][Vv]|[Ww][Ii]|[Ww][Yy])$",
"description": "State where the user's business maintains a location."
},
"payroll_county": {
"type": "string",
"description": "County from which the user's employer issues payroll; distinct from work_county."
},
"property_state": {
"type": "string",
"pattern": "^(?:[Aa][Ll]|[Aa][Kk]|[Aa][Zz]|[Aa][Rr]|[Cc][Aa]|[Cc][Oo]|[Cc][Tt]|[Dd][Ee]|[Dd][Cc]|[Ff][Ll]|[Gg][Aa]|[Hh][Ii]|[Ii][Dd]|[Ii][Ll]|[Ii][Nn]|[Ii][Aa]|[Kk][Ss]|[Kk][Yy]|[Ll][Aa]|[Mm][Ee]|[Mm][Dd]|[Mm][Aa]|[Mm][Ii]|[Mm][Nn]|[Mm][Ss]|[Mm][Oo]|[Mm][Tt]|[Nn][Ee]|[Nn][Vv]|[Nn][Hh]|[Nn][Jj]|[Nn][Mm]|[Nn][Yy]|[Nn][Cc]|[Nn][Dd]|[Oo][Hh]|[Oo][Kk]|[Oo][Rr]|[Pp][Aa]|[Rr][Ii]|[Ss][Cc]|[Ss][Dd]|[Tt][Nn]|[Tt][Xx]|[Uu][Tt]|[Vv][Tt]|[Vv][Aa]|[Ww][Aa]|[Ww][Vv]|[Ww][Ii]|[Ww][Yy])$",
"description": "State where the user owns real property. Distinct from home_state."
},
"school_org_ids": {
"type": "array",
"items": {
"type": "string",
"pattern": "^[a-z0-9]+(?:-[a-z0-9]+)*$",
"maxLength": 80,
"minLength": 1
},
"maxItems": 20,
"description": "Canonical school ids selected through resolve_eligibility_entities; never populate these from prose extraction.",
"uniqueItems": true
},
"facility_county": {
"type": "string",
"description": "County where the user's business maintains a location."
},
"family_relation": {
"type": "string",
"description": "How the user relates to a RELATIVE whose own affiliations may qualify them (e.g. 'spouse', 'child', 'immediate family'). Required alongside relative_employers/relative_schools/relative_associations — without it there is nobody for those organizations to belong to. Many SEG lists read 'Employees of the following companies AND THEIR IMMEDIATE FAMILIES are eligible'; this is how that door is answered."
},
"military_status": {
"enum": [
"active_duty",
"veteran",
"reservist",
"dod_civilian",
"military_family"
],
"type": "string",
"description": "User's military affiliation, matched against military fields of membership."
},
"property_county": {
"type": "string",
"description": "County where the user owns real property. Distinct from home_county."
},
"worship_org_ids": {
"type": "array",
"items": {
"type": "string",
"pattern": "^[a-z0-9]+(?:-[a-z0-9]+)*$",
"maxLength": 80,
"minLength": 1
},
"maxItems": 20,
"description": "Canonical worship-organization ids selected through resolve_eligibility_entities.",
"uniqueItems": true
},
"employer_org_ids": {
"type": "array",
"items": {
"type": "string",
"pattern": "^[a-z0-9]+(?:-[a-z0-9]+)*$",
"maxLength": 80,
"minLength": 1
},
"maxItems": 20,
"description": "Canonical employer ids selected through resolve_eligibility_entities. The API revalidates entity type and active-publication authority before use.",
"uniqueItems": true
},
"relative_schools": {
"type": "array",
"items": {
"type": "string"
},
"description": "Schools the RELATIVE named by family_relation attends. Optional; same unknown-by-default contract as relative_employers."
},
"relative_employers": {
"type": "array",
"items": {
"type": "string"
},
"description": "Employers of the RELATIVE named by family_relation (not the user's own employer). Optional; omitting it leaves compound family doors undecided (unknown), never negative."
},
"association_org_ids": {
"type": "array",
"items": {
"type": "string",
"pattern": "^[a-z0-9]+(?:-[a-z0-9]+)*$",
"maxLength": 80,
"minLength": 1
},
"maxItems": 20,
"description": "Canonical association ids selected through resolve_eligibility_entities; each is type- and publication-revalidated.",
"uniqueItems": true
},
"school_relationship": {
"enum": [
"student",
"alumni",
"employee"
],
"type": "string",
"description": "How the user relates to the school. Required with school to affirm a typed student, alumni, or school-employee path."
},
"relative_memberships": {
"type": "array",
"items": {
"type": "object",
"required": [
"credit_union_id",
"relation",
"status"
],
"properties": {
"status": {
"enum": [
"current_member",
"deceased_member"
],
"type": "string"
},
"relation": {
"type": "string",
"description": "The relative's relationship to the applicant."
},
"credit_union_id": {
"type": "string",
"description": "The exact target credit union id."
}
},
"additionalProperties": false
},
"maxItems": 50,
"description": "Confirmed relative memberships scoped to one exact credit union. A membership at one institution is never reused for another; omit unconfirmed memberships and the corresponding family door remains unknown."
},
"relative_associations": {
"type": "array",
"items": {
"type": "string"
},
"description": "Associations the RELATIVE named by family_relation belongs to. Optional; same unknown-by-default contract as relative_employers."
},
"military_service_state": {
"type": "string",
"pattern": "^(?:[Aa][Ll]|[Aa][Kk]|[Aa][Zz]|[Aa][Rr]|[Cc][Aa]|[Cc][Oo]|[Cc][Tt]|[Dd][Ee]|[Dd][Cc]|[Ff][Ll]|[Gg][Aa]|[Hh][Ii]|[Ii][Dd]|[Ii][Ll]|[Ii][Nn]|[Ii][Aa]|[Kk][Ss]|[Kk][Yy]|[Ll][Aa]|[Mm][Ee]|[Mm][Dd]|[Mm][Aa]|[Mm][Ii]|[Mm][Nn]|[Mm][Ss]|[Mm][Oo]|[Mm][Tt]|[Nn][Ee]|[Nn][Vv]|[Nn][Hh]|[Nn][Jj]|[Nn][Mm]|[Nn][Yy]|[Nn][Cc]|[Nn][Dd]|[Oo][Hh]|[Oo][Kk]|[Oo][Rr]|[Pp][Aa]|[Rr][Ii]|[Ss][Cc]|[Ss][Dd]|[Tt][Nn]|[Tt][Xx]|[Uu][Tt]|[Vv][Tt]|[Vv][Aa]|[Ww][Aa]|[Ww][Vv]|[Ww][Ii]|[Ww][Yy])$",
"description": "The state the user serves, or served, in. State National Guard doors (\"Oklahoma National Guard\") need this; without it such a door reads unknown."
},
"asserted_org_qualifiers": {
"type": "array",
"items": {
"type": "string"
},
"maxItems": 20,
"description": "Narrowings the user asserts about themselves, quoted back from a missing_facts question (e.g. \"assigned as Recruiters or ROTC Instructors within the State of Arkansas\"). Absence caps a narrowed door rather than closing it."
},
"relative_school_org_ids": {
"type": "array",
"items": {
"type": "string",
"pattern": "^[a-z0-9]+(?:-[a-z0-9]+)*$",
"maxLength": 80,
"minLength": 1
},
"maxItems": 20,
"description": "Canonical school ids for the relative named by family_relation, never for the applicant.",
"uniqueItems": true
},
"relative_employer_org_ids": {
"type": "array",
"items": {
"type": "string",
"pattern": "^[a-z0-9]+(?:-[a-z0-9]+)*$",
"maxLength": 80,
"minLength": 1
},
"maxItems": 20,
"description": "Canonical employer ids for the relative named by family_relation, never for the applicant.",
"uniqueItems": true
},
"willing_to_join_association": {
"type": "boolean",
"description": "Set true to search documented joinable-association paths (valid as the sole discriminator). Set false only to suppress paths that require joining an association; false alone is not a discriminating search fact."
},
"relative_association_org_ids": {
"type": "array",
"items": {
"type": "string",
"pattern": "^[a-z0-9]+(?:-[a-z0-9]+)*$",
"maxLength": 80,
"minLength": 1
},
"maxItems": 20,
"description": "Canonical association ids for the relative named by family_relation, never for the applicant.",
"uniqueItems": true
}
},
"description": "Confirmed person facts accepted by find_eligible_credit_unions, including canonical *_org_ids selected through resolve_eligibility_entities. Unknown facts stay absent and canonical ids are revalidated by rates-api.",
"additionalProperties": false
},
"product": {
"type": "object",
"required": [
"product_type"
],
"properties": {
"amount": {
"type": "number",
"description": "Loan or credit amount in USD."
},
"intent": {
"enum": [
"purchase",
"refinance",
"cash_out",
"balance_transfer",
"new_credit"
],
"type": "string",
"description": "Transaction intent when it changes product matching."
},
"balance": {
"type": "number",
"description": "Deposit balance in USD."
},
"audience": {
"enum": [
"business",
"consumer"
],
"type": "string",
"description": "Business or consumer product audience."
},
"occupancy": {
"enum": [
"primary",
"secondary",
"investment"
],
"type": "string",
"description": "Property occupancy for mortgage matching."
},
"term_months": {
"type": "number",
"description": "Requested term in months."
},
"product_type": {
"enum": [
"mortgage",
"mortgage_arm",
"auto_loan",
"rv",
"boat",
"motorcycle",
"powersports",
"heloc",
"personal_loan",
"student_loan",
"equipment_loan",
"credit_card",
"savings",
"cd",
"share_certificate",
"money_market",
"ira_cd",
"ira",
"share_savings"
],
"type": "string",
"description": "Canonical product family."
},
"vehicle_condition": {
"enum": [
"new",
"used",
"certified_pre_owned",
"any"
],
"type": "string",
"description": "Vehicle condition for auto-loan matching."
}
},
"description": "The financial product and matching attributes to route."
}
}
}| intent* | string | The loan intent. For mortgages, use "purchase" or "refinance". For auto loans, use "purchase" (new/used car) or "refinance" (existing auto loan). Required. |
| school | string | User's school/college/university. Supply school_relationship too; a school name alone does not affirm a typed eligibility path. |
| worship | string | User's place of worship, used to annotate offers with worship-org-affinity eligibility. |
| employer | string | User's employer, matched against credit union employer/SEG membership lists for eligibility. |
| no_points | boolean | If true, prefer no-points loans only. Applies to mortgages. |
| current_apr | number | Current offer APR if refinancing (percentage). |
| term_months | number | Loan term in months (12-480). Defaults to 360 (30-year) for mortgages, 60 (5-year) for auto loans. Common auto loan terms: 36, 48, 60, 72, 84 months. Common mortgage terms: 180 (15-year), 360 (30-year). |
| credit_score | number | Borrower's credit score (300-850). Highly recommended for accurate rate matching. |
| current_rate | number | Current offer rate if refinancing (percentage, e.g., 6.5 for 6.5%). |
| product_type | string | Type of financing product: "mortgage" (FIXED-rate home purchase/refinance), "mortgage_arm" (ADJUSTABLE-rate mortgage), "auto_loan" (vehicle financing), "heloc" (home equity line of credit), "personal_loan" (general purpose loans), "credit_card" (credit card offers), "student_loan" (student/education loans, incl. refinance and graduate loans), "equipment_loan" (farm/heavy equipment and tractor financing). Defaults to "mortgage". Pick "mortgage_arm" whenever the user says ARM, adjustable, or names a slash pair ("5/1", "5/5", "7/1", "10/1") — fixed and adjustable are ranked as SEPARATE markets, because an ARM intro rate sits structurally below a comparable fixed rate and a blended list would put every ARM on top and call it cheaper, which is true only until it resets. Within "mortgage", term_months selects 15- vs 30-year; it has no meaning for "mortgage_arm". |
| vehicle_type | string | AUTO LOANS ONLY: Type of vehicle being financed. Some lenders offer specialized rates by vehicle type. |
| vehicle_year | number | AUTO LOANS ONLY: Model year of the vehicle (e.g., 2024, 2020). Used to determine age-based rate tiers. |
| eligible_only | boolean | BETA (annotation-only): eligible_only is in beta pending identity-verification thresholds; offers are annotated, not filtered. Setting true adds an eligible_only_status notice to the response — eligibility annotates and re-ranks, but no offers are dropped. When an annotation comes back unknown, that is not a no: call find_eligible_credit_unions or check_membership_eligibility and read `missing_facts` — ask those questions before concluding no offers exist. eligible_only is beta. |
| max_providers | number | Maximum number of providers to return (1-5). Defaults to 5. |
| military_status | string | User's military affiliation. Annotates offers with eligible_via_military where the credit union has a military field of membership. |
| vehicle_condition | string | AUTO LOANS ONLY: Condition of the vehicle being purchased or refinanced. Affects rate eligibility. |
| school_relationship | string | How the user relates to the named school. Required with school to affirm a typed student, alumni, or school-employee path. |
| include_out_of_state | boolean | Optional: Include documented out-of-state open or multi-state credit-union candidates. Defaults to false, which preserves the requested-state candidate set. |
| include_institution_context | boolean | Optional: Include compact NCUA quarterly facts on each final offer (members, locations, assets, year opened, and selected relationship services). |
{
"type": "object",
"required": [
"state",
"intent",
"amount"
],
"properties": {
"zip": {
"type": "string",
"pattern": "^\\d{5}(?:-\\d{4})?$",
"description": "User's US 5-digit ZIP or ZIP+4. Resolves to a county server-side for membership-eligibility matching; its crosswalk state must agree with state."
},
"state": {
"type": "string",
"pattern": "^(?:[Aa][Ll]|[Aa][Kk]|[Aa][Zz]|[Aa][Rr]|[Cc][Aa]|[Cc][Oo]|[Cc][Tt]|[Dd][Ee]|[Dd][Cc]|[Ff][Ll]|[Gg][Aa]|[Hh][Ii]|[Ii][Dd]|[Ii][Ll]|[Ii][Nn]|[Ii][Aa]|[Kk][Ss]|[Kk][Yy]|[Ll][Aa]|[Mm][Ee]|[Mm][Dd]|[Mm][Aa]|[Mm][Ii]|[Mm][Nn]|[Mm][Ss]|[Mm][Oo]|[Mm][Tt]|[Nn][Ee]|[Nn][Vv]|[Nn][Hh]|[Nn][Jj]|[Nn][Mm]|[Nn][Yy]|[Nn][Cc]|[Nn][Dd]|[Oo][Hh]|[Oo][Kk]|[Oo][Rr]|[Pp][Aa]|[Rr][Ii]|[Ss][Cc]|[Ss][Dd]|[Tt][Nn]|[Tt][Xx]|[Uu][Tt]|[Vv][Tt]|[Vv][Aa]|[Ww][Aa]|[Ww][Vv]|[Ww][Ii]|[Ww][Yy])$",
"description": "Valid 50-state/DC code (2-letter, e.g., CA, TX, NY). Required; lowercase is accepted and normalized."
},
"amount": {
"type": "number",
"description": "Loan amount in dollars (minimum 1000). Required."
},
"county": {
"type": "string",
"description": "User's county for membership-eligibility matching (credit union field-of-membership). Helps flag which lenders the user can actually join."
},
"intent": {
"enum": [
"purchase",
"refinance",
"cash_out",
"balance_transfer",
"new_credit"
],
"type": "string",
"description": "The loan intent. For mortgages, use \"purchase\" or \"refinance\". For auto loans, use \"purchase\" (new/used car) or \"refinance\" (existing auto loan). Required."
},
"school": {
"type": "string",
"description": "User's school/college/university. Supply school_relationship too; a school name alone does not affirm a typed eligibility path."
},
"worship": {
"type": "string",
"description": "User's place of worship, used to annotate offers with worship-org-affinity eligibility."
},
"employer": {
"type": "string",
"description": "User's employer, matched against credit union employer/SEG membership lists for eligibility."
},
"no_points": {
"type": "boolean",
"description": "If true, prefer no-points loans only. Applies to mortgages."
},
"current_apr": {
"type": "number",
"description": "Current offer APR if refinancing (percentage)."
},
"term_months": {
"type": "number",
"description": "Loan term in months (12-480). Defaults to 360 (30-year) for mortgages, 60 (5-year) for auto loans. Common auto loan terms: 36, 48, 60, 72, 84 months. Common mortgage terms: 180 (15-year), 360 (30-year)."
},
"credit_score": {
"type": "number",
"description": "Borrower's credit score (300-850). Highly recommended for accurate rate matching."
},
"current_rate": {
"type": "number",
"description": "Current offer rate if refinancing (percentage, e.g., 6.5 for 6.5%)."
},
"product_type": {
"enum": [
"mortgage",
"mortgage_arm",
"auto_loan",
"rv",
"boat",
"motorcycle",
"powersports",
"personal_loan",
"heloc",
"credit_card",
"student_loan",
"equipment_loan"
],
"type": "string",
"description": "Type of financing product: \"mortgage\" (FIXED-rate home purchase/refinance), \"mortgage_arm\" (ADJUSTABLE-rate mortgage), \"auto_loan\" (vehicle financing), \"heloc\" (home equity line of credit), \"personal_loan\" (general purpose loans), \"credit_card\" (credit card offers), \"student_loan\" (student/education loans, incl. refinance and graduate loans), \"equipment_loan\" (farm/heavy equipment and tractor financing). Defaults to \"mortgage\". Pick \"mortgage_arm\" whenever the user says ARM, adjustable, or names a slash pair (\"5/1\", \"5/5\", \"7/1\", \"10/1\") — fixed and adjustable are ranked as SEPARATE markets, because an ARM intro rate sits structurally below a comparable fixed rate and a blended list would put every ARM on top and call it cheaper, which is true only until it resets. Within \"mortgage\", term_months selects 15- vs 30-year; it has no meaning for \"mortgage_arm\"."
},
"vehicle_type": {
"enum": [
"car",
"truck",
"suv",
"motorcycle",
"rv",
"boat"
],
"type": "string",
"description": "AUTO LOANS ONLY: Type of vehicle being financed. Some lenders offer specialized rates by vehicle type."
},
"vehicle_year": {
"type": "number",
"description": "AUTO LOANS ONLY: Model year of the vehicle (e.g., 2024, 2020). Used to determine age-based rate tiers."
},
"eligible_only": {
"type": "boolean",
"description": "BETA (annotation-only): eligible_only is in beta pending identity-verification thresholds; offers are annotated, not filtered. Setting true adds an eligible_only_status notice to the response — eligibility annotates and re-ranks, but no offers are dropped. When an annotation comes back unknown, that is not a no: call find_eligible_credit_unions or check_membership_eligibility and read `missing_facts` — ask those questions before concluding no offers exist. eligible_only is beta."
},
"max_providers": {
"type": "number",
"description": "Maximum number of providers to return (1-5). Defaults to 5."
},
"military_status": {
"enum": [
"active_duty",
"veteran",
"reservist",
"dod_civilian",
"military_family"
],
"type": "string",
"description": "User's military affiliation. Annotates offers with eligible_via_military where the credit union has a military field of membership."
},
"vehicle_condition": {
"enum": [
"new",
"used",
"certified_pre_owned",
"any"
],
"type": "string",
"description": "AUTO LOANS ONLY: Condition of the vehicle being purchased or refinanced. Affects rate eligibility."
},
"school_relationship": {
"enum": [
"student",
"alumni",
"employee"
],
"type": "string",
"description": "How the user relates to the named school. Required with school to affirm a typed student, alumni, or school-employee path."
},
"include_out_of_state": {
"type": "boolean",
"description": "Optional: Include documented out-of-state open or multi-state credit-union candidates. Defaults to false, which preserves the requested-state candidate set."
},
"include_institution_context": {
"type": "boolean",
"description": "Optional: Include compact NCUA quarterly facts on each final offer (members, locations, assets, year opened, and selected relationship services)."
}
}
}| loan_program |
| string |
| product_type | string |
{
"type": "object",
"properties": {
"sort": {
"enum": [
"apr_asc",
"apr_desc",
"rate_asc",
"rate_desc",
"updated_desc"
],
"type": "string",
"description": "Default apr_asc"
},
"limit": {
"type": "number",
"description": "1-500, default 50"
},
"state": {
"type": "string",
"description": "2-letter US state code; omit for all states"
},
"lender": {
"type": "string",
"description": "Filter by credit-union name (substring, case-insensitive)"
},
"offset": {
"type": "number",
"description": "Pagination offset, default 0"
},
"max_apr": {
"type": "number"
},
"min_apr": {
"type": "number"
},
"audience": {
"enum": [
"business",
"consumer"
],
"type": "string",
"description": "WHO the product is for, orthogonal to product type: 'business' returns business-audience products across every category (DSCR mortgages, business deposits, SBA loans); 'consumer' excludes them."
},
"term_months": {
"type": "number"
},
"loan_program": {
"type": "string"
},
"product_type": {
"enum": [
"mortgage",
"auto_loan",
"rv",
"boat",
"motorcycle",
"powersports",
"heloc",
"personal_loan",
"credit_card",
"student_loan",
"equipment_loan"
],
"type": "string"
}
}
}| Cash down, dollars. Default 0. |
| extra_monthly_payment | number | Optional extra principal/month to model faster cancel. Default 0. |
{
"type": "object",
"required": [],
"properties": {
"rate": {
"type": "number",
"description": "Annual rate %, e.g. 6.5. Omit -> best market rate for state."
},
"state": {
"type": "string",
"description": "2-letter code for market-rate lookup. Default CA."
},
"pmi_rate": {
"type": "number",
"description": "Annual PMI as % of loan balance. Default 0.5."
},
"home_price": {
"type": "number",
"description": "Purchase/appraised price. Required unless loan_amount given."
},
"loan_amount": {
"type": "number",
"description": "Optional explicit loan; overrides home_price - down_payment."
},
"term_months": {
"type": "number",
"description": "Loan term in months. Default 360."
},
"credit_score": {
"type": "number",
"description": "Optional, for market-rate lookup."
},
"down_payment": {
"type": "number",
"description": "Cash down, dollars. Default 0."
},
"extra_monthly_payment": {
"type": "number",
"description": "Optional extra principal/month to model faster cancel. Default 0."
}
}
}| zip | string | Borrower ZIP code. Optional; sharpens membership eligibility and enables include_nearby_offers. |
| fees | number | Quoted fees in dollars. Optional, used only for the note. |
| rate* | number | The quoted interest rate as a percentage (e.g., 4.25). Required. |
| state* | string | US state code (2-letter, e.g., CA, TX). Required. |
| amount | number | Loan amount in dollars. Optional — also sharpens better-offer payment math. |
| max_offers | number | How many better offers to return (1-5, default 3). Only applies with include_better_offers. |
| term_months | number | Loan term in months. For MORTGAGES this selects which market the quote is scored against: pass 180 for a 15-year and 360 for a 30-year. 15-year rates run structurally lower, so omitting it on a 15-year quote compares it to 30-year offers and makes an ordinary rate look market-leading. Defaults to 30-year. Also sharpens better-offer payment math for every product. |
| credit_score | number | Borrower's credit score (300-850). Optional; improves better-offer matching. |
| product_type* | string | Type of financing product the quote is for. Pick `mortgage_arm` — NOT `mortgage` — whenever the user names an adjustable-rate mortgage: "ARM", "adjustable", or a slash pair like "5/1", "5/5", "7/1", "10/1". ARM intro rates run structurally BELOW fixed rates, so scoring an ARM against the fixed market makes an ordinary quote look market-leading, which is the exact error this tool exists to prevent. All initial fixed periods share one ARM market. Use `mortgage` for fixed-rate mortgages and set term_months to pick 15- vs 30-year. |
| include_better_offers | boolean | Set TRUE for negotiation questions. Adds `better_offers`: named lenders currently beating the quote, each with the APR gap in basis points, estimated monthly savings, and `can_you_join` (yes / likely / unknown) so you only cite alternatives the borrower can realistically obtain. This is what turns a percentile into something the user can act on — prefer it whenever the user asks whether their rate is fair or what to do about it. |
| include_nearby_offers | boolean | Set true with zip to return product-matched rates from credit unions ranked by the closest NCUA-reported branch. Results include approximate straight-line miles, branch details, and the basis-point difference versus the quote. |
{
"type": "object",
"required": [
"product_type",
"state",
"rate"
],
"properties": {
"apr": {
"type": "number",
"description": "The quoted APR as a percentage. Optional — falls back to rate if omitted."
},
"zip": {
"type": "string",
"pattern": "^[0-9]{5}$",
"description": "Borrower ZIP code. Optional; sharpens membership eligibility and enables include_nearby_offers."
},
"fees": {
"type": "number",
"description": "Quoted fees in dollars. Optional, used only for the note."
},
"rate": {
"type": "number",
"description": "The quoted interest rate as a percentage (e.g., 4.25). Required."
},
"state": {
"type": "string",
"description": "US state code (2-letter, e.g., CA, TX). Required."
},
"amount": {
"type": "number",
"description": "Loan amount in dollars. Optional — also sharpens better-offer payment math."
},
"max_offers": {
"type": "number",
"description": "How many better offers to return (1-5, default 3). Only applies with include_better_offers."
},
"term_months": {
"type": "number",
"description": "Loan term in months. For MORTGAGES this selects which market the quote is scored against: pass 180 for a 15-year and 360 for a 30-year. 15-year rates run structurally lower, so omitting it on a 15-year quote compares it to 30-year offers and makes an ordinary rate look market-leading. Defaults to 30-year. Also sharpens better-offer payment math for every product."
},
"credit_score": {
"type": "number",
"description": "Borrower's credit score (300-850). Optional; improves better-offer matching."
},
"product_type": {
"enum": [
"auto_loan",
"rv",
"boat",
"motorcycle",
"powersports",
"mortgage",
"mortgage_arm",
"heloc",
"personal_loan",
"student_loan",
"equipment_loan"
],
"type": "string",
"description": "Type of financing product the quote is for. Pick `mortgage_arm` — NOT `mortgage` — whenever the user names an adjustable-rate mortgage: \"ARM\", \"adjustable\", or a slash pair like \"5/1\", \"5/5\", \"7/1\", \"10/1\". ARM intro rates run structurally BELOW fixed rates, so scoring an ARM against the fixed market makes an ordinary quote look market-leading, which is the exact error this tool exists to prevent. All initial fixed periods share one ARM market. Use `mortgage` for fixed-rate mortgages and set term_months to pick 15- vs 30-year."
},
"include_better_offers": {
"type": "boolean",
"description": "Set TRUE for negotiation questions. Adds `better_offers`: named lenders currently beating the quote, each with the APR gap in basis points, estimated monthly savings, and `can_you_join` (yes / likely / unknown) so you only cite alternatives the borrower can realistically obtain. This is what turns a percentile into something the user can act on — prefer it whenever the user asks whether their rate is fair or what to do about it."
},
"include_nearby_offers": {
"type": "boolean",
"description": "Set true with zip to return product-matched rates from credit unions ranked by the closest NCUA-reported branch. Results include approximate straight-line miles, branch details, and the basis-point difference versus the quote."
}
}
}| Loan term in months (12-480). Optional. |
| credit_score | number | Credit score (300-850). Optional. |
| product_type* | string | Type of loan product. Required. |
{
"type": "object",
"required": [
"email",
"product_type",
"intent",
"target"
],
"properties": {
"email": {
"type": "string",
"description": "Consumer email address to send the alert to. Required."
},
"state": {
"type": "string",
"description": "Legacy single US state code (2-letter, e.g., CA, TX, NY). Prefer states or region for multi-state alerts."
},
"amount": {
"type": "number",
"description": "Loan amount in dollars. Optional."
},
"intent": {
"enum": [
"purchase",
"refinance",
"cash_out",
"balance_transfer",
"new_credit"
],
"type": "string",
"description": "The loan intent. Required."
},
"region": {
"enum": [
"east_coast",
"west_coast",
"midwest",
"south",
"northeast",
"southeast",
"southwest",
"mountain_west",
"new_england",
"mid_atlantic",
"pacific_northwest"
],
"type": "string",
"description": "Named region preset (e.g. east_coast); expands server-side to its member states."
},
"states": {
"type": "array",
"items": {
"type": "string"
},
"maxItems": 25,
"description": "2-letter US state codes (up to 25) — best rates are ranked ACROSS all of them, not per state."
},
"target": {
"type": "object",
"required": [
"field",
"operator",
"value"
],
"properties": {
"field": {
"enum": [
"rate",
"apr",
"monthly_payment"
],
"type": "string",
"description": "The field to watch."
},
"value": {
"type": "number",
"description": "The threshold value to compare against."
},
"operator": {
"enum": [
"lte",
"gte"
],
"type": "string",
"description": "Comparison operator (lte=at or below, gte=at or above)."
}
},
"description": "The condition that triggers the alert. Required."
},
"term_months": {
"type": "number",
"description": "Loan term in months (12-480). Optional."
},
"credit_score": {
"type": "number",
"description": "Credit score (300-850). Optional."
},
"product_type": {
"enum": [
"mortgage",
"auto_loan",
"rv",
"boat",
"motorcycle",
"powersports",
"heloc",
"personal_loan",
"student_loan",
"equipment_loan"
],
"type": "string",
"description": "Type of loan product. Required."
}
}
}| string |
{
"type": "object",
"required": [
"id"
],
"properties": {
"id": {
"type": "string",
"description": "Campaign id. Required."
},
"name": {
"type": "string"
},
"region": {
"enum": [
"east_coast",
"west_coast",
"midwest",
"south",
"northeast",
"southeast",
"southwest",
"mountain_west",
"new_england",
"mid_atlantic",
"pacific_northwest"
],
"type": "string",
"description": "Named region preset (e.g. east_coast); expands server-side to its member states."
},
"status": {
"enum": [
"active",
"paused"
],
"type": "string"
},
"cadence": {
"enum": [
"daily",
"weekly",
"monthly"
],
"type": "string"
},
"products": {
"type": "array",
"items": {
"type": "object"
},
"description": "Full replacement product set (1-5, no duplicates); same shapes as create_email_campaign."
},
"state_code": {
"type": "string",
"description": "Legacy single 2-letter US state code. Prefer state_codes or region."
},
"state_codes": {
"type": "array",
"items": {
"type": "string"
},
"maxItems": 25,
"description": "2-letter US state codes (up to 25) — best rates are ranked ACROSS all of them, not per state."
},
"intro_text_override": {
"type": "string"
}
}
}