Skip to content

Partner Quote API

Data Types

Application

Name Type Description Required
drivers [ Driver ] List of drivers included in the policy Yes
vehicles [ Vehicle ] List of vehicles covered by the policy Yes
coverage CoverageInput Requested coverages for the policy No
ubi Ubi The details of Usage Based Insurance product. No
effective_date string Policy effective date in supported format: YYYY-MM-DD
Example: "2024-01-01"
No

BridgeUrls

Name Type Description Required
agent_bridge_url string URL for agents to access quote or policy information for their clients. Yes
consumer_bridge_url string URL for consumers to access their quote or policy information. Yes

Channel

Information about the agent and channel sending the request.

Name Type Description Required
channel_id string Unique identifier of the channel. Novo will assign a unique channel id to each partner. Please note that channel_id is not same as channel prefix in agent_id.
Example: "novo"
Yes
agent_id string The agent ID in Novo for a partner agent. The default value "xyz-999999999" uses "xyz" as the channel prefix assigned by Novo and "999999999" as a generic agent ID for the partner.
Example: "nov-9999999999"
No
integration_type string Channel integration type, default value: "direct".
Example: "direct", "leadcloud", "beacon"
No
channel_lead_id string Click partner lead channel identifier, which must be a non-empty string if provided.
Example: "0196596a-e597-7782-89f7-481a9512fcfa"
No

Deprecation Notice: channel_lead_id under Channel

The channel_lead_id field under Channel is scheduled for deprecation in upcoming versions.
Moving forward, please use tracking.click_id to pass this value. Update your integration to ensure compatibility with future releases.

Compliance

Ensures legal defensibility for leads containing consumer PII.

Name Type Description Required
tcpa_consent boolean Indicates whether the user provided TCPA-compliant consent to be contacted. N
consent_timestamp string The exact time when the user gave consent in UTC format.
Example: 2025-05-05T18:29:58Z
No
consent_source string The origin of the consent capture.
Example: beacon, MediaAlpha
No
consent_language string The exact legal language presented to the user at the time of consent. No
privacy_policy_url string The URL of the privacy policy shown to the user at the time of consent. No

ContactInfo

The contact information for the driver.

Name Type Description Required
email string Example: "example@gmail.com" No
phone string The phone number of the driver.
Example: "9999999999"
No

CoverageInput

Requested coverages for the policy

Name Type Description Required
policy_coverage PolicyCoverageInput Requested policy coverage. No
vehicle_coverage [ VehicleCoverageInput ] List of requested vehicle coverage for all vehicles covered under the policy. If provided, the vehicle_coverage list must have the same length and follow same order as the vehicles list. Otherwise it will be ignored. No

CoverageResponse

Coverage details returned in quote responses

Name Type Description Required
policy_coverages [ PolicyCoverageItem ] Coverage details that apply at the policy level Yes
vehicle_coverages [ VehicleCoverageResponse ] Coverage details that apply at the vehicle level Yes

Driver

Information about the driver

Name Type Description Required
address Location The address where driver lives. Yes
contact_info ContactInfo The contact information for the driver. No
credit_rating string Driver's credit rating.
Supported:
- excellent
- good
- average
- poor
No
dob string Date of birth of the driver in supported format: YYYY-MM-DD
Example: "1980-05-05"
No
(Required in quote request)
driver_license DriverLicense Driver license details. No
education string Highest level of education attained by the driver.
Supported:
- no_diploma
- high_school
- bachelor
- masters
- doctoral
- vocational
- some_college_no_degree
- in_college
No
gender string Driver's gender.
Supported:
- female
- male
No
had_driver_training boolean Indicates if the driver has completed crash avoidance training and received certification.
Example: true
No
incident_history [ Incident ] Driver's prior incidents or violations No
marital_status string Marital status of the driver.
Supported:
- single
- married
- widowed
- divorced
- separated
- domestic_partner
- civil_union
No
name Name The name information of the driver. Yes
occupation Occupation Driver's occupation No
prior_insurance PriorInsurance Details about the prior insurance coverage held by the applicant. No
relation_to_pni string Driver's relationship to the primary named insured (PNI).
Supported:
- self
- parent
- spouse
- child
- other_related
- other_unrelated
No
residence Residence Information about the applicant's current residence. No
student_profile StudentProfile Represents the profile of a student. No

DriverLicense

Name Type Description Required
age_license_obtained number The age at which the driver obtained their driver's license. If years_licensed is provided, this field will be ignored.

