Claims API
Endpoint Index
| Action | Endpoint |
|---|---|
| Create a claim | POST /claim |
| Update a claim | POST /claim/{claimLocator}/update |
| Fetch a specific claim | GET /claim/{claimLocator} |
| Fetch all claims for a policy | GET /policy/{policyLocator}/claims |
| Find claims in a date range | GET /claims |
| Discard a claim | POST /claim/{claimLocator}/discard |
| Create a subclaim payable | POST /claims/payables |
| Get a payable | GET /claims/payables/{payableLocator} |
| Reverse a payable | POST /claims/payables/reversals |
| Fetch a subclaim summary | GET /subClaim/{subClaimLocator}/summary |
| Fetch subclaim payables | GET /subClaim/{subClaimLocator}/payables |
| Fetch subclaim reserves | GET /subClaim/{subClaimLocator}/reserves |
Details
Create a claim¶
POST /claimRequest:
| Name | Position | Type | Required |
|---|---|---|---|
| createRequest | body | ClaimCreateRequest | required |
Response:
ClaimResponseClaimCreateRequest¶
requiredpolicyLocator stringoptionalincidentTimestamp timestampnotificationTimestamp timestampfieldValues map<string,[string]>fieldGroups [FieldGroupCreateRequest]status string pending | open
ClaimResponse¶
requiredlocator stringpolicyLocator stringproductName stringcreatedTimestamp timestampupdatedTimestamp timestampfieldValues map<string,[string]>currentStatus string pending | open | closedfieldGroupsByLocator map<string,map<string,[string]>>mediaByLocator map<string,Media>subClaims [SubClaimResponse]optionalincidentTimestamp timestampnotificationTimestamp timestamp
Update a claim¶
POST /claim/{claimLocator}/updateRequest:
| Name | Position | Type | Required |
|---|---|---|---|
| claimLocator | path | string | required |
| updateRequest | body | ClaimUpdateRequest | required |
Response:
ClaimResponseClaimUpdateRequest¶
requiredaddFieldGroups [FieldGroupCreateRequest]updateFieldGroups [FieldGroupUpdateRequest]removeFieldGroups [string]addSubClaims [SubClaimCreateRequest]updateSubClaims [SubClaimUpdateRequest]optionalincidentTimestamp timestampnotificationTimestamp timestampfieldValues map<string,[string]>status string open | closed
Fetch a specific claim¶
GET /claim/{claimLocator}Request:
| Name | Position | Type | Required |
|---|---|---|---|
| claimLocator | path | string | required |
Response:
ClaimResponseFetch all claims for a policy¶
GET /policy/{policyLocator}/claimsRequest:
| Name | Position | Type | Required |
|---|---|---|---|
| policyLocator | path | string | required |
Response:
[ClaimResponse]ClaimPageResponse¶
requiredclaims [ClaimResponse]optionalpagingToken string
Find claims in a date range¶
GET /claimsRequest:
| Name | Position | Type | Required |
|---|---|---|---|
| createdAfterTimestamp | query | timestamp | optional |
| createdBeforeTimestap | query | integer | optional |
| pageSize | query | integer | optional |
| pagingToken | query | string | optional |
Response:
ClaimPageResponseSubClaimCreateRequest¶
requiredfieldGroups [FieldGroupCreateRequest]perilLocator stringoptionalfieldValues map<string,[string]>expenseReserve ReserveSetRequestlossReserve ReserveSetRequest
SubClaimUpdateRequest¶
requiredlocator stringaddFieldGroups [FieldGroupCreateRequest]updateFieldGroups [FieldGroupUpdateRequest]removeFieldGroups [string]optionalfieldValues map<string,[string]>expenseReserve ReserveSetRequestlossReserve ReserveSetRequeststatus string open | closed
ReserveSetRequest¶
requiredamount number
SubClaimResponse¶
requiredlocator stringcreatedTimestamp timestampupdatedTimestamp timestampfieldValues map<string,[string]>claimLocator stringcurrentStatus string open | closedexpenseReserve ReserveResponseexposureLocator stringfieldGroupsByLocator map<string,map<string,[string]>>lossReserve ReserveResponseperilLocator stringreserveCurrency stringoptionalexpenseLedger [LedgerLineItem]lossLedger [LedgerLineItem]
Note
For brevity, ledgers are not included in the response body for List Claims requests.
ReserveResponse¶
requiredcreatedTimestamp timestampupdatedTimestamp timestampcurrentAmount number
LedgerLineItem¶
requiredchangeTimestamp timestampamountChange numberreserveBalance numberchangeType string payable.created | payable.reversed | reserve.updated | reserve.closed | reserve.opened | reserve.reopenedoptionalnewAmount numberoldAmount numberpayableLocator string
Note
The payableLocator is present if and only if the change was relevant to a payable (or reversal), and is absent in other cases. The reserveBalance and newAmount are identical, but newAmount and oldAmount are included for clarity regarding the reserve update.
Discard a claim¶
POST /claim/{claimLocator}/discardRequest:
| Name | Position | Type | Required |
|---|---|---|---|
| claimLocator | path | string | required |
Response:
voidCreate a subclaim payable¶
POST /claims/payablesRequest:
| Name | Position | Type | Required |
|---|---|---|---|
| request | body | SubClaimPayableCreateRequest | required |
Response:
SubClaimPayableResponseSubClaimPayableCreateRequest¶
requiredamount numberreserveType string loss | expensesubClaimLocator stringoptionalcomment stringrecipient string
Get a payable¶
GET /claims/payables/{payableLocator}Request:
| Name | Position | Type | Required |
|---|---|---|---|
| payableLocator | path | string | required |
Response:
SubClaimPayableResponseSubClaimPayableResponse¶
requiredlocator stringcreatedTimestamp timestampamount numberclaimLocator stringreserveCurrency stringreserveType string loss | expensesubClaimLocator stringoptionalcomment stringrecipient stringreversalLocator stringreversedLocator string
Reverse a payable¶
POST /claims/payables/reversalsRequest:
| Name | Position | Type | Required |
|---|---|---|---|
| reversalRequest | body | SubClaimPayableReverseRequest | required |
Response:
SubClaimPayableResponseSubClaimPayableReverseRequest¶
requiredpayableLocator stringoptionalcomment string
Fetch a subclaim summary¶
GET /subClaim/{subClaimLocator}/summaryRequest:
| Name | Position | Type | Required |
|---|---|---|---|
| subClaimLocator | path | string | required |
Response:
SubClaimSummarySubClaimSummary¶
requiredexpensePayableAmount numberexpenseReserveAmount numberlossPayableAmount numberlossReserveAmount numberreserveCurrency string
Fetch subclaim payables¶
GET /subClaim/{subClaimLocator}/payablesRequest:
| Name | Position | Type | Required |
|---|---|---|---|
| subClaimLocator | path | string | required |
Response:
SubClaimPayableListsResponseSubClaimPayableListsResponse¶
requiredexpensePayables [SubClaimPayableResponse]lossPayables [SubClaimPayableResponse]reserveCurrency string
Fetch subclaim reserves¶
GET /subClaim/{subClaimLocator}/reservesRequest:
| Name | Position | Type | Required |
|---|---|---|---|
| subClaimLocator | path | string | required |
Response:
ReserveHistoryResponseReservesResponse¶
requiredhistory ReserveHistoryResponse
ReserveHistoryResponse¶
requiredexpenseReserveHistory [ReserveVersionResponse]lossReserveHistory [ReserveVersionResponse]reserveCurrency string
ReserveVersionResponse¶
requiredtimestamp timestampamount number