Insurance Reports

View the comprehensive reference information for insurance data responses.

Attributes

The information in the table below covers the values for insurance report responses.

AttributeTypeDescription
idstringUnique identifier
statusstringStatus from Connection Lifecycle
finished_atstringTime report was finished
access_tokenstringAccess token for Link to payroll provider
tracking_infostringInformation passed to Truv Bridge from partner
insuranceobjectList of insurances, see Insurance object
providerstringInsurance Provider ID
identityobjectPerson's identity information
pdf_reporturiInsurance report in PDF format

Insurance object

These values are for the insurance object field.

AttributeTypeDescription
policiesobjectList of policies
driversobjectList of drivers
addressesobjectList of addresses
driving_recordsobjectList of driving records
agentsobjectList of agents

Policies object

View the policies object values in the table below.

AttributeTypeDescription
idstringPolicy ID
policy_typestringType of policy
AUTO 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
namestringHuman-friendly name
descriptionstringHuman-friendly description
carrier_policy_numberstringCarrier policy number
effective_datedate-timePolicy effective date
expiry_datedate-timePolicy expiration date
renewal_datedate-timePolicy renewal date
canceled_datedate-timePolicy canceled date
total_premium_centsintegerTotal policy premium in cents
deductible_centsintegerCommercial policy deductible in cents
carrier_namestringInsurance carrier name
statusstringPolicy status
ACTIVE CANCELLED EXPIRED UNVERIFIED PENDING_ACTIVATION PENDING_CANCELLATION
paid_in_fullBooleanStatus of policy fully paid
dwellingsarray of objectsList of dwellings, see Dwellings object
vehiclesarray of objectsList of vehicles, see Vehicles object
commercial_named_insuredsarray of objectsList of commercial named insureds, see Commercial named insureds object
named_insuredsarray of objectsList of named insureds, see Named insureds object
claimsarray of objectsList of claims, see Claims object
loss_eventsarray of objectsList of loss events, see Loss events object
documentsarray of objectsList of documents, see Documents object

Dwellings object

The values in this table are for the dwellings object.

AttributeTypeDescription
idstringDwelling ID
addressobjectAddress object
replacement_cost_centsintegerReplacement cost in cents
cash_value_centsintegerCash value in cents
coveragesarray of objectsList of dwelling coverages, see Dwellings coverages object
mortgageesarray of objectsList of mortgagee objects, see Mortgagees object
Dwellings coverages object

Find the information for the dwellings coverages object below.

AttributeTypeDescription
idstringDwelling coverage ID
namestringName of coverage item
BASE 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_centsintegerPremium paid for coverage item, in cents
per_person_limit_centsintegerPer-person limit, in cents
per_incident_limit_centsintegerPer-incident limit, in cents
deductible_centsintegerDeductible, in cents
is_declinedBooleanStatus of coverage item
Dwellings mortgagees object

The mortgagees object values for dwellings are in the table below.

AttributeTypeDescription
idstringID of mortgagee
namestringName of mortgagee
typestringType of mortgagee
FIRST SECOND THIRD
loan_numberstringMortgage loan number
addressobjectAddress object

Vehicles object

View the information for the vehicles object below.

AttributeTypeDescription
idstringVehicle ID
yearintegerYear
makestringManufacturer
modelstringModel
seriesstringSeries
series2stringSeries 2
typestringVehicle type
annual_mileageintegerAnnual mileage
vinstringVehicle identification number
purchase_datedate-timePurchase date
is_removedBooleanStatus of vehicle policy
lien_holderstringVehicle lien holder name
garaging_addressobjectAddress object
lien_holder_addressobjectAddress object
coveragesarray of objectsList of vehicle coverages, see Vehicles coverages object
Vehicles coverages object

The values in the table below are for the vehicle coverages object.

AttributeTypeDescription
idstringVehicle coverage ID
namestringName of coverage item
SINGLE_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_centsintegerPer-day limit, in cents
per_mile_premium_tenth_of_centsintegerPremium per mile, in tenth of cents
premium_centsintegerPremium paid for coverage item, in cents
per_person_centsintegerPer-person limit, in cents
per_incident_limit_centsintegerPer-incident limit, in cents
deductible_centsintegerDeductible, in cents
is_declinedBooleanStatus of coverage item
Vehicles drivers object

The values below are for the vehicle drivers object.

AttributeTypeDescription
idstringDriver ID
first_namestringFirst name
middle_namestringMiddle name
last_namestringLast name
drivers_licensestringLicense number
drivers_license_statestringDriver license state
date_of_birth_strstringDate of birth
genderstringGender
MALE FEMALE NONBINARY
marital_statusstringMarital status
SINGLE MARRIED DIVORCED WIDOWED SEPARATED CIVIL_UNION
relationship_to_insuredstringRelationship to the insured
INSURED SPOUSE BROTHER SISTER FATHER MOTHER DAUGHTER SON
is_excludedBooleanStatus of driver from the policy or vehicle

