Home Consumer Data Request Properties

HomeConsumerDataRequest

Name	Type	Validation	Description
firstName	string	Required Max Length: 64	The insured's first name.
middleNameInitial	string	Max Length: 1	The insured's middle name initial.
lastName	string	Required Max Length: 64	The insured's last name.
dateOfBirth	string	Format: ISO 8601	The insured's date of birth.
email	string	Required Max Length: 100 Should be a valid email address	The insured's email address.
phone	string	Required Min Length: 10 Should be a valid phone number	The insured's phone number.
campaignCode	string	Required Max Length: 8	The campaign code.
productData	HomeQuoteQuestions	Required	The home specific data. See the definition of HomeQuoteQuestions below.
metadata	OrderedMap[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

Name	Type	Validation	Description
address	Address	Required	The insured's address. See the definition of Address below.
gender	string	Should be one of the values from the Gender list	The insured's gender.
propertyPurchasedInLastSixMonths	boolean		Whether the property was purchased in the last six months.
previousAddress	Address	Only required if propertyPurchasedInLastSixMonths is true	The address that the insured used to live in.
mortgageeLender	MortgageeLender		The mortgagee lender information.
propertyDetails	PropertyDetails	Required	The property details.
carrier	string		The insured's current insurance carrier.
coverageYears	string	Must be a number between 1 and 32767	The insured's current insurance coverage years.
rating	string	Max Length: 64	The insured's credit rating.
coApplicant	CoApplicant		The details of a CoApplicant.
occupation	string		The insured's Occupation
policyExpirationDate	string	Format: ISO 8601	The insured's policy expiration date.
currentPremium	string	Must be a number	The insured's policy current premium.

Address

Name	Type	Validation	Description
streetNumber	string	Max Length: 50	The street number. (if applicable)
addressLine1	string	Required Max Length: 255	The first line of the address.
addressLine2	string	Max Length: 255	The second line of the address (if applicable)
apartmentNumber	string	Max Length: 50	The apartment number (if applicable).
city	string	Required Max Length: 50	The city.
county	string	Max Length: 50	The county.
state	string	Required Min Length: 2	The US Postal Service state code.
zip	string	Required Min Length: 5 Max Length: 5	The ZIP code.

MortgageeLender

Name	Type	Validation	Description
companyName	string	Required Max Length: 255	The mortgagee lender's company name.
addressLine1	string	Required Max Length: 255	The mortgagee lender's address line 1.
addressLine2	string	Max Length: 255	The mortgagee lender's address line 2.
city	string	Required Max Length: 50	The mortgagee lender's address city.
state	string	Required Max Length: 2	The mortgagee lender's address state.
zip	string	Required Max Length: 5	The mortgagee lender's address zip code.
loanNumber	string	Required Min Length: 5 Max Length: 5	The mortgagee lender's loan number.

• These values are only required if the mortgageeLender object is included in the request.

PropertyDetails

Name	Type	Validation	Description
propertyType	string	Should be one of the values from the PropertyType list	The type of property.
ResidenceUsage	string	Should be one of the values from the ResidenceUsage list	The primary usage of the property.
yearBuilt	string	Must be a year only. Not over 100 years ago. Not in the future	Year in which the house was built.
squareFootage	string	Must be a number between 1 and 32767.	The square footage of the property.
roofMaterial	string	Should be one of the values from the RoofMaterial list	The roof material of the property.
Bedrooms	string	Should be a number	The number of bedrooms the property has.
Bathrooms	string	Should be a number	The number of bathrooms the property has.
MarketValue	string	Should be a number	The market value of the property.
fireAlarm	string	Should be one of the values from the FireAlarm list	What type of fire alarm the property has.
burglarAlarm	string	Should be one of the values from the BurglarAlarm list	What type of burglar alarm the property has.
gatedCommunity	boolean		Whether 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