Claims API

Endpoint Index

ActionEndpoint
List all claimsGET /claims
Fetch a claimGET /claim/{claimLocator}
Fetch all claims for a policyGET /policy/{policyLocator}/claims
Create a claimPOST /claim
Update a claimPOST /claim/{claimLocator}/update
Discard a claimPOST /claim/{claimLocator}/discard
Create a subclaim payablePOST /claims/payables
Get a payableGET /claims/payables/{payableLocator}
Reverse a payablePOST /claims/payables/reversals
Fetch a subclaim summaryGET /subClaim/{subClaimLocator}/summary
Fetch subclaim payablesGET /subClaim/{subClaimLocator}/payables
Fetch subclaim reservesGET /subClaim/{subClaimLocator}/reserves

Details

List all claims
GET /claims
    Request:
    NamePositionTypeRequired
    createdAfterTimestampqueryintegeroptional
    createdBeforeTimestapqueryintegeroptional
    pageSizequeryintegeroptional
    pagingTokenquerystringoptional
Fetch a claim
GET /claim/{claimLocator}
    Request:
    NamePositionTypeRequired
    claimLocatorpathstringrequired
    Response: ClaimResponse
Fetch all claims for a policy
GET /policy/{policyLocator}/claims
    Request:
    NamePositionTypeRequired
    policyLocatorpathstringrequired
    Response: [ClaimResponse]
Create a claim
POST /claim
ClaimCreateRequest
required
policyLocator string

optional
incidentTimestamp timestamp
notificationTimestamp timestamp
fieldValues map<string,[string]>
status string pending | open
ClaimPageResponse
required
claims [ClaimResponse]

optional
pagingToken string
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
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
SubClaimCreateRequest
required
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:
    NamePositionTypeRequired
    claimLocatorpathstringrequired
    Response: void
Create a subclaim payable
POST /claims/payables
SubClaimPayableCreateRequest
required
amount number
reserveType string loss | expense
subClaimLocator string

optional
comment string
recipient string
Get a payable
GET /claims/payables/{payableLocator}
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
SubClaimPayableReverseRequest
required
payableLocator string

optional
comment string
Fetch a subclaim summary
GET /subClaim/{subClaimLocator}/summary
    Request:
    NamePositionTypeRequired
    subClaimLocatorpathstringrequired
    Response: SubClaimSummary
SubClaimSummary
required
expensePayableAmount number
expenseReserveAmount number
lossPayableAmount number
lossReserveAmount number
reserveCurrency string
Fetch subclaim payables
GET /subClaim/{subClaimLocator}/payables
SubClaimPayableListsResponse
required
expensePayables [SubClaimPayableResponse]
lossPayables [SubClaimPayableResponse]
reserveCurrency string
Fetch subclaim reserves
GET /subClaim/{subClaimLocator}/reserves
ReservesResponse
required
ReserveHistoryResponse
required
expenseReserveHistory [ReserveVersionResponse]
lossReserveHistory [ReserveVersionResponse]
reserveCurrency string
ReserveVersionResponse
required
timestamp timestamp
amount number