v4

latestOpenAPI 3.0.12026-07-3189233676.2 KB
Insurance Reports
Retrieve an auto insurance report

The endpoint returns the auto insurance report.
get/v1/links/{link_id}/insurance/report/auto/
Response

idstring required
Unique ID
statusstring required
Request status
finished_atstring
Time when report was finished
access_tokenstring required
Access token for a Link to payroll provider
tracking_infostring required
Any information passed to the Truv Bridge from a partner
is_suspiciousboolean
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
providerstring required
Insurance Provider ID
pdf_reportstring uri
Insurance report in PDF format
Example response

{
  "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,
        "carrier_name": "progressive",
        "status": "ACTIVE",
        "paid_in_full": 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",
            "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"
          }
        ],
        "claims": [
          {
            "type": "WIND_AND_HAIL_DAMAGE",
            "status": "OPEN",
            "date_closed": "2022-05-03T00:00:00Z",
            "payout_cents": 180111,
            "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": [
          {
            "date_of_occurrence": "2022-05-03T00:00:00Z",
            "date_of_claim": "2022-05-03T00:00:00Z",
            "type": "BURGLARY_AND_THEFT",
            "amount_paid_cents": 123323
          }
        ],
        "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"
          }
        ],
        "vehicles": [
          {
            "id": "26a4ce3a-0b9f-4c3d-96c0-1c76529e3b52",
            "year": 2010,
            "make": "CHEVROLET",
            "model": "Camaro",
            "series": "ZL1",
            "type": "PASSENGER CAR",
            "annual_mileage": 26000,
            "vin": "1G1FK1R62J0158884",
            "purchase_date": "2010-10-02T12:00:00.000Z",
            "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",
                "premium_cents": 18514,
                "deductible_cents": 50000
              }
            ],
            "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"
      }
    ],
    "agents": [
      {
        "id": "da9d46ad-8ddb-4b4b-bc7e-7a381a738f7d",
        "email": "john.doe@example.com",
        "address": {
          "id": "a497f96b-94be-443e-88bb-c8289085c922",
          "address_nature": "MAILING",
          "country": "US",
          "street": "344 Clinton St, Apartment 3D",
          "city": "Brooklyn",
          "state": "NY",
          "zip": "11231"
        }
      }
    ],
    "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"
      }
    ],
    "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"
      }
    ]
  },
  "provider": "progressive",
  "identity": {
    "id": "48427a36d43c4d5aa6324bc06c692456",
    "created_at": "2022-06-07T15:00:00Z",
    "updated_at": "2022-06-30T15:00:00Z",
    "first_name": "John",
    "last_name": "Doe",
    "full_name": "John Doe",
    "middle_initials": "K",
    "email": "john.doe@example.com",
    "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://cdn.truv.com/report.pdf"
}