Querying for claims associated with you

Typically, the GET /claim/v1/claims endpoint does not return all claims in ClaimCenter. The endpoint is restricted by the caller's resource access. In the base configuration, this means the following:

  • For internal users, the endpoint returns only claims that would be on that user's Access Control List (ACL)
  • For external users who are policyholders, the endpoint returns only claims related to policies the user holds.
  • For external users who are vendors, the endpoint returns only claims with a service request where the vendor is the service provider.
  • For services, all claims are returned. (Services are not bound by resource access.)

For example, both Andy Applegate and Wendy Gompers are internal users defined in the sample data. Suppose that the sample data has been loaded and each adjuster executes the following:

GET /claim/v1/claims?fields=id

The count and data sections of the response payload for Andy Applegate consists of the 5 open claims on his ACL:

{
    "count": 5,
    "data": [
        {
            "attributes": {
                "id": "cc:34"
            }
        },
        {
            "attributes": {
                "id": "cc:33"
            }
        },
        {
            "attributes": {
                "id": "demo_sample:20"
            }
        },
        {
            "attributes": {
                "id": "demo_sample:2"
            }
        },
        {
            "attributes": {
                "id": "demo_sample:1"
            }
        }
    ],
...

The count and data sections of response payload for Wendy Gompers consists of the 6 open claims on her ACL:

{
    "count": 6,
    "data": [
        {
            "attributes": {
                "id": "trucking:7"
            }
        },
        {
            "attributes": {
                "id": "trucking:8"
            }
        },
        {
            "attributes": {
                "id": "demo_sample:30002"
            }
        },
        {
            "attributes": {
                "id": "demo_sample:30001"
            }
        },
        {
            "attributes": {
                "id": "gl:1"
            }
        },
        {
            "attributes": {
                "id": "trucking:6"
            }
        }
    ],
...

You can view this output for yourself in Postman by doing the following:

  1. Open a request tab. From the Authorization tab, set the TYPE drop-down list to Basic Auth. For the Username and Password, specify aapplegate and gw.
  2. Execute GET /claim/v1/claims.
  3. Open a second request tab. From the Authorization tab, set the TYPE drop-down list to Basic Auth. For the Username and Password, specify wgompers and gw.
  4. Execute GET /claim/v1/claims.
  5. Compare the two response payloads.

For more information on resource access, see the Cloud API Authentication Guide.

Closed claims

By default, the GET /claim/v1/claims endpoint returns only open claims. You can query for open and closed claims by adding the following query parameter:

?filter=state:in:open,closed

Draft claims

Draft claims are claims that have been saved to the database, but the claim does not yet have enough information for it to be assigned to an adjuster or vendor. Therefore, for some callers, the GET /claim/v1/claims endpoint does not return draft claims.