The home quote object
Required properties
| Parameter | Type | Description |
|---|---|---|
is_owner | Boolean | Set to true if household owns the home. Accepts true or false, or the strings "true", "yes", "false" and "no" in any case. Any other value is rejected. |
insurance_carrier | String | The insurance carrier of the quote. The list of supported carriers are here. NOTE: If the carrier is not in the list, you can put it as is, but some features may not be supported for the agent. |
home | Object | The property covered by the quote. Learn more about the home object here. NOTE: If a home has multiple quotes, just add the same home object for the home property of the other home quote/s. |
Conditional properties
| Parameter | Type | Condition | Description |
|---|---|---|---|
residence_type | String | Required if is_owner is set to true. | How the household occupies or holds the home it owns. The accepted values are Primary, Secondary, Condo, and Rental (case sensitive). NOTE: This is optional when is_owner is false, but a value you do send must still be one of these four. |
dwelling_coverage | Number | Enabled if is_owner is set to true. | The dwelling coverage of the quote. Any whole number (non-negative, no decimal) is accepted. Example: 5000 |
separate_structures_coverage | Number | Enabled if is_owner is set to true. | The separate structures coverage of the quote. Any whole number (non-negative, no decimal) is accepted. Example: 5000 |
wind_hail_deductible | Number | Enabled if is_owner is set to true. | The wind/hail deductible of the quote. Any whole number (non-negative, no decimal) is accepted. Example: 5000 |
hurricane_deductible | Number | Enabled if is_owner is set to true. | The hurricane deductible of the quote. Any whole number (non-negative, no decimal) is accepted. Example: 5000 |
Heads up
The values of dwelling_coverage, separate_structures_coverage, wind_hail_deductible and hurricane_deductible are ignored unless is_owner is set to true.
Optional properties
| Parameter | Type | Description |
|---|---|---|
is_escrowed | Boolean | Set to true if home is escrowed. Accepts true or false, or the strings "true", "yes", "false" and "no" in any case. Any other value is rejected. |
policy_renewal_date | String | The policy renewal date of the quote. The date format should be YYYY-MM-DD. Example: 2020-12-31 |
payment_plan | String | The payment plan of the quote. The accepted values are Pay-in-Full, 2-Pay, Monthly-Credit/Debit, Monthly-by-Mail, 4-Pay, and Monthly-EFT (case sensitive). |
full_term_premium | Number | The full term premium of the quote. Any non-negative number is accepted. Example: 5000.54 |
personal_property_coverage | Number | The personal property coverage of the quote. Any whole number (non-negative, no decimal) is accepted. Example: 5000 |
personal_liability_coverage | Number | The personal liability coverage of the quote. The accepted values are 100000, 200000, 300000, 500000, 1000000, and 2000000. |
loss_of_use_coverage | Number | The loss of use coverage of the quote. Any whole number (non-negative, no decimal) is accepted. Example: 5000 |
living_expense_term | String | The living expense term of the quote. The accepted values are 12 months and 24 months (case sensitive). |
guest_medical_coverage | Number | The guest medical coverage of the quote. The accepted values are 1000, 2000, 2500, and 5000. |
other_deductible | Number | The other deductibles of the quote. Any whole number (non-negative, no decimal) is accepted. Example: 5000 |
Sending values
- Boolean fields (
is_owner,is_escrowed) take JSONtrueorfalse, or the strings"true","yes","false"and"no"in any case. Any other value, such as1,"0"or"N", is rejected with a 422 that names the field. - Number fields are sent as bare numbers: no quotes, no commas and no
$. For example, send235730, not"235,730"or"$235,730". Each field's own rule (whole number, any non-negative number, or a list of accepted values) still applies. - A home detail with no matching field, such as the type of garage, goes in the
notesof the lead.
Example
{
"is_owner": true,
"is_escrowed": true,
"residence_type": "Secondary",
"insurance_carrier": "Allstate",
"policy_renewal_date": "2021-12-31",
"payment_plan": "Pay-in-Full",
"full_term_premium": 2208,
"dwelling_coverage": 235730,
"separate_structures_coverage": 23573,
"personal_property_coverage": 153225,
"personal_liability_coverage": 300000,
"loss_of_use_coverage": 58933,
"living_expense_term": "24 months",
"guest_medical_coverage": 5000,
"wind_hail_deductible": 2357,
"hurricane_deductible": 2357,
"other_deductible": 2357,
"home": {
"street1": "6133 Flatley Heights",
"city": "Morissetteburgh",
"state": "NV",
"postal_code": "57461",
"baths": 3.5,
"fireplaces": 1,
"garages": 2,
"stories": 3,
"square_feet": 1191,
"roof_year": 2009,
"has_electric_heating": true,
"has_gas_heating": false,
"has_pool": true,
"build_year": 2009,
"total_market_value": 229965
}
}