Insurance Reports

Retrieve a home insurance report

Changed on

The endpoint returns the home insurance report.

get/v1/links/{link_id}/insurance/report/home/

Request

  • Base URL
    https://prod.truv.com
  • URL
    https://prod.truv.com/v1/links/{link_id}/insurance/report/home/
  • Auth
    API key in header X-Access-Client-Id and API key in header X-Access-Secret

Query parameters

show_fraud_reasonsboolean

Set to true to include fraud_reasons in the response. The field is omitted by default.

Response

idstring required

Unique ID

statusstring required
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",
  "fraud_reasons": [
    {
      "code": "editing_software_detected",
      "message": "Document metadata identifies editing software.",
      "severity": "high",
      "document_ids": [
        "d1f3a6e0b1c24f6c9b3e2a7d5c8e9f01"
      ],
      "uploaded_file_ids": [
        "9ac0b2d4e6f84a1c8e3b5d7f9a1c3e5b"
      ],
      "details": {
        "software": [
          "Adobe Photoshop 25.0 (Windows)"
        ]
      },
      "task_id": "48427a36d43c4d5aa6324bc06c692456",
      "created_at": "2026-10-20T14:03:11Z"
    }
  ],
  "insurance": {
    "policies": [
      {
        "id": "53c5ce0d-fb79-4f1c-bc27-32181b368fc7",
        "policy_type": "CONDO",
        "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"
          }
        ],
        "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,
                "deductible_cents": 50000
              }
            ],
            "mortgagees": [
              {
                "id": "26a4ce3a-0b9f-4c3d-96c0-1c76529e3b52",
                "type": "FIRST",
                "address": {
                  "id": "a497f96b-94be-443e-88bb-c8289085c922",
                  "address_nature": "MAILING",
                  "country": "US",
                  "street": "344 Clinton St, Apartment 3D",
                  "city": "Brooklyn",
                  "state": "NY",
                  "zip": "11231"
                }
              }
            ]
          }
        ]
      }
    ],
    "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"
        }
      }
    ]
  },
  "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"
}

Changes

    • info

      added the new optional query request parameter show_fraud_reasons

    • info

      added the optional property to the response with the status

    • info

      the / response's property pattern ^(\d{4}|\d{9})$ was added for the status