Introduction

Welcome to the LossExpress Gap Documents API! This API is designed for use by companies interested in informing insurance adjusters of missing documents on claims within LossExpress, and viewing existing documents on claims.

When going through the integration process with your organization’s systems and LossExpress, it’s important to keep in mind the idea at the core of the LossExpress product and underlying APIs: we act simply as a conduit of information, from carriers to lenders.

As a result, we have done our best when building out this API to ensure it behaves consistently and correctly, and is designed simply; without making assumptions about a request or behaving differently behind the scenes depending on circumstance.

Testing

Upon receiving authentication credentials, vendors are initially put into a testing phase. This is a sandbox environment where you can create and manipulate claims - and make mistakes - without affecting production data or processes. Once testing has been thoroughly completed, let us know and we will take you out of the testing phase.

Authentication

Our Gap Documents API utilizes HTTP Basic authentication. Upon signing up, you will receive a username (vendor ID) and a password.

Every request is expected to have a header that looks like the following:

Authorization: Basic <base64credentials>

Search Claims

You can utilize this endpoint to search for claims and received Claim IDs (claimId) and documents related to that claim.

Example Response:

{
  "claims": [
    {
      "claimId": "c30ae9da-9222-4de5-81fe-fe1ac590fa0f",
      "claimNumber": "LX-EXAMPLE3",
      "carrierName": "Factory Intelligent Insurance",
      "dateOfLoss": "2023-11-29",

      "documents": [
        {
          "type": "settlement breakdown",
          "documentUrl": "https://api.lossexpress.com/xgap/documents/555ae9da-9222-4de5-81fe-fe1ac590fa0f",
          "createdAt": "2021-01-08T22:03:09.598Z",
        },
        {
          "type": "letter of guarantee",
          "documentUrl": "https://api.lossexpress.com/xgap/documents/555ae9da-9222-4de5-81fe-fe1ac590fa0g",
          "createdAt": "2021-01-08T22:03:09.599Z",
        }
      ]
    }
  ]
}

HTTP Request

GET https://api.lossexpress.com/xgap/claims

Query Parameters

Send Direct Message

Example Response (201 Status Code):

{
  "success": true
}

HTTP Request

POST https://api.lossexpress.com/xgap/claims/{claimId}/direct-message

URL Parameters

Request Body

This route accepts a JSON payload of an object comprising of:

Allowed types for missingDocs

The allowed types for missing docs are:

Unique Errors

On top of general API errors, this route can return the following unique errors:

Errors

Our Gap Documents API returns the following error codes: