Skip to content
Developers

Home applications

Send product: "Home" with the customer, address, home and demographics sections. Every home field is optional: send what you have, and the customer completes the rest on the review page.

Full example

Section titled “Full example”
{
  "call": {
    "id": "crm-application-10481",
    "channel": "web"
  },
  "sub_id": "spring-2026-email",
  "consent": {
    "sms_review_link": true,
    "recording_disclosed": true
  },
  "customer": {
    "first_name": "Maria",
    "last_name": "Gomez",
    "email": "maria.gomez@example.com",
    "phone": "1234567890",
    "date_of_birth": "1985-06-15",
    "ssn": "123-45-6789"
  },
  "address": {
    "line_1": "1100 Congress Ave",
    "line_2": "",
    "city": "Austin",
    "state": "TX",
    "postal_code": "78701"
  },
  "product": "Home",
  "home": {
    "year_built": 2004,
    "architectural_style": "Ranch",
    "dwelling_type": "SingleFamilyHouse",
    "construction_quality": "Average",
    "construction_type": "Frame",
    "exterior_wall_type": "BrickVeneer",
    "foundation_type": "Slab",
    "roof_material_type": "ASPHALT_SHINGLES",
    "roof_shape": "C_Hip",
    "roof_updated_type": "CompleteUpdate",
    "year_roof_updated": 2021,
    "heating_type": "Electric",
    "plumbing_type": "EntirelyCopper",
    "smoke_detectors": true,
    "deadbolt_locks": true,
    "fire_extinguisher": true,
    "sprinkler_system": true,
    "sprinkler_system_type": "Partial",
    "burglar_alarm_system": true,
    "burglar_alarm_system_type": "Central",
    "fire_detection_system": true,
    "fire_detection_system_type": "Direct",
    "electric_circuit_breaker": true,
    "has_garage": true,
    "garage_type": "Attached",
    "number_of_parking_spaces": 2,
    "heating_update_yn": true,
    "heating_update_type": "CompleteUpdate",
    "heating_update_year": 2019,
    "plumbing_update_yn": false,
    "electrical_update_yn": true,
    "electrical_update_type": "PartialUpdate",
    "electrical_update_year": 2015,
    "total_area_sq_ft": 2000,
    "number_of_units": 1,
    "number_of_stories": "One",
    "number_of_families": 1,
    "number_of_units_in_firewall": 1,
    "under_construction": false,
    "located_over_water": "NotOverWater",
    "distance_from_fire_hydrant_ft": "_0_500ft",
    "distance_from_fire_station_miles": "Lessthan5miles",
    "sale_price_cents": 35000000,
    "occupancy_type": "OwnerPrimary",
    "number_of_mortgagees": 1,
    "number_of_dogs": 0,
    "has_business_on_premises": false,
    "has_vicious_animals": false,
    "has_pool": false,
    "has_trampoline": false,
    "gated_community_discount": false,
    "mit_credit_form": false,
    "short_term_rental": false,
    "lapse_in_coverage": false,
    "property_insurance_cancelled": false,
    "move_in_date": "2020-05-01",
    "effective_date": "2026-07-15",
    "home_has_prior_insurance": true,
    "home_prior_carrier_name": "Allstate",
    "home_prior_years": 5,
    "home_continuous_coverage_years": 5,
    "home_prior_expiration_date": "2026-07-14",
    "dwelling_replacement_cost": 300000,
    "other_structures_coverage": 30000,
    "personal_property_coverage": 150000,
    "loss_of_use_coverage": 60000,
    "personal_liability": "ThreeHundred",
    "dwelling_medical_payments": "cov5000",
    "all_perils_deductible": "OneThousand",
    "windstorm_deductible": "TwoPercent",
    "prior_address": "900 E 5th St, Austin, TX 78702",
    "years_at_prior_address": 4,
    "losses": [
      {
        "description": "WATERDAMAGE",
        "date_of_incident": "2022-11-03",
        "amount_paid_cents": 480000
      }
    ]
  },
  "demographics": {
    "gender": "Female",
    "marital_status": "Married",
    "industry": "Info Tech",
    "occupation": "Software Engineer",
    "residence_type": "Own Home",
    "household_size": 3,
    "years_at_address": 4,
    "months_at_address": 2,
    "is_corporation": false,
    "is_mailing_address_different": false,
    "has_co_applicant": false,
    "order_credit_authorized": true,
    "has_health_insurance_auto_accident": false,
    "named_insured_foreclosure_repo_bankruptcy": false,
    "named_insured_convicted_insurance_fraud": false
  }
}