Commercial named insureds object

Use the table below for information about the commercial named insureds object.

AttributeTypeDescription
idstringCommercial named insured ID
namestringName of insured
form_of_businessstringForm of business
INDIVIDUAL PARTNERSHIP LIMITED_LIABILITY_COMPANY S_CORPORATION CORPORATION JOINT_VENTURE NOT_FOR_PROFIT_ORGANIZATION TRUST
gl_codestringGeneral liability class code
sic_codestringStandard industrial classification code
naics_codestringNorth American Industry Classification System code
feinstringFederal Employer Identification number
ssnstringSocial Security Number
is_primaryBooleanStatus of insured as primary
addressobjectAddress object

Named insureds object

The values in this table are for the named insureds object.

AttributeTypeDescription
idstringNamed insured ID
first_namestringFirst name
middle_namestringMiddle name
last_namestringLast name
full_namestringFull name
is_primaryBooleanStatus of insured as primary

Claims object

The claims object values are in the table below.

AttributeTypeDescription
idstringClaim ID
dwelling_idstringDwelling ID
vehicle_idstringVehicle ID
driver_idstringDriver ID
carrier_claim_identifierstringCarrier claim identifier
date_occurreddate-timeDate claim occurred
typestringClaim type
WIND_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
statusstringStatus
OPEN CLOSED
date_closeddate-timeDate claim was closed
payout_centsintegerPayout in cents
representative_namestringRepresentative name
representative_phonestringRepresentative phone number
representative_emailstringRepresentative email address
addressobjectAddress object

Loss events object

Use the table below for information about the loss events object.

AttributeTypeDescription
idstringLoss event ID
date_of_occurrencedate-timeDate loss event occurred
date_of_claimdate-timeDate of claim
typestringLoss event type
BURGLARY_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_centsintegerAmount paid in cents
amount_reserved_centsintegerAmount reserved in cents
is_subrogationBooleanStatus of subrogation
is_claim_openBooleanStatus of claim

Documents object

The documents object values are in the table below.

AttributeTypeDescription
idstringDocument ID
titlestringDocument title
document_typestringDocument type
INSURANCE_APPLICATION INSURANCE_BINDER DECLARATIONS ENDORSEMENT INSURANCE_ID_CARD VERIFICATION_OF_INSURANCE
date_addeddate-timeDocument effective date
filestringFile URL

Drivers object

This table is a reference for the drivers object.

AttributeTypeDescription
idstringDriver ID
first_namestringFirst name
middle_namestringMiddle name
last_namestringLast name
drivers_licensestringLicense number
drivers_license_statestringDriver license state
date_of_birth_strstringDate of birth
genderstringGender
MALE FEMALE NONBINARY
marital_statusstringMarital status
SINGLE MARRIED DIVORCED WIDOWED SEPARATED CIVIL_UNION
relationship_to_insuredstringRelationship to the insured
INSURED SPOUSE BROTHER SISTER FATHER MOTHER DAUGHTER SON

Addresses object

These values are for the address object.

AttributeTypeDescription
idstringAddress ID
countrystringCountry
streetstringStreet
citystringCity
statestringState
zipstringZip code

Driving records object

The values below are within the driving records object.

AttributeTypeDescription
idstringDriving record ID
driver_idstringDriver ID
incident_datedate-timeDate incident occurred
incident_typestringIncident type
ACCIDENT VIOLATION
violation_typestringThe 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_faultBooleanStatus of driver at fault

Agents object

For information about the agents object, view the table and values below.

AttributeTypeDescription
idstringAgent info record ID
address_idstringAddress ID of agent or agency location
agency_namestringName of agency, agency_name or agent_full_name required
agent_full_namestringName of agent, agency_name or agent_full_name required
phone_numberstringPhone number for the agent or agency
emailstringEmail for the agent or agency
policy_idsarray of stringsList of Policy IDs associated to agent

Identity object

Use this table for values from the identity object.

AttributeTypeDescription
idstringID of object
created_atstringISO 8601 value for first time retrieving person's identity info
updated_atstringISO 8601 value for last time retrieving person's identity info
first_namestringFirst name
last_namestringLast name
full_namestringFull name
middle_initialsstringMiddle initials
emailstringEmail address
ssnstringSocial Security Number, full or last 4 digits
date_of_birthdateDate of birth
home_addressobjectAddress 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"
}