Technical Reference

📄 Auto Insurance Webhook (Technical Reference)

This page provides a detailed field-by-field breakdown of the Auto Insurance Webhook payload.

---

Root Object

The webhook payload is a JSON object with the following top-level keys:

• document_link

• policy

• drivers

• vehicles

• discounts

• exclusions

• group_plan

• surcharges

• endorsements

• policyholder

• prior_carrier

• additional_info

• available_options

• important_notices

• additional_insured

• billing_information

• insurer_information

• important_policy_info

• forms_and_endorsements

---

Policy Object

Field	Type	Description	Example
provider	string	Insurance company name	"TRAVELERS PROPERTY CASUALTY INSURANCE COMPANY"
policy_number	string	Unique identifier of the policy	"607695134 203 1"
policy_type	string	Type of insurance policy	"Auto"
policy_term	string	Duration of policy coverage	"12 months"
coverage_period.start_date	string (date)	Policy effective date	"2021-10-16"
coverage_period.end_date	string (date)	Policy expiration date	"2022-10-16"
annual_policy_premium	number	Total premium for the policy term	1007
policy_change_history	array	List of changes with premium impact	[{"change_date": "2022-04-26", "premium_impact": -543}]

---

Drivers Array

Field	Type	Description	Example
name	string	Driver’s full name	"CECILY"
date_of_birth	string (date)	Driver’s date of birth	"1958-06-12"
relationship_to_policyholder	string	Relationship to policyholder	"Self"

---

Vehicles Array

Field	Type	Description	Example
vin	string	Vehicle Identification Number	"YV4952DL2E2549538"
make	string	Vehicle make	"VOLVO"
model	string	Vehicle model	"XC60 3.2"
year	number	Year of manufacture	2014
usage	string	Vehicle usage category	"Pleasure"
coverages	array	List of coverages with limits, premiums, and deductibles	see below

Coverage Object

Field	Type	Description	Example
type	string	Type of coverage	"Bodily Injury"
limits	string	Coverage limits	"250000/500000"
premium	number	Premium for this coverage	471
deductible	number	Deductible amount	0

---

Discounts Array

Field	Type	Description	Example
type	string	Discount type	"Safe Driver Discount"
description	string	Explanation of discount	"5 Years Accident and Violation Free"

---

Policyholder Object

Field	Type	Description	Example
name	string	Policyholder’s full name	"CECILY SAPP CARTER SAPP"
address.street	string	Street address	"4286 CABRETTA DR SE"
address.city	string	City	"SMYRNA"
address.state	string	State code	"GA"
address.zip	string	ZIP code	"30080-6479"

---

Insurer Information Object

Field	Type	Description	Example
company_name	string	Name of the insurer	"TRAVELERS PROPERTY CASUALTY INSURANCE COMPANY"
claims_phone	string	Claims reporting number	"1.800.252.4633"
service_phone	string	Customer service number	"1.800.842.5075"
company_address	object	Company headquarters address	{ "street": "ONE TOWER SQUARE", "city": "HARTFORD", "state": "CT", "zip": "06183" }

---

Sample Payload

auto_webhook_payload.json

11KB

Open