Minimal example

Section titled “Minimal example”

Everything else is completed by the customer on the review page.

{
  "call": {
    "id": "crm-application-10484"
  },
  "consent": {
    "sms_review_link": true
  },
  "product": "Home",
  "customer": {
    "first_name": "Maria",
    "last_name": "Gomez",
    "phone": "1234567890",
    "email": "maria@example.com"
  },
  "address": {
    "line_1": "1100 Congress Ave",
    "city": "Austin",
    "state": "TX",
    "postal_code": "78701"
  }
}

The applicant yes/no flags (order_credit_authorized, has_co_applicant and the rest) go in demographics for every product. See Applicant fields.

Field reference

Section titled “Field reference”

All optional at intake (draft). Provide what you captured; the rest is completed on the review page. Select fields must use the exact code values below — any other value is kept but flagged for the customer.

Field Type Valid values
year_built integer e.g. 2004
dwelling_type enum SingleFamilyHouse, Townhouse, Rowhouse, Duplex, Triplex, Fourplex, MultFamily
architectural_style enum TwoFamilyHome, American4square, Basic, BiLevel, Bungalow, CapeCod, Colonial, ColonialSpanish, CompletelyCustom, Contemporary, ContractorModern, Farmhouse, Folk, Log, Mediterranean, Ranch, TriLevel, Tudor, Vernacular, Victorian
construction_quality enum Basic, Modest, Average, AboveAverage, Expensive, VeryExpensive, Opulent
construction_type enum Frame, Masonry, MasonryVeneer, Log, Asbestos, EFIS, HardiPlank, SuperiorFireResistive, SuperiorMasonryNonCombustible, SuperiorNonCombustible
exterior_wall_type enum VinylSiding, WoodFraming, BrickVeneer, Stucco, AdobeBlock, AluminumSiding, CementFiberShingles, Clapboard, ConcreteBlock, HardboardSiding, InsulatedConcreteForms, LightGaugeSteelFraming, LogsSolid, MasoniteSiding, PreEngineeredMetal, SolidBrickConstruction, SolidConcrete, StandardPoleFramed, Stone, StructuralInsulatedPanels, TimberFraming
foundation_type enum Slab, Basement, CrawlSpace, PartialBasement, PiersPostsPiles, Open
basement_type enum Basement, SplitLevelBasement, WalkoutBasement. Additive to foundation_type, not a replacement — only rated when foundation_type is Basement or PartialBasement.
roof_material_type enum ASPHALT_SHINGLES, ARCHITECTURAL_SHINGLES, METAL, TILE_CONCRETE, ASBESTOS, BUILT_UP, COMPOSITION, CONCRETE, COPPER, CORRUGATED_STEEL, FIBERGLASS, FOAM, GRAVEL, MEMBRANE, MINERAL_FIBER_SHAKE, PLASTIC, ROCK, ROLLED_PAPER, RUBBER, SLATE, TAR, TAR_GRAVEL, TILE_CLAY, TILE_MISSION, TILE_SPANISH, TIN, WOOD_FIBERGLASS_SHINGLES, WOOD_SHAKE, WOOD_SHINGLES, OTHER
roof_shape enum B_Gable, C_Hip, A_Flat, D_Other
roof_updated_type enum NotUpdated, PartialUpdate, CompleteUpdate
year_roof_updated integer Year the roof was replaced, e.g. 2021. Big wind/hail factor. Only rated when roof_updated_type is PartialUpdate or CompleteUpdate — send both together.
heating_type enum Electric, Gas, GasForcedAir, GasHotWater, Oil, OilForcedAir, OilHotWater, SolidFuel, Other
plumbing_type enum EntirelyCopper, EntirelyGalvanized, EntirelyPEX, EntirelyPVC, Polybutylene
number_of_stories enum One, OneHalf, Two, TwoHalf, Three, ThreeHalf, Four, BiLevel, TriLevel
located_over_water enum NotOverWater, PartiallyOverWater, FullyOrEntirelyOverWater
occupancy_type enum OwnerPrimary, OwnerSecondary, OwnerSeasonal
distance_from_fire_hydrant_ft enum _0_500ft, _501_1000ft, _1001ftAndGreater
distance_from_fire_station_miles enum Lessthan5miles, Over5miles, NotAvailable
total_area_sq_ft, number_of_units, number_of_families, number_of_units_in_firewall, number_of_mortgagees, number_of_dogs, household_size integer
under_construction, has_business_on_premises, has_vicious_animals, has_pool, has_trampoline, gated_community_discount, mit_credit_form, short_term_rental, lapse_in_coverage, property_insurance_cancelled boolean
move_in_date, effective_date string YYYY-MM-DD
sale_price number Whole dollars (e.g. 350000). Preferred. Converted to sale_price_cents, and wins if both are sent.
sale_price_cents integer In cents (e.g. 35000000 = $350,000). Kept for callers already computing cents themselves.

