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 /claim

Request:

Name	Position	Type	Required
createRequest	body	ClaimCreateRequest	required

Response: ClaimResponse

ClaimCreateRequest¶

required
policyLocator string

optional
incidentTimestamp timestamp
notificationTimestamp timestamp
fieldValues map<string,[string]>
fieldGroups [FieldGroupCreateRequest]
status string pending | open

ClaimResponse¶

required
locator string
policyLocator string
productName string
createdTimestamp timestamp
updatedTimestamp timestamp
fieldValues map<string,[string]>
currentStatus string pending | open | closed
fieldGroupsByLocator map<string,map<string,[string]>>
mediaByLocator map<string,Media>
subClaims [SubClaimResponse]

optional
incidentTimestamp timestamp
notificationTimestamp timestamp

Update a claim¶

POST /claim/{claimLocator}/update

Request:

Name	Position	Type	Required
claimLocator	path	string	required
updateRequest	body	ClaimUpdateRequest	required

Response: ClaimResponse

ClaimUpdateRequest¶

required
addFieldGroups [FieldGroupCreateRequest]
updateFieldGroups [FieldGroupUpdateRequest]
removeFieldGroups [string]
addSubClaims [SubClaimCreateRequest]
updateSubClaims [SubClaimUpdateRequest]

optional
incidentTimestamp timestamp
notificationTimestamp timestamp
fieldValues map<string,[string]>
status string open | closed

Fetch a specific claim¶

GET /claim/{claimLocator}

Request:

Name	Position	Type	Required
claimLocator	path	string	required

Response: ClaimResponse

Fetch all claims for a policy¶

GET /policy/{policyLocator}/claims

Request:

Name	Position	Type	Required
policyLocator	path	string	required

Response: [ClaimResponse]

ClaimPageResponse¶

required
claims [ClaimResponse]

optional
pagingToken string

Find claims in a date range¶

GET /claims

Request:

Name	Position	Type	Required
createdAfterTimestamp	query	timestamp	optional
createdBeforeTimestap	query	integer	optional
pageSize	query	integer	optional
pagingToken	query	string	optional

Response: ClaimPageResponse

SubClaimCreateRequest¶

required
fieldGroups [FieldGroupCreateRequest]
perilLocator string

optional
fieldValues map<string,[string]>
expenseReserve ReserveSetRequest
lossReserve ReserveSetRequest

SubClaimUpdateRequest¶

required
locator string
addFieldGroups [FieldGroupCreateRequest]
updateFieldGroups [FieldGroupUpdateRequest]
removeFieldGroups [string]

optional
fieldValues map<string,[string]>
expenseReserve ReserveSetRequest
lossReserve ReserveSetRequest
status string open | closed

ReserveSetRequest¶

required
amount number

SubClaimResponse¶

required
locator string
createdTimestamp timestamp
updatedTimestamp timestamp
fieldValues map<string,[string]>
claimLocator string
currentStatus string open | closed
expenseReserve ReserveResponse
exposureLocator string
fieldGroupsByLocator map<string,map<string,[string]>>
lossReserve ReserveResponse
perilLocator string
reserveCurrency string

optional
expenseLedger [LedgerLineItem]
lossLedger [LedgerLineItem]

Note

For brevity, ledgers are not included in the response body for List Claims requests.

ReserveResponse¶

required
createdTimestamp timestamp
updatedTimestamp timestamp
currentAmount number

LedgerLineItem¶

required
changeTimestamp timestamp
amountChange number
reserveBalance number
changeType string payable.created | payable.reversed | reserve.updated | reserve.closed | reserve.opened | reserve.reopened

optional
newAmount number
oldAmount number
payableLocator 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}/discard

Request:

Name	Position	Type	Required
claimLocator	path	string	required

Response: void

Create a subclaim payable¶

POST /claims/payables

Request:

Name	Position	Type	Required
request	body	SubClaimPayableCreateRequest	required

Response: SubClaimPayableResponse

SubClaimPayableCreateRequest¶

required
amount number
reserveType string loss | expense
subClaimLocator string

optional
comment string
recipient string

Get a payable¶

GET /claims/payables/{payableLocator}

Request:

Name	Position	Type	Required
payableLocator	path	string	required

Response: SubClaimPayableResponse

SubClaimPayableResponse¶

required
locator string
createdTimestamp timestamp
amount number
claimLocator string
reserveCurrency string
reserveType string loss | expense
subClaimLocator string

optional
comment string
recipient string
reversalLocator string
reversedLocator string

Reverse a payable¶

POST /claims/payables/reversals

Request:

Name	Position	Type	Required
reversalRequest	body	SubClaimPayableReverseRequest	required

Response: SubClaimPayableResponse

SubClaimPayableReverseRequest¶

required
payableLocator string

optional
comment string

Fetch a subclaim summary¶

GET /subClaim/{subClaimLocator}/summary

Request:

Name	Position	Type	Required
subClaimLocator	path	string	required

Response: SubClaimSummary

SubClaimSummary¶

required
expensePayableAmount number
expenseReserveAmount number
lossPayableAmount number
lossReserveAmount number
reserveCurrency string

Fetch subclaim payables¶

GET /subClaim/{subClaimLocator}/payables

Request:

Name	Position	Type	Required
subClaimLocator	path	string	required

Response: SubClaimPayableListsResponse

SubClaimPayableListsResponse¶

required
expensePayables [SubClaimPayableResponse]
lossPayables [SubClaimPayableResponse]
reserveCurrency string

Fetch subclaim reserves¶

GET /subClaim/{subClaimLocator}/reserves

Request:

Name	Position	Type	Required
subClaimLocator	path	string	required

Response: ReservesResponse

ReservesResponse¶

required
history ReserveHistoryResponse

ReserveHistoryResponse¶

required
expenseReserveHistory [ReserveVersionResponse]
lossReserveHistory [ReserveVersionResponse]
reserveCurrency string

ReserveVersionResponse¶

required
timestamp timestamp
amount number