Home and Auto Consumer Data Request Properties

ConsumerDataRequest

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.
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.
homeProductData	HomeConsumerData	Required	The home specific data. See the definition of HomeConsumerData below.
autoProductData	AutoConsumerData	Required	The auto specific data. See the definition of AutoConsumerData 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.

HomeConsumerData

Name	Type	Validation	Description
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.

AutoConsumerData

Name	Type	Validation	Description
drivers	Array of Drivers		The drivers to be insured.
vehicles	Array of Vehicles	Should be at least one vehicle	The vehicles to be insured.
maritalStatus	string	Should be one of the values from the MaritalStatus list	The main applicant's marital status.
yearsAtCurrentAddress	string	Should be a number between 1 and 100.	The number of years the applicants have been at their current address.
homeOwnership	string	Should be one of the values from the HomeOwnership list	The ownership status of the applicants home.
creditRating	string	Should be one of the values from the CreditRating list	The credit rating of the main applicant.
bankruptcy	boolean		Whether the main applicant is bankrupt.
currentCarrier	string		The current carrier of the applicants.
currentInsuranceExpirationDate	string	Format: ISO 8601	The expiration date of the applicants current insurance.
currentInsuranceYears	string	Should be one of the values from the CurrentTimeWithCarrier list	The number of years the applicant has been covered.
bodilyInjuryLiabilityLimit	string	Should be one of the values from the BodilyInjuryLiabilityLimit list	The bodily injury liability limit of the applicants current insurance.

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.
sprinkler	boolean		Indicates whether a functioning sprinkler system is installed or not.
gatedCommunity	boolean		Whether the property is in a gated community.

Driver

Name	Type	Validation	Description
firstName	string	Max Length: 64	The driver's name.
middleNameInitial	string	Max Length: 1	The driver's middle name initial
lastName	string	Max Length: 64	The driver's last name.
licenseStatus	string	Should be one of the values from the LicenseStatus list	The status of the driver's license.
licenseState	string	Should be one of the values from the LicenseStatus list	State specific to this driver’s license.
licenseNumber	string	Should be one of the values from the LicenseStatus list	License number specific to this driver’s license.
licenseObtainedAge	string	Should be a number	The age the driver obtained their license.
licenseEverSuspendedOrRevoked	boolean		Whether or not the driver's license was ever suspended or revoked.
sr22Required	boolean		Whether or not a SR22 is required.
gender	string	Should be one of the values from the Gender list	The gender.
dateOfBirth	string	Format: ISO 8601	The date of birth.
maritalStatus	string	Should be one of the values from the MaritalStatus list	The driver's marital status.
occupation	string		The driver's occupation.
educationLevel	string	Should be one of the values from the EducationLevel list	The driver's education level.
relationshipToApplicant	string	Should be one of the values from the RelationshipToApplicant list	The driver's relationship to the applicant.
violations	DriverViolation	A list of violations that the driver has. DriverViolation	The driver's relationship to the applicant.
claims	DriverClaim	A list of claims that the driver has. DriverClaim	The driver's relationship to the applicant.

Vehicle

Name	Type	Validation	Description
vin	string	Required Max Length: 17	The Vehicle Identification Number.
year	string	Should be a number of maximum 4 digits	The vehicle year of manufacture.
make	string	Max Length: 100	The vehicle make.
model	string	Max Length: 150	The vehicle model.
subModel	string	Max Length: 150	The vehicle sub-model.
primaryUse	string	Should be one of the values from the PrimaryUse list	The primary use of the vehicle.
garageType	string	Should be one of the values from the GarageType list	Where the vehicle is garaged.
parkedAtMailingAddress	boolean		Whether or not the vehicle is parked at the mailing address.
garagingAddress	Address		The address of the garage where the vehicle is parked (if different from main applicant address).
oneWayDistance	string	Should be a number	The one way distance
annualMileage	string	Should be a number	The annual mileage.
ownership	string	Should be one of the values from the AutoOwnership list	The ownership of the vehicle.
coveragePackage	string	Max Length: 50	The type of coverage package.