Protective devices — device-discount inputs. Send false explicitly when the customer says no; an omitted field and a false are not the same thing to the rater.

Field Type Valid values / notes
smoke_detectors, deadbolt_locks, fire_extinguisher, sprinkler_system, burglar_alarm_system, fire_detection_system boolean
burglar_alarm_system_type enum Central, Direct, Local. Only rated when burglar_alarm_system is true.
fire_detection_system_type enum Central, Direct, Local. Only rated when fire_detection_system is true.
sprinkler_system_type enum Full, Partial. Only rated when sprinkler_system is true.
electric_circuit_breaker boolean “Breakers or fuses?” — a yes/no, not a panel-type enum. There is no field for finer detail (knob-and-tube, fuse box); collapse the question to breakers yes/no.
has_garage boolean Garage or carport.
garage_type enum Attached, Basement, BuiltIn, Carport, Detached. Only rated when has_garage is true.
number_of_parking_spaces integer Covered spaces, 1-3 (clamped to that range). Only rated when has_garage is true.

Systems modernization — send the flag, the extent and the year together. The extent defaults to CompleteUpdate when omitted, so send it explicitly when the work was partial. If you send a year without the flag, the flag is inferred as true.

Field Type Valid values / notes
heating_update_yn, plumbing_update_yn, electrical_update_yn boolean
heating_update_type, plumbing_update_type, electrical_update_type enum PartialUpdate, CompleteUpdate — only these two. Unlike roof_updated_type, there is no NotUpdated: the extent only applies once the matching *_update_yn is true.
heating_update_year, plumbing_update_year, electrical_update_year integer Year, e.g. 2019.
oil_tank_location enum AboveGround, BelowGround. Only rated when heating_type is Oil, OilForcedAir or OilHotWater — otherwise it is stored but never reaches the carrier.

Prior + mailing address — all three are required on the review page, so sending them at intake stops the customer re-typing what you already collected. The review page asks for a prior address only when years_at_address < 3, and for a mailing address only when is_mailing_address_different is true.

Field Type Valid values / notes
prior_address string Full single-line address; geocoded server-side and split into the prior-address columns (same handling as garaging_address). Reaches the carrier as the applicant’s previous address.
years_at_prior_address integer
mailing_address string Full single-line address. Send with is_mailing_address_different: true. Stored on the quote and shown on the review page; not part of the rating submission.

Prior insurance

Field Type Valid values / notes
home_has_prior_insurance boolean
home_prior_carrier_name enum NoPriorInsurance or a carrier code (Allstate, Amica, AutoOwners, AmericanFamily, StateFarm, …). If NoPriorInsurance, the year/expiration fields are ignored.
home_prior_years, home_continuous_coverage_years integer
home_prior_expiration_date string YYYY-MM-DD

Coverages (whole-dollar integers unless noted)

Use realistic amounts. These are whole dollars (not cents). Use a real dwelling replacement value (typically ~$150,000+); the other three coverages are normally a fraction of it — other structures ~10%, personal property ~50%, loss of use ~20%.

Field Type Valid values / notes
dwelling_replacement_cost, other_structures_coverage, personal_property_coverage, loss_of_use_coverage integer Whole dollars, e.g. 300000. Must be realistic — see note above.
personal_liability enum TwentyFive, Fifty, OneHundred, TwoHundred, ThreeHundred, FourHundred, FiveHundred
dwelling_medical_payments enum cov1000, cov2000, cov3000, cov4000, cov5000
all_perils_deductible enum TwoHundredFifty, FiveHundred, SevenHundredFifty, OneThousand, OneThousandFiveHundred, TwoThousand, TwoThousandFiveHundred, ThreeThousands, FourThousands, FiveThousands, OnePercent, TwoPercent, ThreePercent, FourPercent, FivePercent
windstorm_deductible enum None, OnePercent, TwoPercent, FivePercent, TenPercent

home.losses[]

Section titled “home.losses[]”

Editable by the customer on the review page (lenient like other home fields).

Field Type Notes
description enum Home loss code, e.g. FIRE, HAIL, WATERDAMAGE, THEFTBURGLARY, HURRICANE.
date_of_incident string YYYY-MM-DD
amount_paid_cents integer In cents.