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 for archived claims

To search for archived claims, add the field archivedSearch and set the field to true. Request payloads that do not include the archivedSearch field (or that set archivedSearch to false) automatically search only for active claims.

{
    "status": 400,
    "errorCode": "com.guidewire.pl.modules.rest.framework.v1.exceptions.OperationNotCurrentlyAllowedException",
    "userMessage": "The operation is not currently allowed for this resource"
}

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",
    }
  }
}

Response payload for an empty claim search

The system APIs do not require you to provide any search parameters, but ClaimCenter will not execute a claim search with no search parameters. If you attempt to execute a claim search without search parameters, either from the user interface or through a system API, ClaimCenter returns the following error message:

Please specify Claim #, Policy #, any Contact field, Assigned To Group, Assigned To User, Created By, Cat #, VIN or License Plate

Note that this message is intended primarily for user interface claim searches, which is why it makes reference to fields not available to the /claim/v1/search/claims-v2 endpoint, such as Assigned To Group, Assigned To User, and Created By.

Active claim search results

In the following example, a policy holder searched for all claims associated with Bill Kinman:

• adjusterName states the name of the claim’s assigned user
• assignedGroup provides the group assigned to the claim
• claimID
• claimNumber
• A list of the claimants
• The flagged field stating if the adjuster provided a unique flag statement for the claim
• futurePayments are the payments scheduled to be sent
• insuredName
• lossDate of the claim
• The total amount paid
• policyNumber of the claim
• remainingReserves left on the claim
• status of the claim, stating whether it is open or closed

{
    "count": 1,
    "data": [
        {
            "attributes": {
                "adjusterName": "Andy Applegate",
                "assignedGroup": "Auto1 - TeamA",
                "claimId": "cc:SO",
                "claimNumber": "235-53-425891",
                "claimants": [
                    "Bill Kinman"
                ],
                "flagged": true,
                "futurePayments": {
                    "amount": "0.00",
                    "currency": "usd"
                },
                "insuredName": "Bill Kinman",
                "lossDate": "2021-02-28T00:00:00.000Z",
                "paid": {
                    "amount": "0.00",
                    "currency": "usd"
                },
                "policyNumber": "4775949863-02",
                "remainingReserves": {
                    "amount": "0.00",
                    "currency": "usd"
                },
                "status": {
                    "code": "open",
                    "name": "Open"
                }
            }
        },

Archived claim search results

Archived claim search results produce similar results to the active claim search, but also include archive-related fields. These archive-related fields include the following:

• The archiveState of the claim stating whether the claim is archived or is returning to an active claim state
• Whether the claim was archived or not (always true)
• The archivedAdjuster which states the adjuster that performed the archive
• The claimInfoID stating the identification number of the claimInfo object that allows the archived claim to be retrieved