Querying for recoveries and recovery reserves

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


Endpoint	Description
GET /claims/{claimId}/recovery-reserve-sets	Retrieve a list of recovery reserve sets (This endpoint is "potentially large". See below.)
GET /claims/{claimId}/recovery-reserve-sets/{recoveryReserveSetId}	Retrieve details of a recovery reserve set
GET /claims/{claimId}/recovery-reserves	Retrieve a list of recovery reserves (This endpoint is "potentially large". See below.)
GET /claims/{claimId}/recovery-reserves/{transactionId}	Retrieve the details from a specific recovery reserve
GET /claims/{claimId}/recovery-sets	Retrieve a list of recovery sets (This endpoint is "potentially large". See below.)
GET /claims/{claimId}/recovery-sets/{recoverySetId}	Retrieve the details for a specific recovery set
GET /claims/{claimId}/recoveries	Retrieve the recovery transactions (This endpoint is "potentially large". See below.)
GET /claims/{claimId}/recoveries/{transactionId}	Retrieve the details of a specific recovery

Some endpoints are "potentially large". Cloud API returns an error if you attempt to sort on this endpoint and the sort cannot be accomplished efficiently. For more information, see Potentially large endpoints.

Sample response for a recovery reserve

You can query for all recovery reserves created in a recovery reserve set by performing a GET on recovery reserves.

The following call gets the recovery reserve. Note the following:

The recovery reserve was created automatically from a recovery.
The reserve amount and the transaction amount are equal because the recovery amount was already received.
The recovery offsets costs paid out for Karen Egertson’s collision policy, which uses the exposure for Karen Egertson’s first policy vehicle.
The recovery reserve was created in the expectation of subrogation for the claim.
GET rest/claim/v1/claims/demo-sample:1/recovery-reserves

{
  "data": {
    "attributes": {
        "comments": "Automatically created due to recovery for $100.00 on (1) 1st Party Vehicle - Karen Egertson; Claim Cost/Auto body; USD; Subrogation",
        "coverage": {
            "code": "PACollisionCov",
            "name": "Collision"
        },
        "createTime": "2021-11-19T18:29:08.386Z",
        "currency": {
            "code": "usd",
             "name": "USD"
        },
        "id": "cc:901",
        "lineItems": [
            {
                "claimAmount": {
                    "amount": "100.00",
                    "currency": "usd"
                },
                "comments": "Automatically created due to recovery for $100.00 on (1) 1st Party Vehicle - Karen Egertson; Claim Cost/Auto body; USD; Subrogation",
                "id": "cc:FJ2",
                "reportingAmount": {
                    "amount": "100.00",
                    "currency": "usd"
                },
                "reservingAmount": {
                    "amount": "100.00",
                    "currency": "usd"
                },
                "transactionAmount": {
                    "amount": "100.00",
                    "currency": "usd"
                }
            }
         ],
        "reserveLine": {
            "costCategory": {
                "code": "body",
                "name": "Auto body"
            },
            "costType": {
                "code": "claimcost",
                "name": "Claim Cost"
            },
             "exposure": {
                "displayName": "(1) 1st Party Vehicle - Karen Egertson",
                "id": "cc:PV6",
                "type": "Exposure",
                "uri": "/claim/v1/claims/cc:901/exposures/cc:PV6 "
            },
            "recoveryCategory": {
                "code": "subro",
                "name": "Subrogation"
            },
            "reservingCurrency": {
                "code": "usd",
                "name": "USD"
            }
         },
         "status": {
             "code": "submitting",
             "name": "Submitting"
         },
          "subtype": {
                "code": "RecoveryReserve",
                "name": "RecoveryReserve"
            }
        }
    }
}