Example: 16
No
years_licensed string The number of years the driver has been licensed. This field takes precedence over age_license_obtained.

Supported values:
- '0' → Less than 1 year
- '1' → Between 1 and 2 years
- '2' → Between 2 and 3 years
- '3' → 3 years or more (default if neither field is provided)

Example: '1'
No
id string The unique identification number of the driver's license.
Example: "D12345678"
No
state string The state where the driver's license was issued.
Example: "AZ"
No
type string The type of the driver license. The default value is "personal".
Supported:
- personal
- permit
- commercial_business
- foreign_license
- chauffeur
- not_licensed
No
status string The status of the driver license. The default value is "active_valid".
Supported:
- active_valid
- suspended_denied
- expired
- revoked
No

Occupation

Name Type Description Required
code string Occupation code.
Supported:
- 010: Homemaker (full - time)
- 020: Retired (full - time)
- 030: Unemployed
- 040: Student (full - time)
- AA4: Farm/Ranch Owner
- AA8: Laborer/Worker
- AAE: Supervisor/Manager
- AAG: Inspector/Quality Control
- AAZ: Other - Agriculture/Forestry/Fishing
- ABA: Editor
- ABL: Artist/Writer
- ABM: Composer/Director/Producer
- ABN: Designer/Photographer
- ABP: Performer
- ABQ: Supervisor/Manager
- ABZ: Other - Art/Design/Media
- AC2: Analyst
- AC3: Appraiser - Real Estate
- AC5: Broker
- ACB: CSR/Teller
- ACL: Manager - Property
- ACS: Accountant
- ACT: Billing & Collections
- ACU: Finance/Insurance/Real Estate Rep
- ACV: Financial Advisor/Investor
- ACW: Loan Officer
- ACX: Sales/Purchasing Rep
- ACY: Supervisor/Manager
- ACZ: Other - Banking/Finance/Real Estate
- AD0: Account Executive
- AD1: Administrative Assistant
- AD3: Cashier/Checker
- AD5: Consultant
- AD6: Customer Service Representative
- ADR: Accountant/Auditor
- ADS: Agent/Broker
- ADV: Bookkeeper
- ADW: General Office Support
- ADX: Human Resource (HR) Specialist
- BD0: Manager - Executive/GM
- BD1: Manager - Other than Executive/GM
- BD2: Manufacturing Rep
- BD3: Marketing Specialist
- BD7: Receptionist
- BD8: Retail Salesperson
- BDA: Supervisor/Manager (Retail)
- BDB: Supervisor/Manager (Non - Retail)
- BDC: Vehicle/Equip Rental Rep
- BDZ: Other - Sales
- CDZ: Other - Business/Office
- AEA: Electrician/Linesman
- AEC: Machine/Equipment Operator
- AEG: HVAC Technician
- AEJ: Laborer/Worker
- AEQ: Plumber
- AEU: Field Service Technician
- AEV: Foreman/Manager/Inspector
- AEW: Maintenance/Custodian
- AEZ: Other - Construction/Energy/Mining
- AF4: Counselor
- AF7: Librarian/Curator
- AF8: Principal/Administrator
- AFD: Teacher, K - 12
- AFG: Assistant/Aide
- AFH: College Professor
- AFK: Teacher - Vocational
- AFZ: Other - Education/Library
- AG8: Engineer
- AGK: Technician
- AGL: Analyst - Engineering
- AGN: Architect/Drafter
- AGP: Scientist/Researcher
- AGQ: Supervisor/Manager
- AGZ: Other - Engineer/Architect
- AH1: Bartender
- AH4: Caterer
- AH5: Chef
- AH9: Cook/Worker - Fast Food
- AHB: Desk Clerk
- AHC: Dishwasher
- AHF: Housekeeper/Maid
- AHL: Food Preparer/Server
- AHM: Supervisor/Manager - Food Service
- AHR: Other - Hotel Services
- AHS: Other - Food Services
- AJ9: Military - Enlisted (E1 - E4)
- AJF: Military - Warrant Officer (W1 - W5)
- AJM: US Postal Worker
- AJN: Auditor/Analyst/Examiner
- AJP: Military - Officer (E5 - O10)
- AJQ: Supervisor/Manager
- AJZ: Other - Government/Military
- AK1: Analyst
- AK3: Director/Administrator
- AKA: Computer Programmer
- AKH: Supervisor/Manager
- AKJ: Technician
- AKZ: Other - Information Technology
- AL4: Agent/Broker
- AL7: Claims Adjuster/Investigator
- ALJ: Supervisor/Manager
- ALK: Underwriter/Actuary
- ALZ: Other - Insurance
- AM4: Correctional or Probation Officer
- AMG: Legal Support Staff
- AMN: Security Guard
- AMQ: Lawyer/Judge/Mediator
- AMR: Fire Fighter
- AMS: Police/Highway Patrol/Sheriff
- AMT: Detective/Investigator
- AMU: Supervisor/Manager
- AMZ: Other - Legal/Law Enf/Security
- AN2: Chiropractor
- AN3: Clergy
- ANE: Licensed Nurse (LPN)
- ANF: Registered Nurse (RN)
- ANK: Paramedic/E.M.T.
- ANL: Pharmacist
- ANQ: Social Worker
- ANU: Veterinarian
- ANV: Aide/Attendant
- ANW: Assistant/Technician/Therapist
- ANY: Dentist/Orthodontist
- BN0: Doctor/Surgeon
- BN1: Psychologist/Therapist
- BNZ: Other - Medical/Social Services/Religion
- AP0: Child or Elderly Care Provider
- AP1: Dry Cleaning/Laundry Servicer
- AP2: Hair/Personal Care Provider
- AP3: Cleaner/Housekeeper
- AP7: Pet Service Provider
- APZ: Other - Personal Care/Service
- AQ7: Machine Operator
- AQJ: Assembler/Fabricator
- AQK: Inspector/Quality Control
- AQP: Supervisor/Manager
- AQZ: Other - Production/Manufacturing
- AR1: Custodian/Janitor
- AR7: Landscape/Grounds Maintenance
- ARA: Laborer/Helper
- ARB: Repair/Mechanic
- ARZ: Other - Repair/Maintenance/Grounds
- AS3: Athlete
- ASJ: Admin/Activity Assistant
- ASK: Fitness Trainer/Instructor
- ASL: Supervisor/Manager
- ASZ: Other - Sports/Recreation
- ATQ: Driver (All Vehicles)
- ATR: Packer/Mover
- ATS: Supervisor/Manager
- ATZ: Other - Travel/Transportation/Storage
- XXX: Unknown
Yes
description string Occupation description.
Example: "homemaker"
No

