Searching for active and archived claims

Request payload for free-text search

The request object for a POST /claim/v1/search/claims-freetext call must include a body. The body must specify search parameters that use free-text search; the field name returns results from the free-text search index. For example:

{
  "data": {
    "attributes": {
      "address": {
        "addressLine1": "1313 Monroe Lane",
        "city": "Pomona",
        "country": "US",
        "state": {
          "code": "CA",
        }
      },
      "name": "Ray Newton",
      "nameSearchType": {
        "code": "any",
      },
      "phoneNumber": "555 413 4545"
    }
  }
}

For more information about using free-text search, see the ClaimCenter Application Guide.

Searching by name and tax ID

When the payload includes either the firstName , lastName , companyName, or taxID, the default behavior is to search for claims where there is a claimant with that first, last, company name, or tax ID.

You can also use the nameSearchType parameter to execute searches where the named person is either the insured, an additional insured, or has any role on the claim. To do this, provide one of the following codes for the ClaimSearchNameSearchType code:

• addinsured (additional insured)
• any (any role on the claim, including the roles beyond additional insured, claimant, and insured)
• claimant (this is the default behavior)
• insured

For example, the following payload will search for all claims where the insured has a first name of "Ray" and a last name of "Newton". The nameSearchType uses a field from the ClaimSearchNameSearchType code:

Command

POST /claim/v1/search/claims-v2 

Request body

{
  "data": {
    "attributes": {
      "firstName": "Ray",
      "lastName": "Newton",
      "nameSearchType": {
        "code": "insured"
      }
    }
  }
}

The following payload searches for all the archived claims where the insured has the company name of Wright Construction:

{
  "data": {
    "attributes": {
      "archivedSearch": true,
      "companyName": "Wright Construction",
    }
  }
}