Create 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/createClaim
Formats: JSON
HTTP Methods: POST
Authentication: Authorization: Bearer token

Inputs

Input	Details
createClaimInputRepresentation	Type Apex-defined Description Required. An Apex ConnectApi.CreateClaimInputRepresentation record that contains the details of the claim to be created.

Outputs

Output	Details
`claimId`	Type string Description ID of the claim that's created.

Example

Sample Request

1{
2  "inputs": [
3    {
4      "createClaimInputRepresentation": {
5        "name": "Claim for Auto Accident",
6        "lossDate": "2025-09-15",
7        "claimType": "Auto",
8        "claimReason": "Rear-end collision",
9        "claimReasonType": "Accident",
10        "lossType": "Accident",
11        "insurancePolicyId": "0YTx0000000001qEAA",
12        "accountId": "001xx000003DGQyAAO",
13        "additionalFields": {
14          "key": "RepairShop",
15          "value": "NY"
16        },
17        "attributes": [
18          {
19            "apiName": "WeatherConditions",
20            "value": "Clear and Sunny"
21          },
22          {
23            "apiName": "NumberOfVehicles",
24            "value": "2"
25          }
26        ],
27        "items": [
28          {
29            "instanceKey": "item_vehicle_damage_01",
30            "name": "Damaged Rear Bumper and Trunk",
31            "productCode": "AUTO-SEDAN-2023",
32            "category": "Auto Physical Damage",
33            "insuredItemId": "02ixx0000004l5sAAA",
34            "insurancePolicyCoverageId": "0cvxx000000AbCdEfG",
35            "attributes": [
36              {
37                "apiName": "DamageSeverity",
38                "value": "Moderate"
39              }
40            ],
41            "additionalFields": {
42              "key": "RepairEstimate",
43              "value": 2750
44            },
45            "relatedObjects": [
46              {
47                "relatedRecordId": "001xx000003DGQzAAP",
48                "relatedRecordObjName": "Account"
49              }
50            ],
51            "participantInstanceKey": "participant_driver_01"
52          }
53        ],
54        "participants": [
55          {
56            "instanceKey": "participant_driver_01",
57            "contactId": "003xx000003DGQyAAO",
58            "accountId": "001xx000003DGQyAAO",
59            "insurancePolicyParticipantId": "0pPxx000000001qEAA",
60            "isInjured": false,
61            "roles": [
62              "Driver",
63              "Claimant"
64            ],
65            "additionalFields": {
66              "StatementTaken": true
67            }
68          }
69        ]
70      }
71    }
72  ]
73}

Sample Response

1[
2  {
3    "actionName": "createClaim",
4    "errors": null,
5    "invocationId": null,
6    "isSuccess": true,
7    "outcome": null,
8    "outputValues": {
9      "claimId": "0Z1S70000004oVfIAI"
10    },
11    "sortOrder": -1,
12    "version": 1
13  }
14]