ErrorMessageResponse

Name Type Description Required
message string A human-readable message providing more details about the error.
Example: "Forbidden"
Yes

ErrorResponse

Name Type Description Required
error_code string A unique code representing the specific error type.
Supported:
- invalid_request
- state_not_supported
- eligible_vehicle_not_found
- server_error
Yes
message string A human-readable message providing more details about the error.
Example: "The request is invalid."
Yes
status string Indicates the status of the error response. It will be always 'error'.
Example: "error"
Yes

Incident

Name Type Description Required
code string The incident code representing the type of incident.
Supported:
- AAF: At Fault Accident
- BOT: Open Bottle
- CMP: Comprehensive Claim greater than $1000
- CMU: Comprehensive Claim less than or equal to $1000
- CRD: Careless or Improper Operation
- DEQ: Defective Equipment
- DEV: Traffic Device/Sign
- DR: Drag Racing
- DWI: Drive Under Influence
- FRA: Failure to Report Accident
- FEL: Auto Theft/Felony Motor Vehicle
- FLE: Fleeing from Police
- FAR: False Reporting or Perjury
- FTC: Following Too Close
- FTY: Failure to Yield
- HOM: Vehicular Homicide
- IBK: Improper Backing
- IP: Improper or Illegal Passing
- IT: Improper Turn
- LDL: Operating Without Owner's Consent
- LIC: License/Credentials Violation
- LTS: Leaving the Scene
- MMV: Minor Moving Violation
- NAF: Not At Fault Accident
- REF: Refusal to Test
- RKD: Reckless Driving
- SAF: Safety Violation
- SCH: Passing of a School Bus
- SLV: Serious License Violation
- SPD: Speeding
- SUS: Driving Under Suspension
- WSR: Wrong Way on a One Way Street
Yes
incident_date string The date of the incident in supported formats: YYYY, YYYY-MM, YYYY-MM-DD
Example: "2023-05-15"
No
is_at_fault boolean Indicates whether the driver was at fault in the incident.
Example: true
No

InputIssue