DriverClaim

Name	Type	Validation	Description
claimDate	string	Format: ISO 8601	The date of the claim.
amount	string	Must be a number	The amount claimed for.
type	string		The type of claim.

DriverViolation

Name	Type	Validation	Description
violationDate	string	Format: ISO 8601	The date of the violation.
type	string	Should be one of the values from the ViolationType list	The type of the violation.

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

AutoOwnership

• Unspecified
• Owned
• Financed
• Leased

BodilyInjuryLiabilityLimit

• BI_0
• BI_10000_20000
• BI_12500_25000
• BI_15000_30000
• BI_20000_40000
• BI_25000_50000
• BI_25000_65000
• BI_30000_60000
• BI_50000_100000
• BI_100000_100000
• BI_100000_200000
• BI_100000_300000
• BI_100000_500000
• BI_250000_500000
• BI_300000_300000
• BI_300000_500000
• BI_500000_500000
• BI_500000_1000000
• BI_1000000_1000000
• BI_55_CSL
• BI_75_CSL
• BI_100_CSL
• BI_200_CSL
• BI_250_CSL
• BI_300_CSL
• BI_500_CSL
• BI_1000_CSL

CreditRating

• Unspecified
• Good
• Average
• Poor
• Excellent

CurrentTimeWithCarrier

• Unspecified
• LessThan1Year
• OneYear
• TwoYears
• ThreeYears
• FourYears
• FiveYears
• SixYears
• SevenYears
• EightYears
• NineYears
• TenOrMoreYears

EducationLevel

• Unspecified
• SomeHighSchool
• CompletedHighSchool
• SomeCollege
• TechVocationalTraining
• CompletedCollege
• CompletedGradSchool

GarageType

• Unspecified
• None
• Carport
• AttachedGarage
• DetachedGarage

HomeOwnership

• Unspecified
• OwnedHouse
• OwnedCondo
• RentedHouse
• RentedCondo
• Apartment
• OwnedMobileHome
• RentedMobileHome
• LivesWithParents

LicenseStatus

• Unspecified
• Chauffeur
• CommercialVehicle_Business
• NotLicensed_StateId
• Permit
• PersonalAuto

MaritalStatus

• Unspecified
• Single
• Divorced
• Married
• Separated
• Widowed

PrimaryUse

• Unspecified
• Business
• Commute
• Farming
• Personal

RelationshipToApplicant

• Unspecified
• Other
• Spouse
• Insured
• Parent
• Child

ViolationType

• Unspecified
• CarelessDriving
• CellPhone
• ChildSafetyRestraint
• DefectiveEquipment
• DividedHighways
• DoubleLines
• DrivingLeftOfCenter
• DrivingOnSusLicense
• DrivingTooSlow
• DrivingWithoutLights
• DUI
• EludingPolice
• FailureToObeySignal
• FailureToStop
• FailureToYield
• FailureToObserveASafetyZone
• FailureToShowDocuments
• FalseReporting
• Felony
• FollowingTooClosely
• Homicide
• IllegalTurn
• ImproperParking
• ImproperPassing
• ImproperLoads
• LeavingSceneOfAnAccident_HitAndRun
• MotorcycleViolation
• OtherMajor
• OtherMinor
• OpenContainer
• OperatingVehicleWithoutPermission
• OutOfState
• PassingSchoolBus
• Racing_DragRacing
• RecreationalVehicle
• RecklessDriving
• RefusalToSubmitToChemicalTest
• Speeding1_5
• Speeding6_10
• Speeding11_15
• Speeding16_20
• Speeding21
• SpeedOver100mph
• SpeedingViolationMajor
• SpeedingViolationMinor
• SeatBelt
• Suspension
• TicketViolationNotListed
• Towing
• TransportationOfHazardousMaterials
• UnsafeOperationOfAMotorVehicle
• VehicleTheft
• WrongWay_WrongLane
• TextingWhileDriving