--- title: "Retrieve a home insurance report" method: GET path: "/v1/links/{link_id}/insurance/report/home/" tags: ["Insurance Reports"] --- # Retrieve a home insurance report `GET /v1/links/{link_id}/insurance/report/home/` The endpoint returns the home insurance report. ## Response `200` - HomeInsuranceReport — Data for the insurance report - `id` string, required — Unique ID - `status` string, required — [Request status](https://docs.truv.com/reference/task-livecycle) - `finished_at` string — Time when report was finished - `access_token` string, required — Access token for a Link to payroll provider - `tracking_info` string, required — Any information passed to the Truv Bridge from a partner - `is_suspicious` boolean — Flag to indicate if the data from the source is suspicious. E.g. fraud detected in uploaded documents or SSN of the user does not match with the data - `insurance` HomePull, required - `policies` HomePolicy[] — List of policies - `id` string, uuid — Policy ID - `policy_type` 'CONDO' | 'HOMEOWNERS' | 'LANDLORD' | 'RENTERS' | 'MOBILE_HOME' — Policy type - `name` string — Human-friendly name - `description` string — Human-friendly description - `carrier_policy_number` string — Carrier policy number - `effective_date` string, date-time — Policy effective date - `expiry_date` string, date-time — Policy expiration date - `renewal_date` string, date-time — Policy renewal date - `canceled_date` string, 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, required — Insurance carrier name - `status` 'ACTIVE' | 'CANCELLED' | 'EXPIRED' | 'UNVERIFIED' | 'PENDING_ACTIVATION' | 'PENDING_CANCELLATION' | 'RESCINDED' — Policy status - `paid_in_full` boolean — Whether the policy is fully paid - `commercial_named_insureds` InsurancePolicyCommercialNamedInsured[] — List of commercial named insureds - `id` string, uuid, required — Commercial named insured ID - `name` string — Name of the insured - `form_of_business` 'INDIVIDUAL' | 'PARTNERSHIP' | 'LIMITED_LIABILITY_COMPANY' | 'S_CORPORATION' | 'CORPORATION' | 'JOINT_VENTURE' | 'NOT_FOR_PROFIT_ORGANIZATION' | 'TRUST' — Form of business - `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, required — Whether the insured is the primary - `address` InsuranceAddress - `id` string, uuid, required — Address ID - `address_nature` 'MAILING' | 'PHYSICAL' | 'LIENHOLDER' | 'INCIDENT_LOCATION' | 'AGENCY_LOCATION' | 'MORTGAGEE' — The type of address - `country` string, nullable — Country - `street` string — Street - `city` string — City - `state` string — State - `zip` string — Zip code - `named_insureds` InsurancePolicyNamedInsured[] — List of named insured objects - `id` string, uuid, required — Named insured ID - `first_name` string — First name of the insured - `middle_name` string — Middle name of the insured - `last_name` string — Last name of the insured - `full_name` string — Full name of the insured - `is_primary` boolean — Whether the insured is the primary named insured - `claims` InsuranceClaim[] — List of claims - `id` string, uuid, required — Claim ID - `dwelling_id` string, uuid, nullable — Dwelling ID - `vehicle_id` string, uuid, nullable — Cehicle ID - `driver_id` string, uuid, nullable — Driver ID - `carrier_claim_identifier` string — Carrier claim identifier - `date_occurred` string, date-time — Date the claim occurred - `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' — Claim type - `status` 'OPEN' | 'CLOSED' — Status - `date_closed` string, date-time, nullable — Date the claim was closed - `payout_cents` integer, nullable — Payout in cents - `representative_name` string — Representative name - `representative_phone` string — Representative phone number - `representative_email` string — Representative email address - `address` InsuranceAddress - `id` string, uuid, required — Address ID - `address_nature` 'MAILING' | 'PHYSICAL' | 'LIENHOLDER' | 'INCIDENT_LOCATION' | 'AGENCY_LOCATION' | 'MORTGAGEE' — The type of address - `country` string, nullable — Country - `street` string — Street - `city` string — City - `state` string — State - `zip` string — Zip code - `loss_events` InsurancePolicyLossEvent[] — List of loss events - `id` string, uuid, required — Loss event ID - `date_of_occurrence` string, date-time, required — Date the loss event occurred - `date_of_claim` string, date-time — Date of the claim - `type` 'BURGLARY_AND_THEFT' | 'WATER_DAMAGE_AND_FREEZING_DAMAGE' | 'WIND_AND_HAIL_DAMAGE' | 'FIRE' | 'CUSTOMER_SLIPS_AND_FALLS' | 'CUSTOMER_INJURY_AND_DAMAGE' | 'PERSONAL_AND_ADVERTISING_INJURY' | 'EMPLOYEE_INJURY_OR_ILLNESS' | 'PRODUCT_LIABILITY' | 'STRUCK_BY_AN_OBJECT' | 'REPUTATIONAL_HARM' | 'VEHICULAR_ACCIDENT' | 'WINDSHIELD_DAMAGE' | 'STRIKE_RIOT_OR_CIVIL_COMMOTION' | 'EMERGENCY_ROADSIDE_ASSISTANCE', required — Loss event type - `amount_paid_cents` integer, required — Amount paid in cents - `amount_reserved_cents` integer, nullable — Amount reserved in cents - `is_subrogation` boolean, required — Whether subrogation was successful - `is_claim_open` boolean, required — Whether the claim is open - `documents` InsuranceDocument[] — List of documents - `id` string, uuid, required — Document ID - `title` string, required — Document title - `document_type` 'INSURANCE_APPLICATION' | 'INSURANCE_BINDER' | 'DECLARATIONS' | 'ENDORSEMENT' | 'INSURANCE_ID_CARD' | 'VERIFICATION_OF_INSURANCE', required — Document type - `date_added` string, date-time, required — Document effective date - `file` string — File url - `dwellings` InsurancePolicyDwelling[] — List of dwellings - `id` string, uuid, required — Dwelling ID - `address` InsuranceAddress - `id` string, uuid, required — Address ID - `address_nature` 'MAILING' | 'PHYSICAL' | 'LIENHOLDER' | 'INCIDENT_LOCATION' | 'AGENCY_LOCATION' | 'MORTGAGEE' — The type of address - `country` string, nullable — Country - `street` string — Street - `city` string — City - `state` string — State - `zip` string — Zip code - `replacement_cost_cents` integer, nullable — Replacement cost in cents - `cash_value_cents` integer, nullable — Cash value in cents - `coverages` InsuranceDwellingCoverage[] — List of dwelling coverages - `id` string, uuid, required — Dwelling coverage ID - `name` 'BASE' | 'DWELLING' | 'OTHER_STRUCTURES' | 'PERSONAL_PROPERTY' | 'BUSINESS_PROPERTY' | 'ORDINANCE_OR_LAW' | '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' | 'FLOOD' | 'PORTABLE_ELECTRONICS' | 'FASHION_ITEMS' | 'FINE_ART' | 'BICYCLE' | 'CAMERA' | 'JEWELRY' | 'MUSICAL_INSTRUMENT' | 'BUILDING' | 'CONTENTS' | 'ICC' — Name of coverage item - `premium_cents` integer, nullable, required — Premium paid for coverage item, in cents - `per_person_limit_cents` integer, nullable — Per-person limit, in cents - `per_incident_limit_cents` integer, nullable — Per-incident limit, in cents - `deductible_cents` integer, nullable — Deductible, in cents - `is_declined` boolean, required — If true, this coverage item was declined - `mortgagees` InsuranceDwellingMortgagee[] — List of mortgagee objects - `id` string, uuid, required — ID of the mortgagee - `name` string — Name of the mortgagee - `type` 'FIRST' | 'SECOND' | 'THIRD' — The type of mortgagee - `loan_number` string — Loan number of the mortgage - `address` InsuranceAddress - `id` string, uuid, required — Address ID - `address_nature` 'MAILING' | 'PHYSICAL' | 'LIENHOLDER' | 'INCIDENT_LOCATION' | 'AGENCY_LOCATION' | 'MORTGAGEE' — The type of address - `country` string, nullable — Country - `street` string — Street - `city` string — City - `state` string — State - `zip` string — Zip code - `addresses` InsuranceAddress[] — List of addresses - `id` string, uuid, required — Address ID - `address_nature` 'MAILING' | 'PHYSICAL' | 'LIENHOLDER' | 'INCIDENT_LOCATION' | 'AGENCY_LOCATION' | 'MORTGAGEE' — The type of address - `country` string, nullable — Country - `street` string — Street - `city` string — City - `state` string — State - `zip` string — Zip code - `agents` InsuranceAgent[] — List of agents - `id` string, uuid, required — AgentInfo record ID - `agency_name` string — Name of the agency (agency_name or agent_full_name required) - `agent_full_name` string — Name of the agent (agency_name or agent_full_name required) - `phone_number` string — Phone number for the agent/agency - `email` string, email — Email for the agent/agency - `policy_ids` string[] — List of Policy ID's associated to the agent - `address` InsuranceAddress - `id` string, uuid, required — Address ID - `address_nature` 'MAILING' | 'PHYSICAL' | 'LIENHOLDER' | 'INCIDENT_LOCATION' | 'AGENCY_LOCATION' | 'MORTGAGEE' — The type of address - `country` string, nullable — Country - `street` string — Street - `city` string — City - `state` string — State - `zip` string — Zip code - `provider` string, required — Insurance Provider ID - `identity` Profile, required — Person's identity information - `id` string — ID of the object - `created_at` string — Person's identity info was retrieved first time (ISO 8601) - `updated_at` string — Person's identity info was retrieved last time (ISO 8601) - `first_name` string, required — First name - `last_name` string, required — Last name - `full_name` string, nullable — Full name - `middle_initials` string, nullable — Middle initials - `email` string, email, nullable — Email address. Normalized to lowercase. - `ssn` string, nullable — Social security number — either the full 9 digits or the last 4 digits, depending on what the data source exposes. Digits only, never formatted with dashes. - `date_of_birth` string, date, nullable — Date of birth - `home_address` object, nullable — Home address - `street` string — Street address as provided by the data source. May contain multiple lines separated by `\n` (address line 1 and line 2). - `city` string — City as provided by the data source. - `state` string — State or region. For US addresses this is typically a 2-letter state code; some data sources return a full state name, an empty string, or omit the key. Non-US regions are returned as provided. - `zip` string — Postal code as provided by the data source. Typically a 5-digit US ZIP code; ZIP+4 (`94105-1804`), 9 digits without a separator, and non-US postal codes also occur. - `country` string — 2-letter ISO 3166-1 alpha-2 country code. Defaults to `US` when the data source does not specify a country. - `pdf_report` string, uri — Insurance report in PDF format ## Other responses - `401` — HTTP 401 Unauthorized - `403` — HTTP 403 Forbidden --- [API](https://skmtc.net/truv/apis/truv-api.md) · [All operations](https://skmtc.net/truv/apis/truv-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/truv/truv-api/revisions/d7195c30b6b1/schema)