Name Type Description Required
path string The path of the input issue.
Example: application.coverage.policy_coverage.bi
No
severity string The severity of the input issue.
Supported:
- error: Error Issue
- warning: Warning Issue
No
type string The type of the input issue.
Supported:
- invalid_format: Invalid Format
- unsupported_limit: Unsupported Limit
- rule_violation: Rule Violation
No
message string A human-readable message providing more details about the input issue.
Example: BI value '30/40' is unsupported and is changed to the closest supported value '25/50'.
No
original_value string The original value from the user input.
Example: 30/40
No
resolved_value string The finally resolved value.
Example: 25/50
No

LeadRequest

Request details for submitting a lead

Name Type Description Required
application Application Contains details about the lead application, including information about the applicant and relevant coverage options. Yes
channel Channel The channel through which the lead request is submitted. Yes
tracking Tracking Captures attribution, click identity, and session context. No
pricing Pricing Provides monetization context for analytics, auction logic, and billing. No
compliance Compliance Ensures legal defensibility for leads containing consumer PII. No

LeadSuccessResponse

Name Type Description Required
status string Indicates the success status of the lead request. It will be always "success". Yes
message string A message providing additional information about the lead response. No
transaction_id string Unique identifier for the transaction. Yes
ubi Ubi The details of Usage Based Insurance product. No
bridge_urls BridgeUrls Redirect Urls. Yes
input_issues [ InputIssue ] Input issues of the request. No

Location

Name Type Description Required
address_line_1 string The first line of the street address.
Example: "123 Main St"
No
address_line_2 string The second line of the street address (e.g., apartment, suite number).
Example: "Apt 4B"
No
city string The city of the address.
Example: "Phoenix"
No
country string The country of the address.
Example: "USA"
No
state string The state or province of the address.
Example: "AZ"
Yes
zip string The postal code or ZIP code of the address.
Example: "85001"
Yes

Name

The name information of the driver.

Name Type Description Required
first_name string The first name of the driver.
Example: "John"
Yes
last_name string The last name or surname of the driver.
Example: "Doe"
Yes
middle_name string The middle name of the driver, if available.
Example: "Michael"
No
suffix string Any suffix that follows the driver's name, such as Jr. or Sr.
Example: "Jr."
No

PolicyCoverageInput

Requested policy coverage

Name Type Description Required
bi string Bodily injury.
Supported:
- 25/50
- 50/100
- 100/300
"25/50" means $25,000 Per Person/$50,000 Per Accident, and so on.
No
med string Medical payments.
Supported:
- declined
- 500_per_person
- 1000_per_person
- 2000_per_person
- 2500_per_person
- 5000_per_person
"500_per_person" means $500 Per Person, and so on.
No
pd string Property damage.
Supported:
- 15
- 20
- 25
- 50
- 100
"15" means $15,000, and so on.
No
uim string Underinsured motorist bodily injury.
Supported:
- declined
- 25/50
- 50/100
- 100/300
"25/50" means $25,000 Per Person/$50,000 Per Accident, and so on.
No
um string Uninsured motorist bodily injury.
Supported:
- declined
- 25/50
- 50/100
- 100/300
"25/50" means $25,000 Per Person/$50,000 Per Accident, and so on.
No
umpd string Uninsured motorist property damage.
Supported:
- declined
- 10
- 25
- 50
- 100
- 25_with_200_ded
- 25_with_250_ded
- 50_with_200_ded
- 50_with_250_ded
- 100_with_200_ded
"10" means $10,000, and "25_with_200_ded" means $25,000 with $200 Deductible, and so on.
No

PolicyCoverageItem

Individual policy coverage item returned in quote responses

Name Type Description Required
coverage_code string Coverage code.
Supported:
- bi
- med
- pd
- um
- uim
- um_uim
- umbi
- umpd
No
value string Coverage value.
Example: "25/50"
No
coverage_description string Coverage description.
Example: "Bodily Injury"
No
value_type string Coverage value type.
Supported:
- limit
- deductible
No
value_description string Coverage value description.
Example: "$25,000 Per Person / $50,000 Per Accident"
No
premium number The premium for this specific coverage.
Example: 453
No

PremiumSummary

Name Type Description Required
initial_premium number Initial premium amount due at policy inception. Yes
monthly_premium number The amount due each month for the policy when using a monthly payment plan. Yes
paid_in_full_premium number Total premium if paid in full at the start of the policy. Yes
policy_term number Duration of the policy term in months.
Example: 6
Yes
total_premium number Total premium amount for the policy. Yes

Pricing

Provides monetization context for analytics, auction logic, and billing.

