Skip to main content

Home Quotes Request Properties

HomeQuotesRequest

NameTypeValidationDescription
firstNamestringRequired
Max Length: 64
The first name.
lastNamestringRequired
Max Length: 64
The last name.
dateOfBirthstringRequired
Format: ISO 8601
The date of birth.
emailstringRequired
Max Length: 100
Should be a valid email address
The email address.
phonestringRequired
Min Length: 10
Should be a valid phone number
The telephone number.
campaignCodestringRequired
Max Length: 8
The campaign code.
productDataHomeQuoteQuestionsRequired
The home specific data. See the definition of HomeQuoteQuestions below.
metadataOrderedMap[string, string]Max Number of Items:10
Key Max Length: 100
Value Max Length: 100
Metadata that can be passed along with the request, and is returned with each response. Can be used for customer specific information.

HomeQuoteQuestions

NameTypeValidationDescription
addressAddressRequiredThe address. See the definition of Address below.
genderstringRequired
Should be one of the values from the Gender list
The gender.
PropertyPurchasedInLastSixMonthsbooleanWhether or not the property was purchased in the last six months.
previousAddressAddressRequired if PropertyPurchasedInLastSixMonths is trueThe previous address (if applicable).
propertyDetailsAddressRequiredThe details of the property.
carrierstringThe current insurance carrier.
coverageYearsstringMust be a number between 1 and 32767The number of years the insured has been covered for.
ratingstringMax Length: 64The credit rating of the insured.

Address

NameTypeValidationDescription
streetNumberstringMax Length: 50The street number. (if applicable)
addressLine1stringRequired
Max Length: 255
The first line of the address.
addressLine2stringMax Length: 255The second line of the address (if applicable)
apartmentNumberstringMax Length: 50The apartment number (if applicable).
citystringRequired
Max Length: 50
The city.
countystringMax Length: 50The county.
statestringRequired
Min Length: 2
The US Postal Service state code.
zipstringRequired
Min Length: 5
Max Length: 5
The ZIP code.

PropertyDetails

NameTypeValidationDescription
propertyTypestringShould be one of the values from the PropertyType listThe type of property.
ResidenceUsagestringShould be one of the values from the ResidenceUsage listThe primary usage of the property.
yearBuiltstringMust be a year only. Not over 100 years ago. Not in the futureYear in which the house was built.
squareFootagestringMust be a number between 1 and 32767.The square footage of the property.
roofMaterialstringShould be one of the values from the RoofMaterial listThe roof material of the property.
BedroomsstringShould be a numberThe number of bedrooms the property has.
BathroomsstringShould be a numberThe number of bathrooms the property has.
MarketValuestringShould be a numberThe market value of the property.
fireAlarmstringShould be one of the values from the FireAlarm listWhat type of fire alarm the property has.
burglarAlarmstringShould be one of the values from the BurglarAlarm listWhat type of burglar alarm the property has.
gatedCommunitybooleanWhether the property is in a gated community.

List Values

BurglarAlarm

  • Unspecified
  • None
  • Local
  • CentrallyMonitored

FireAlarm

  • Unspecified
  • None
  • Local
  • CentrallyMonitored

Gender

  • Male
  • Female

PropertyType

  • Unspecified
  • Other
  • SingleFamily
  • Condominium
  • Townhouse
  • MobileOrManufactured
  • MultiFamily
  • Duplex

ResidenceUsage

  • Unspecified
  • Other
  • PrimaryResidence
  • SecondaryHome
  • Rental
  • Vacant

RoofMaterial

  • Unspecified
  • Other
  • StandardShingle
  • RatedShingle
  • WoodShingle
  • FlatConcreteOrClayTile
  • Metal
  • ClayOrConcrete
  • Flat
  • RolledPaperFlat