Skip to main content

Auto Consumer Data Request Properties

AutoConsumerDataRequest

NameTypeValidationDescription
firstNamestringRequired
Max Length: 64
The insured's first name.
middleNameInitialstringMax Length: 1The insured's middle name initial.
lastNamestringRequired
Max Length: 64
The insured's last name.
dateOfBirthstringFormat: ISO 8601The insured's date of birth.
emailstringRequired
Max Length: 100
Should be a valid email address
The insured's email address.
phonestringRequired
Min Length: 10
Should be a valid phone number
The insured's phone number.
campaignCodestringRequired
Max Length: 8
The campaign code.
productDataAutoConsumerDataQuestionsRequiredThe auto specific data. See the definition of AutoConsumerDataQuestions 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.

AutoConsumerDataQuestions

NameTypeValidationDescription
addressAddressThe insured's address. See the definition of Address below.
genderstringShould be one of the values from the Gender listThe insured's gender.
driversArray of DriversThe drivers to be insured.
vehiclesArray of VehiclesShould be at least one vehicleThe vehicles to be insured.
maritalStatusstringShould be one of the values from the MaritalStatus listThe main applicant's marital status.
yearsAtCurrentAddressstringShould be a number between 1 and 100.The number of years the applicants have been at their current address.
homeOwnershipstringShould be one of the values from the HomeOwnership listThe ownership status of the applicants home.
creditRatingstringShould be one of the values from the CreditRating listThe credit rating of the main applicant.
bankruptcybooleanWhether the main applicant is bankrupt.
currentCarrierstringThe current carrier of the applicants.
currentInsuranceExpirationDatestringFormat: ISO 8601The expiration date of the applicants current insurance.
currentInsuranceYearsstringShould be one of the values from the CurrentTimeWithCarrier listThe number of years the applicant has been covered.
bodilyInjuryLiabilityLimitstringShould be one of the values from the BodilyInjuryLiabilityLimit listThe bodily injury liability limit of the applicants current insurance.

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.

Vehicle

NameTypeValidationDescription
vinstringRequired
Max Length: 17
The Vehicle Identification Number.
yearstringShould be a number of maximum 4 digitsThe vehicle year of manufacture.
makestringMax Length: 100The vehicle make.
modelstringMax Length: 150The vehicle model.
subModelstringMax Length: 150The vehicle sub-model.
primaryUsestringShould be one of the values from the PrimaryUse listThe primary use of the vehicle.
garageTypestringShould be one of the values from the GarageType listWhere the vehicle is garaged.
parkedAtMailingAddressbooleanWhether or not the vehicle is parked at the mailing address.
garagingAddressAddressThe address of the garage where the vehicle is parked (if different from main applicant address).
oneWayDistancestringShould be a numberThe one way distance
annualMileagestringShould be a numberThe annual mileage.
ownershipstringShould be one of the values from the AutoOwnership listThe ownership of the vehicle.
coveragePackagestringMax Length: 50The type of coverage package.

Driver

NameTypeValidationDescription
firstNamestringMax Length: 64The driver's name.
middleNameInitialstringMax Length: 1The driver's middle name initial
lastNamestringMax Length: 64The driver's last name.
licenseStatusstringShould be one of the values from the LicenseStatus listThe status of the driver's license.
licenseStatestringShould be one of the values from the LicenseStatus listState specific to this driver’s license.
licenseNumberstringShould be one of the values from the LicenseStatus listLicense number specific to this driver’s license.
licenseObtainedAgestringShould be a numberThe age the driver obtained their license.
licenseEverSuspendedOrRevokedbooleanWhether or not the driver's license was ever suspended or revoked.
sr22RequiredbooleanWhether or not a SR22 is required.
genderstringShould be one of the values from the Gender listThe gender.
dateOfBirthstringFormat: ISO 8601The date of birth.
maritalStatusstringShould be one of the values from the MaritalStatus listThe driver's marital status.
occupationstringThe driver's occupation.
educationLevelstringShould be one of the values from the EducationLevel listThe driver's education level.
relationshipToApplicantstringShould be one of the values from the RelationshipToApplicant listThe driver's relationship to the applicant.
violationsDriverViolationA list of violations that the driver has. DriverViolationThe driver's relationship to the applicant.
claimsDriverClaimA list of claims that the driver has. DriverClaimThe driver's relationship to the applicant.

DriverClaim

NameTypeValidationDescription
claimDatestringFormat: ISO 8601The date of the claim.
amountstringMust be a numberThe amount claimed for.
typestringThe type of claim.

DriverViolation

NameTypeValidationDescription
violationDatestringFormat: ISO 8601The date of the violation.
typestringShould be one of the values from the ViolationType listThe type of the violation.

List Values

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

Gender

  • Male
  • Female

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