Name Type Description Required
lead_price number (decimal) The amount Novo paid for the lead, in units of currency. No
bid_price number (decimal) If real-time bidding (RTB) is used, this is the price Novo bid for the lead. No
currency string (ISO 4217) Currency code for pricing values.
Example: USD, CAD Default: USD
No
pricing_model string Defines how the lead is priced.
Supported:
- cpl: Cost Per Lead - This Novo pays when a valid lead is submitted.
- cpa: Cost Per Acquisition - Novo pays when a user converts into a customer (e.g., policy sold).
- rtb: Real-Time Bidding - Novo bids on each lead opportunity and pays only if it wins.
- revshare: Revenue Share - Novo pays a percentage of the revenue generated from the lead.
- cpc: Cost Per Click - Novo pays for the initial click, regardless of lead submission.
No
pricing_source string Name of the system or marketplace that defined the price.
Example: Becon, MediaAlpha
No

PriorInsurance

Name Type Description Required
bi_coverage string Bodily injury coverage limits, formatted as 'XX/YY', where XX is the limit per person and YY is the limit per accident.
Example: "25/50"
No
carrier string The name of the insurance carrier.
Example: "Acme Insurance Co."
No
effective_date string The date when the prior insurance became effective in supported formats: YYYY, YYYY-MM, YYYY-MM-DD
Example: "2022-01-01"
No
expiration_date string The date when the prior insurance expired in supported formats: YYYY, YYYY-MM, YYYY-MM-DD.
Example: "2022-12-31"
No

Quote

Name Type Description Required
quote_number string The quote number.
Example: "KBNPA9GB4Y89V4G"
Yes
premium_summary PremiumSummary Summary of the premium associated with the quote. Yes

QuoteRequest

Request details for submitting a quote

Name Type Description Required
application Application Contains details about the quote application, including information about the applicant and relevant coverage options. Yes
channel Channel The channel through which the quote request is submitted. Yes
tracking Tracking Captures attribution, click identity, and session context. No
pricing Pricing Provides monetization context for analytics, auction logic, and billing. No
compliance Compliance Ensures legal defensibility for leads containing consumer PII. No

QuoteSuccessResponse

Name Type Description Required
status string Indicates the success status of the quote request. It will be always "success". Yes
message string A message providing additional information about the quote response. No
transaction_id string Unique identifier for the transaction. Yes
ubi Ubi The details of Usage Based Insurance product. No
quote Quote Details of a quote. Yes
bridge_urls BridgeUrls Redirect Urls. Yes
coverage CoverageResponse Coverage details for the quote. Yes
input_issues [ InputIssue ] Input issues of the request. No

Residence

Name Type Description Required
length_in_months number The length of time the individual has lived at the residence, in months.
Example: 12
No
type string The type of residence.
Supported:
- own_home
- own_manufactured_or_mobile_home
- rent
- other
No

StudentProfile

Name Type Description Required
is_distant_student boolean Indicates whether the student qualifies as a distant student. No
is_good_student boolean Indicates whether the student is considered a good student based on performance metrics. No

Tracking

Captures attribution, click identity, and session context.

Name Type Description Required
click_id string Unique identifier representing the user's click on an ad or link; used for attribution and quote-lead matching. No
integration_click_id string Unique identifier generated by the integration platform to identify a user's click on an ad or link. No
channel_lead_id string Unique identifier for the lead within the specified channel. No
universal_lead_id string Cross-platform lead ID used to de-duplicate or trace leads across networks. No
traffic_source string Origin of the traffic. Equivalent to utm_source.
Example: google, facebook, MediaAlpha
No
traffic_medium string Traffic medium, one of the following values:
- paid_search: Traffic from paid search engine advertising (e.g., Google Ads, Bing Ads) using CPC or PPC bidding models.
- paid_social: Traffic from paid ads on social media platforms such as Facebook, Instagram, TikTok, or LinkedIn.
- affiliate: Traffic from affiliates or marketplace partners who promote your offer, typically on a CPL or CPA model.
- native: Traffic from native advertising placements that mimic editorial content, typically through platforms like Taboola or Outbrain.
- display: Banner or image ads placed on websites via direct buys or programmatic networks like Google Display Network (GDN).
- email: Traffic from promotional or lifecycle email campaigns that include tracked call-to-action links.
- retargeting: Traffic generated from ads shown to users who previously interacted with your brand or visited your website.
- organic: Unpaid traffic from SEO (organic search), social shares, or direct site visits.
- internal: Traffic from your own properties or internal cross-promotions (e.g., user portal or owned microsites).
- other: Fallback value for traffic sources that don't fit any defined category or are not attributed properly.
No
campaign_id string Advertiser-defined campaign ID used to group traffic by marketing objective or targeting. No
campaign_name string Human-readable name of the marketing campaign, useful for reporting and A/B testing. No
creative_id string Identifier of the specific ad creative shown to the user (e.g., image or message variation). No
source_id string ID of the traffic supplier or affiliate in the marketplace or ad platform. Used for partner billing and fraud control. No
submission_url string The URL where the user submitted the quote or lead request. No
consumer_source_ip string IP address of the consumer at the time of submission; used for fraud checks, geo attribution, and compliance. No
user_agent string Browser or device information string sent by the client; used for fraud analysis or mobile optimization. No

