Get Claim Action | Insurance Developer Guide

This action is available in API version 65.0 and later.

Supported REST HTTP Methods

URI: /services/data/v67.0/actions/standard/getClaim
Formats: JSON
HTTP Methods: POST
Authentication: Authorization: Bearer token

Inputs

Input	Details
getClaimInputRepresentation	Type Apex-defined Description Required. An Apex ConnectApi.GetClaimInputRepresentation record that contains the details of the claim to be retrieved.

Outputs

Output	Details
`getClaimOutputRepresentation`	Type Apex-defined Description An Apex ConnectApi.GetClaimOutputRepresentation record that contains the details of the claim that's retrieved.
`claimItemOutputs`	Type Apex-defined Description A collection of Apex ConnectApi.ClaimItemOutputs records that contain the list of claim items.
`claimParticipantOutputs`	Type Apex-defined Description A collection of Apex ConnectApi.ClaimParticipantOutputs records that contain the list of claim participants.

Example

Sample Request

1{
2  "inputs": [
3    {
4      "getClaimInputRepresentation": {
5        "claimId": "0Z1S70000004oVfIAI"
6      }
7    }
8  ]
9}

Sample Response

1[
2  {
3    "actionName": "getClaim",
4    "errors": null,
5    "isSuccess": true,
6    "outputValues": {
7      "getClaimOutputRepresentation": {
8        "claimDetails": {
9          "accountId": "001xx000003DGQyAAO",
10          "attributes": [
11            {
12              "apiName": "PoliceReportNumber",
13              "value": "SF-2025-09-13-00123"
14            }
15          ],
16          "claimReason": "Auto accident",
17          "claimReasonType": "AUTO_ACCIDENT",
18          "claimType": "AUTO_ACCIDENT",
19          "lossType": "Front bumper damaged"
20        },
21        "claimId": "0Z1S70000004oVfIAI",
22        "contextId": "C-000123",
23        "insurancePolicyId": "0e9S70000004oVfIAI",
24        "lossDate": "2025-07-22",
25        "name": "Claim for Auto Accident",
26        "productCode": "AUTO-ACCIDENT"
27      },
28      "claimItemOutputs": [
29        {
30          "claimItems": [
31            {
32              "category": "Auto Physical Damage",
33              "claimDetails": {
34                "accountId": "001xx000003DGQyAAO",
35                "attributes": [
36                  {
37                    "apiName": "DamageSeverity",
38                    "value": "Severe"
39                  }
40                ],
41                "claimReason": "Auto accident",
42                "claimReasonType": "AUTO_ACCIDENT",
43                "claimType": "AUTO_ACCIDENT",
44                "lossType": "Front bumper damaged"
45              },
46              "id": "0koxx000000001dEAA",
47              "instanceKey": "item_vehicle_bumper_01",
48              "name": "Damaged Front Bumper",
49              "productCode": "AUTO-BUMPER-SEDAN",
50              "insuredItemId": "02ixx0000004l5sAAA"
51            }
52          ]
53        }
54      ],
55      "claimParticipantOutputs": [
56        {
57          "claimParticipants": [
58            {
59              "id": "0kaxx000000001dEAA",
60              "instanceKey": "participant_driver_1",
61              "accountId": "001xx000003DGQyAAO",
62              "contactId": "003xx000003DGQyAAO",
63              "insurancePolicyParticipantId": "0pPxx000000001qEAA",
64              "roles": [
65                "Driver",
66                "Claimant"
67              ]
68            }
69          ]
70        }
71      ],
72      "sortOrder": -1,
73      "version": 1
74    }
75  }
76]