View the comprehensive reference information for insurance data responses.
Attributes
The information in the table below covers the values for insurance report responses.
Attribute | Type | Description |
---|---|---|
id | string | Unique identifier |
status | string | Status from Connection Lifecycle |
finished_at | string | Time report was finished |
access_token | string | Access token for Link to payroll provider |
tracking_info | string | Information passed to Truv Bridge from partner |
insurance | object | List of insurances, see Insurance object |
provider | string | Insurance Provider ID |
identity | object | Person's identity information |
pdf_report | uri | Insurance report in PDF format |
Insurance object
These values are for the insurance object field.
Attribute | Type | Description |
---|---|---|
policies | object | List of policies |
drivers | object | List of drivers |
addresses | object | List of addresses |
driving_records | object | List of driving records |
agents | object | List of agents |
Policies object
View the policies object values in the table below.
Attribute | Type | Description |
---|---|---|
id | string | Policy ID |
policy_type | string | Type of policyAUTO BOAT CONDO FARMOWNER FLOOD HOMEOWNERS LANDLORD LIFE MOTORCYCLETERM_LIFE UNIVERSAL_LIFE WHOLE_LIFE RENTERS SNOWMOBILE UMBRELLARECREATIONAL_VEHICLE FIRE TRAILER PERSONAL_ARTICLES EARTHQUAKEBUSINESS_OWNERS COMMERCIAL_UMBRELLA COMMERCIAL_AUTO COMMERCIAL_FIRECOMBO OFFROAD_VEHICLE WORKERS_COMPENSATION MOBILE_HOME PETPERSONAL_LIABILITY GENERAL_LIABILITY ERRORS_AND_OMISSIONS INLAND_MARINEGARAGE EXCESS_LIABILITY CYBER IDENTITY_THEFT NAMED_NON_OWNERCLASSIC_CAR |
name | string | Human-friendly name |
description | string | Human-friendly description |
carrier_policy_number | string | Carrier policy number |
effective_date | date-time | Policy effective date |
expiry_date | date-time | Policy expiration date |
renewal_date | date-time | Policy renewal date |
canceled_date | date-time | Policy canceled date |
total_premium_cents | integer | Total policy premium in cents |
deductible_cents | integer | Commercial policy deductible in cents |
carrier_name | string | Insurance carrier name |
status | string | Policy statusACTIVE CANCELLED EXPIRED UNVERIFIED PENDING_ACTIVATION PENDING_CANCELLATION |
paid_in_full | Boolean | Status of policy fully paid |
dwellings | array of objects | List of dwellings, see Dwellings object |
vehicles | array of objects | List of vehicles, see Vehicles object |
commercial_named_insureds | array of objects | List of commercial named insureds, see Commercial named insureds object |
named_insureds | array of objects | List of named insureds, see Named insureds object |
claims | array of objects | List of claims, see Claims object |
loss_events | array of objects | List of loss events, see Loss events object |
documents | array of objects | List of documents, see Documents object |
Dwellings object
The values in this table are for the dwellings object.
Attribute | Type | Description |
---|---|---|
id | string | Dwelling ID |
address | object | Address object |
replacement_cost_cents | integer | Replacement cost in cents |
cash_value_cents | integer | Cash value in cents |
coverages | array of objects | List of dwelling coverages, see Dwellings coverages object |
mortgagees | array of objects | List of mortgagee objects, see Mortgagees object |
Dwellings coverages object
Find the information for the dwellings coverages object below.
Attribute | Type | Description |
---|---|---|
id | string | Dwelling coverage ID |
name | string | Name of coverage itemBASE DWELLING OTHER_STRUCTURE PERSONAL_PROPERTY BUSINESS_PROPERTY LOSS_OF_USE LOSS_ASSESSMENTS PERSONAL_LIABILITY PREMISES_LIABILITY REPLACEMENT_COST_FULL_VALUE REPLACEMENT_COST_DWELLING REPLACEMENT_COST_CONTENTS GUEST_MEDICAL_PROTECTION DAMAGE_TO_PROPERTY_OF_OTHERS MEDICAL_PAYMENTS ADDITIONAL_LIVING_EXPENSE FAMILY_LIABILITY_PROTECTION BUILDING_CODES WINDSTORM_OR_HAIL HURRICANE ALL_OTHER_PERILS ALL_PERILS EARTHQUAKE PORTABLE_ELECTRONICS FASHION_ITEMS FINE_ART BICYCLE CAMERA JEWELRY MUSICAL_INSTRUMENT BUILDINGCONTENTS ICC |
premium_cents | integer | Premium paid for coverage item, in cents |
per_person_limit_cents | integer | Per-person limit, in cents |
per_incident_limit_cents | integer | Per-incident limit, in cents |
deductible_cents | integer | Deductible, in cents |
is_declined | Boolean | Status of coverage item |
Dwellings mortgagees object
The mortgagees object values for dwellings are in the table below.
Attribute | Type | Description |
---|---|---|
id | string | ID of mortgagee |
name | string | Name of mortgagee |
type | string | Type of mortgageeFIRST SECOND THIRD |
loan_number | string | Mortgage loan number |
address | object | Address object |
Vehicles object
View the information for the vehicles object below.
Attribute | Type | Description |
---|---|---|
id | string | Vehicle ID |
year | integer | Year |
make | string | Manufacturer |
model | string | Model |
series | string | Series |
series2 | string | Series 2 |
type | string | Vehicle type |
annual_mileage | integer | Annual mileage |
vin | string | Vehicle identification number |
purchase_date | date-time | Purchase date |
is_removed | Boolean | Status of vehicle policy |
lien_holder | string | Vehicle lien holder name |
garaging_address | object | Address object |
lien_holder_address | object | Address object |
coverages | array of objects | List of vehicle coverages, see Vehicles coverages object |
Vehicles coverages object
The values in the table below are for the vehicle coverages object.
Attribute | Type | Description |
---|---|---|
id | string | Vehicle coverage ID |
name | string | Name of coverage itemSINGLE_LIMIT_LIABILITY BODILY_INJURY_LIABILITY PROPERTY_DAMAGE_LIABILITY SUPPLEMENTAL_SPOUSAL_LIABILITY PERSONAL_INJURY_PROTECTION COMPREHENSIVE FULL_GLASS COLLISION_DEDUCTIBLE_WAIVER COLLISION UNINSURED_MOTORISTS UNINSURED_MOTORIST_BODILY_INJURY_LIABILITY UNINSURED_MOTORIST_PROPERTY_DAMAGE_LIABILITY UNINSURED_MOTORIST_BODILY_INJURY_AND_PROPERTY_DAMAGE_LIABILITY UNDERINSURED_MOTORISTS UNDERINSURED_MOTORIST_BODILY_INJURY_LIABILITY UNDERINSURED_MOTORIST_PROPERTY_DAMAGE_LIABILITY UNDERINSURED_MOTORIST_BODILY_INJURY_AND_PROPERTY_DAMAGE_LIABILITY UNINSURED_AND_UNDERINSURED_MOTORISTS UNINSURED_AND_UNDERINSURED_MOTORIST_BODILY_INJURY_LIABILITY UNINSURED_AND_UNDERINSURED_MOTORIST_PROPERTY_DAMAGE_LIABILITY UNINSURED_AND_UNDERINSURED_MOTORIST_BODILY_INJURY_AND_PROPERTY_DAMAGE_LIABILITY TOWING_AND_LABOR LOAN_OR_LEASE_ASSISTANCE RIDESHARE_GAP_PROTECTION MEDICAL_PAYMENTS ADDITIONAL_LIVING_EXPENSE FAMILY_LIABILITY_PROTECTION BUILDING_CODES EMERGENCY_ROAD_SERVICE RENTAL_REIMBURSEMENT CAR_RENTAL_AND_TRAVEL_EXPENSES MECHANICAL_BREAKDOWN SUPPLEMENTAL_UNINSURED_AND_UNDERINSURED_MOTORISTS EMERGENCY_EXPENSE REPLACEMENT_COST_PERSONAL_EFFECTS VACATION_LIABILITY_COVERAGE RV_MEDICAL EXTENDED_BENEFITS WAGE_EARNER_DISABILITY_BENEFITS ESSENTIAL_SERVICES_DISABILITY_BENEFITS DEATH_BENEFIT CAR_REPLACEMENT_ASSISTANCE FULL_TORT LIMITED_TORT COMBINED_SINGLE_LIMIT |
per_day_limit_cents | integer | Per-day limit, in cents |
per_mile_premium_tenth_of_cents | integer | Premium per mile, in tenth of cents |
premium_cents | integer | Premium paid for coverage item, in cents |
per_person_cents | integer | Per-person limit, in cents |
per_incident_limit_cents | integer | Per-incident limit, in cents |
deductible_cents | integer | Deductible, in cents |
is_declined | Boolean | Status of coverage item |
Vehicles drivers object
The values below are for the vehicle drivers object.
Attribute | Type | Description |
---|---|---|
id | string | Driver ID |
first_name | string | First name |
middle_name | string | Middle name |
last_name | string | Last name |
drivers_license | string | License number |
drivers_license_state | string | Driver license state |
date_of_birth_str | string | Date of birth |
gender | string | GenderMALE FEMALE NONBINARY |
marital_status | string | Marital statusSINGLE MARRIED DIVORCED WIDOWED SEPARATED CIVIL_UNION |
relationship_to_insured | string | Relationship to the insuredINSURED SPOUSE BROTHER SISTER FATHER MOTHER DAUGHTER SON |
is_excluded | Boolean | Status of driver from the policy or vehicle |
Commercial named insureds object
Use the table below for information about the commercial named insureds object.
Attribute | Type | Description |
---|---|---|
id | string | Commercial named insured ID |
name | string | Name of insured |
form_of_business | string | Form of businessINDIVIDUAL PARTNERSHIP LIMITED_LIABILITY_COMPANY S_CORPORATION CORPORATION JOINT_VENTURE NOT_FOR_PROFIT_ORGANIZATION TRUST |
gl_code | string | General liability class code |
sic_code | string | Standard industrial classification code |
naics_code | string | North American Industry Classification System code |
fein | string | Federal Employer Identification number |
ssn | string | Social Security Number |
is_primary | Boolean | Status of insured as primary |
address | object | Address object |
Named insureds object
The values in this table are for the named insureds object.
Attribute | Type | Description |
---|---|---|
id | string | Named insured ID |
first_name | string | First name |
middle_name | string | Middle name |
last_name | string | Last name |
full_name | string | Full name |
is_primary | Boolean | Status of insured as primary |
Claims object
The claims object values are in the table below.
Attribute | Type | Description |
---|---|---|
id | string | Claim ID |
dwelling_id | string | Dwelling ID |
vehicle_id | string | Vehicle ID |
driver_id | string | Driver ID |
carrier_claim_identifier | string | Carrier claim identifier |
date_occurred | date-time | Date claim occurred |
type | string | Claim typeWIND_AND_HAIL_DAMAGE WATER_DAMAGE_AND_FREEZING FIRE_AND_LIGHTNING_DAMAGE OTHER_PROPERTY_DAMAGE PERSONAL_LIABILITY POWER_OUTAGE_OR_SURGE THEFT CAR_ACCIDENT WINDSHIELD_DAMAGE ANIMAL_COLLISION VANDALISM WEATHER EMERGENCY_ROADSIDE_ASSISTANCE MEDICAL HURRICANE_DAMAGE SEWAGE_BACKUP |
status | string | StatusOPEN CLOSED |
date_closed | date-time | Date claim was closed |
payout_cents | integer | Payout in cents |
representative_name | string | Representative name |
representative_phone | string | Representative phone number |
representative_email | string | Representative email address |
address | object | Address object |
Loss events object
Use the table below for information about the loss events object.
Attribute | Type | Description |
---|---|---|
id | string | Loss event ID |
date_of_occurrence | date-time | Date loss event occurred |
date_of_claim | date-time | Date of claim |
type | string | Loss event typeBURGLARY_AND_THEFT WATER_DAMAGE_AND_FREEZING_DAMAGE WIND_AND_HAIL_DAMAGE FIRE CUSTOMER_SLIPS_AND_FALLS CUSTOMER_INJURY_AND_DAMAGE PRODUCT_LIABILITY STRUCK_BY_AN_OBJECT REPUTATIONAL_HARM VEHICULAR_ACCIDENT WINDSHIELD_DAMAGE |
amount_paid_cents | integer | Amount paid in cents |
amount_reserved_cents | integer | Amount reserved in cents |
is_subrogation | Boolean | Status of subrogation |
is_claim_open | Boolean | Status of claim |
Documents object
The documents object values are in the table below.
Attribute | Type | Description |
---|---|---|
id | string | Document ID |
title | string | Document title |
document_type | string | Document typeINSURANCE_APPLICATION INSURANCE_BINDER DECLARATIONS ENDORSEMENT INSURANCE_ID_CARD VERIFICATION_OF_INSURANCE |
date_added | date-time | Document effective date |
file | string | File URL |
Drivers object
This table is a reference for the drivers object.
Attribute | Type | Description |
---|---|---|
id | string | Driver ID |
first_name | string | First name |
middle_name | string | Middle name |
last_name | string | Last name |
drivers_license | string | License number |
drivers_license_state | string | Driver license state |
date_of_birth_str | string | Date of birth |
gender | string | GenderMALE FEMALE NONBINARY |
marital_status | string | Marital statusSINGLE MARRIED DIVORCED WIDOWED SEPARATED CIVIL_UNION |
relationship_to_insured | string | Relationship to the insuredINSURED SPOUSE BROTHER SISTER FATHER MOTHER DAUGHTER SON |
Addresses object
These values are for the address object.
Attribute | Type | Description |
---|---|---|
id | string | Address ID |
country | string | Country |
street | string | Street |
city | string | City |
state | string | State |
zip | string | Zip code |
Driving records object
The values below are within the driving records object.
Attribute | Type | Description |
---|---|---|
id | string | Driving record ID |
driver_id | string | Driver ID |
incident_date | date-time | Date incident occurred |
incident_type | string | Incident typeACCIDENT VIOLATION |
violation_type | string | The violation_type is only available if incident_type = VIOLATION MOVING SPEEDING RECKLESS_DRIVING DRIVING_WITHOUT_VALID_LICENSE HIT_AND_RUN DISTRACTED_DRIVING DRIVING_UNDER_INFLUENCE FAILURE_TO_YIELD TAILGATING OPEN_CONTAINER_OF_ALCOHOL |
is_at_fault | Boolean | Status of driver at fault |
Agents object
For information about the agents object, view the table and values below.
Attribute | Type | Description |
---|---|---|
id | string | Agent info record ID |
address_id | string | Address ID of agent or agency location |
agency_name | string | Name of agency, agency_name or agent_full_name required |
agent_full_name | string | Name of agent, agency_name or agent_full_name required |
phone_number | string | Phone number for the agent or agency |
string | Email for the agent or agency | |
policy_ids | array of strings | List of Policy IDs associated to agent |
Identity object
Use this table for values from the identity object.
Attribute | Type | Description |
---|---|---|
id | string | ID of object |
created_at | string | ISO 8601 value for first time retrieving person's identity info |
updated_at | string | ISO 8601 value for last time retrieving person's identity info |
first_name | string | First name |
last_name | string | Last name |
full_name | string | Full name |
middle_initials | string | Middle initials |
string | Email address | |
ssn | string | Social Security Number, full or last 4 digits |
date_of_birth | date | Date of birth |
home_address | object | Address object |
Endpoints
Use the endpoint below to collect information from insurance reports.
Example response
The sample below is a JSON response for the endpoint.
{
"id": "24d7e80942ce4ad58a93f70ce4115f5c",
"status": "new",
"finished_at": "2021-04-06T11:30:00Z",
"access_token": "48427a36d43c4d5aa6324bc06c692456",
"tracking_info": "user123456",
"insurance": {
"policies": [
{
"id": "53c5ce0d-fb79-4f1c-bc27-32181b368fc7",
"policy_type": "AUTO",
"name": "AUTO AU192837",
"description": "Effective 11/03/2021 - 11/03/2022",
"carrier_policy_number": "HO132654",
"effective_date": "2021-11-03T00:00:00Z",
"expiry_date": "2021-11-03T00:00:00Z",
"renewal_date": "2021-11-03T00:00:00Z",
"canceled_date": "2021-11-03T00:00:00Z",
"total_premium_cents": "150319",
"deductible_cents": 0,
"carrier_name": "progressive",
"status": "ACTIVE",
"paid_in_full": true,
"dwellings": [
{
"id": "b7a53a67-7266-42b6-a20e-97e8fc723bbc",
"address": {
"id": "a497f96b-94be-443e-88bb-c8289085c922",
"address_nature": "MAILING",
"country": "US",
"street": "344 Clinton St, Apartment 3D",
"city": "Brooklyn",
"state": "NY",
"zip": "11231"
},
"replacement_cost_cents": 2600,
"cash_value_cents": 2600,
"coverages": [
{
"id": "b9087b71-c1b1-482d-be9f-92a2cf81fbb3",
"name": "PERSONAL_PROPERTY",
"premium_cents": 18514,
"per_person_limit_cents": 0,
"per_incident_limit_cents": 0,
"deductible_cents": 50000,
"is_declined": true
}
],
"mortgagees": [
{
"id": "26a4ce3a-0b9f-4c3d-96c0-1c76529e3b52",
"name": "string",
"type": "FIRST",
"loan_number": "string",
"address": {
"id": "a497f96b-94be-443e-88bb-c8289085c922",
"address_nature": "MAILING",
"country": "US",
"street": "344 Clinton St, Apartment 3D",
"city": "Brooklyn",
"state": "NY",
"zip": "11231"
}
}
]
}
],
"vehicles": [
{
"id": "26a4ce3a-0b9f-4c3d-96c0-1c76529e3b52",
"year": 2010,
"make": "CHEVROLET",
"model": "Camaro",
"series": "ZL1",
"series2": "string",
"type": "PASSENGER CAR",
"annual_mileage": 26000,
"vin": "1G1FK1R62J0158884",
"purchase_date": "2010-10-02T12:00:00.000Z",
"is_removed": true,
"lien_holder": "Manhattan Bank",
"garaging_address": {
"id": "a497f96b-94be-443e-88bb-c8289085c922",
"address_nature": "MAILING",
"country": "US",
"street": "344 Clinton St, Apartment 3D",
"city": "Brooklyn",
"state": "NY",
"zip": "11231"
},
"lien_holder_address": {
"id": "a497f96b-94be-443e-88bb-c8289085c922",
"address_nature": "MAILING",
"country": "US",
"street": "344 Clinton St, Apartment 3D",
"city": "Brooklyn",
"state": "NY",
"zip": "11231"
},
"coverages": [
{
"id": "111da3f8-20b0-4839-81d7-6473437e493e",
"name": "PROPERTY_DAMAGE_LIABILITY",
"per_day_limit_cents": 0,
"per_mile_premium_tenth_of_cents": 0,
"premium_cents": 18514,
"per_person_limit_cents": 0,
"per_incident_limit_cents": 0,
"deductible_cents": 50000,
"is_declined": true
}
],
"drivers": [
{
"id": "8857f648-c6ce-44df-8fa4-78eee16e9bb4",
"first_name": "John",
"middle_name": "Joseph",
"last_name": "Doe",
"drivers_license": "SUP1234012",
"drivers_license_state": "DC",
"date_of_birth_str": "05/03/1988",
"gender": "MALE",
"marital_status": "SINGLE",
"relationship_to_insured": "INSURED",
"is_excluded": true
}
]
}
],
"commercial_named_insureds": [
{
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"name": "Sample Business LLC",
"form_of_business": "INDIVIDUAL",
"gl_code": "10010",
"sic_code": "6411",
"naics_code": "524210",
"fein": "123456789",
"ssn": "123456789",
"is_primary": true,
"address": {
"id": "a497f96b-94be-443e-88bb-c8289085c922",
"address_nature": "MAILING",
"country": "US",
"street": "344 Clinton St, Apartment 3D",
"city": "Brooklyn",
"state": "NY",
"zip": "11231"
}
}
],
"named_insureds": [
{
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"first_name": "string",
"middle_name": "string",
"last_name": "string",
"full_name": "string",
"is_primary": true
}
],
"claims": [
{
"id": "",
"dwelling_id": "",
"vehicle_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"driver_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"carrier_claim_identifier": "string",
"date_occurred": "2023-04-29T04:59:15.973Z",
"type": "WIND_AND_HAIL_DAMAGE",
"status": "OPEN",
"date_closed": "2022-05-03T00:00:00Z",
"payout_cents": 180111,
"representative_name": "string",
"representative_phone": "string",
"representative_email": "string",
"address": {
"id": "a497f96b-94be-443e-88bb-c8289085c922",
"address_nature": "MAILING",
"country": "US",
"street": "344 Clinton St, Apartment 3D",
"city": "Brooklyn",
"state": "NY",
"zip": "11231"
}
}
],
"loss_events": [
{
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"date_of_occurrence": "2022-05-03T00:00:00Z",
"date_of_claim": "2022-05-03T00:00:00Z",
"type": "BURGLARY_AND_THEFT",
"amount_paid_cents": 123323,
"amount_reserved_cents": 0,
"is_subrogation": true,
"is_claim_open": true
}
],
"documents": [
{
"id": "55ad7bb6-f5a3-4ebf-91fb-2802391eb261",
"title": "11-03-2021 - Auto - Automobile Policy Renewal Declarations",
"document_type": "INSURANCE_APPLICATION",
"date_added": "2022-05-03T00:00:00Z",
"file": "https://truv-statements.s3.amazonaws.com/insurance/example_file"
}
]
}
],
"drivers": [
{
"id": "8857f648-c6ce-44df-8fa4-78eee16e9bb4",
"first_name": "John",
"middle_name": "Joseph",
"last_name": "Doe",
"drivers_license": "SUP1234012",
"drivers_license_state": "DC",
"date_of_birth_str": "05/03/1988",
"gender": "MALE",
"marital_status": "SINGLE",
"relationship_to_insured": "INSURED"
}
],
"addresses": [
{
"id": "a497f96b-94be-443e-88bb-c8289085c922",
"address_nature": "MAILING",
"country": "US",
"street": "344 Clinton St, Apartment 3D",
"city": "Brooklyn",
"state": "NY",
"zip": "11231"
}
],
"driving_records": [
{
"id": "da9d46ad-8ddb-4b4b-bc7e-7a381a738f7d",
"driver_id": "da9d46ad-8ddb-4b4b-bc7e-7a381a738f7c",
"incident_date": "2021-04-23T00:00:00.000Z",
"incident_type": "ACCIDENT",
"violation_type": "MOVING",
"is_at_fault": true
}
],
"agents": [
{
"id": "da9d46ad-8ddb-4b4b-bc7e-7a381a738f7d",
"address_id": "da9d46ad-8ddb-4b4b-bc7e-7a381a738f7c",
"agency_name": "string",
"agent_full_name": "string",
"phone_number": "string",
"email": "string",
"policy_ids": [
"3fa85f64-5717-4562-b3fc-2c963f66afa6"
]
}
]
},
"provider": "progressive",
"identity": {
"id": "48427a36d43c4d5aa6324bc06c692456",
"created_at": "2022-06-07T15:00:00Z",
"updated_at": "2022-06-31T15:00:00Z",
"first_name": "John",
"last_name": "Doe",
"full_name": "John Doe",
"middle_initials": "K",
"email": "[email protected]",
"ssn": "123456789",
"date_of_birth": "1992-03-03",
"home_address": {
"street": "1 Morgan Ave",
"city": "Los Angeles",
"state": "CA",
"zip": "90210",
"country": "US"
}
},
"pdf_report": "https://citadelid-resources.s3-us-west-2.amazonaws.com/report.pdf"
}