Ubi

Name Type Description Required
participation_option string Participation option of the policy
Supported:
- monthly_adjust: Novo Flex. Premium adjusts monthly based on driving behavior
- term_adjust: Novo Next. Premium adjusts once per policy term, at renewal, based on driving behavior
- data_share_only: Novo Classic. Customer shares driving data and qualifies for NovoNav discount, but premium is not dependent on the driving behavior
No

Vehicle

Name Type Description Required
is_ride_sharing boolean Indicates whether the vehicle is used for ride-sharing services.
Example: false
No
make string The manufacturer of the vehicle.
Example: "Honda"
Yes
model string The specific model of the vehicle.
Example: "Accord"
Yes
ownership VehicleOwnership The ownership status of the vehicle. No
usage VehicleUsage The intended usage of the vehicle. No
vin string The Vehicle Identification Number (VIN) which is a unique identifier for the vehicle.
Example: "1C6SRFFT6KN855186"
No
year number The year the vehicle was manufactured.
Example: 2020
Yes

VehicleCoverageInput

Requested vehicle coverage

Name Type Description Required
acpe number Amount for additional custom parts or equipment coverage.
Example: 100
100 means $100.
No
coll string Collision deductible.
Supported:
- declined
- 250_ded
- 500_ded
- 750_ded
- 1000_ded
- 1500_ded"250_ded" means a $250 deductible, and so on.
No
comp string Comprehensive deductible.
Supported:
- declined
- 250_ded
- 500_ded
- 750_ded
- 1000_ded
- 1500_ded
"250_ded" means a $250 deductible, and so on.
No
full_glass boolean Indicates whether glass deductible waiver coverage is included.
Example: true
No
loan_payoff boolean Indicates whether loan payoff coverage is included.
Example: false
No
rent string Car rental.
Supported:
- declined
- 40_per_day_1200_max
- 50_per_day_1500_max
- 60_per_day_1800_max
"40_per_day_1200_max" means $40 Per Day $1,200 Maximum, and so on.
No
tow boolean Indicates whether towing coverage is included.
Example: true
No
umpd string Uninsured motorist property damage.
Supported:
- declined
- 10
- 25
- 50
- 100
- 25_with_200_ded
- 25_with_250_ded
- 50_with_200_ded
- 50_with_250_ded
- 100_with_200_ded
"10" means $10,000, and "25_with_200_ded" means $25,000 with $200 Deductible, and so on.
No

VehicleCoverageItem

Individual vehicle coverage item returned in quote responses

Name Type Description Required
coverage_code string Coverage code.
Supported:
- acpe
- rent
- coll
- comp
- loan_payoff
- tow
- umpd
- full_glass
No
value string Coverage value.
Example: "500"
No
coverage_description string Coverage description.
Example: "Collision"
No
value_type string Coverage value type.
Supported:
- limit
- deductible
No
value_description string Coverage value description.
Example: "$500 Deductible"
No
premium number The premium for this specific coverage.
Example: 94
No

VehicleCoverageResponse

Vehicle coverage details returned in quote responses

Name Type Description Required
vin string The Vehicle Identification Number (VIN) which is a unique identifier for the vehicle.
Example: "1C6SRFFT6KN855186"
No
coverages [ VehicleCoverageItem ] Coverage details that apply at the vehicle level Yes

VehicleOwnership

The ownership status of the vehicle.

Name Type Description Required
length_in_months number Ownership length in months.
Example: 24
No
type string The type of ownership of the vehicle.
Supported:
- own
- financed
- lease
No

VehicleUsage

The intended usage of the vehicle.

Name Type Description Required
annual_mileage number The estimated annual mileage of the vehicle.
Example: 12000
No
primary_use string The primary purpose for which the vehicle is used.
Supported:
- commute
- pleasure
- business
- delivery
- farm
No