Querying for reserves

You can use the following endpoints to query for reserve-related information.

Endpoint Description
GET ​/claims​/{claimId}​/reserve-sets​ Retrieve a list of reserve sets
GET ​/claims​/{claimId}​/reserve-sets​/{reserveSetId} Retrieve details of a reserve set
GET /claims​/{claimId}​/reserves The reserves associated with a given claim
GET​ /claims​/{claimId}​/reserves​/{transactionId} The details of a specific reserve
Endpoint Description
GET ​/claims​/{claimId}​/reserve-sets​ Retrieve a list of reserve sets
GET ​/claims​/{claimId}​/reserve-sets​/{reserveSetId} Retrieve details of a reserve set
GET /claims​/{claimId}​/reserves The reserves associated with a given claim
GET​ /claims​/{claimId}​/reserves​/{transactionId} The details of a specific reserve

Sample response for a reserve set

For example, the ClaimCenter sample data includes a claim whose ID is demo_sample:1. This claim has one reserve set. The following is the call to get that reserve set, and the response. The response has been edited for clarity. Note the following:

  • The reserve set includes 9 transactions, three of which are shown in the output below.
  • The reserve set was approved on 2021-08-08.
  • The reserve set was submitted by Andy Applegate.
  • The first three transactions in the reserve set are as follows:
    • A reserve for the first exposure, with a cost type of "Claim cost" and a cost category of "Auto body".
    • A reserve for the first exposure, with a cost type of "Expense - A&O" and a cost category of "Other".
    • A reserve for the second exposure, with a cost type of "Claim cost" and a cost category of "Medical". 
GET claims/demo_sample:1/reserve-sets/cc:17

{
  "data": {
    "attributes": {
      "approvalDate": "2021-08-08T07:00:00.000Z",
      "approvalStatus": {
        "code": "approved",
        "name": "Approved"
      },
      "id": "cc:17",
      "requestingUser": {
        "displayName": "Andy Applegate",
      },
      "reserves": [
        {
          "displayName": "(1) 1st Party Vehicle...Claim Cost/Auto body...",
          "id": "cc:22",
          "type": "Reserve"
        },
        {
          "displayName": "(1) 1st Party Vehicle...Expense - A&O/Other...",
          "id": "cc:36",
          "type": "Reserve"
        },
        {
          "displayName": "(2) 1st Party Med Pay...Claim Cost/Medical...",
          "id": "cc:40",
          "type": "Reserve"
        },
        ...
      ]
    },
  ...
}
Java

Sample response for a reserve transaction

Following on from the previous example, the following is the call to get the first reserve in the reserve set, and the response. The response has been edited for clarity. Note the following:

  • The reserve is for an exposure whose coverage is PACollisionCov.
  • The reserve's line items specify a claim amount, reporting amount, reserving amount, and transaction amount of $500 USD.
  • The reserve line is for exposure 1 (demo_sample:10001) and has a cost type of Claim Cost, a cost category of Auto Body. 
GET claims/demo_sample:1/reserves/cc:17

{
  "data": {
    "attributes": {
      "coverage": {
        "code": "PACollisionCov",
        "name": "Collision"
      },
      "currency": {
        "code": "usd",
        "name": "USD"
      },
      "id": "cc:22",
      "lineItems": [
        {
          "claimAmount": {
            "amount": "500.00",
            "currency": "usd"
          },
          "comments": "Repairs",
          "id": "cc:56",
          "lineCategory": {
            "code": "other",
            "name": "Other"
          },
          "reportingAmount": {
            "amount": "500.00",
            "currency": "usd"
          },
          "reservingAmount": {
            "amount": "500.00",
            "currency": "usd"
            },
          "transactionAmount": {
            "amount": "500.00",
            "currency": "usd"
          }
        }
      ],
      "reserveLine": {
        "costCategory": {
          "code": "body",
          "name": "Auto body"
        },
        "costType": {
          "code": "claimcost",
          "name": "Claim Cost"
        },
        "exposure": {
          "displayName": "(1) 1st Party Vehicle - Ray Newton",
          "id": "demo_sample:10001",
        },
        "reservingCurrency": {
          "code": "usd",
          "name": "USD"
        }
      },
      "status": {
        "code": "submitted",
        "name": "Submitted"
      },
      "type": {
        "code": "Reserve",
        "name": "Reserve"
      }
    },
  ..
}
Java