First Notice of Loss (“FNOL”) API

Endpoint Index

Action	Endpoint
Create FNOL	POST /claim/{tenantLocator}/fnols
Validate FNOL	PATCH /claim/{tenantLocator}/fnols/{locator}/validate
Complete FNOL	PATCH /claim/{tenantLocator}/fnols/{locator}/complete
Discard FNOL	PATCH /claim/{tenantLocator}/fnols/{locator}/discard
Reject FNOL	PATCH /claim/{tenantLocator}/fnols/{locator}/reject
Update FNOL	PATCH /claim/{tenantLocator}/fnols/{locator}
Create claim from FNOL	PATCH /claim/{tenantLocator}/fnols/{locator}/createClaim
Get FNOL	GET /claim/{tenantLocator}/fnols/{locator}
Get FNOL by number	GET /claim/{tenantLocator}/fnols/number/{number}
Get FNOL claim locators	GET /claim/{tenantLocator}/fnols/{locator}/claims
List FNOLs	GET /claim/{tenantLocator}/fnols/list
List FNOL History	GET /claim/{tenantLocator}/fnols/{locator}/history/list
Set FNOL number	POST /claim/{tenantLocator}/fnols/{locator}/number/set
Regenerate number	POST /claim/{tenantLocator}/fnols/{locator}/number/generate
Add FNOL contact	POST /claim/{tenantLocator}/fnols/{fnolLocator}/contacts
Delete FNOL contact	DELETE /claim/{tenantLocator}/fnols/{fnolLocator}/contacts/{contactLocator}
Fetch FNOL contacts	GET /claim/{tenantLocator}/fnols/{fnolLocator}/contacts
Update FNOL contact	PATCH /claim/{tenantLocator}/fnols/{fnolLocator}/contacts/{contactLocator}
Add losses	PUT /claim/{tenantLocator}/fnols/{locator}/losses
Check losses	PATCH /claim/{tenantLocator}/fnols/{locator}/losses/coverageCheck
Delete losses	DELETE /claim/{tenantLocator}/fnols/{locator}/losses
Exclude loss	PATCH /claim/{tenantLocator}/fnols/{fnolLocator}/losses/{lossLocator}/exclude
Get FNOL losses	GET /claim/{tenantLocator}/fnols/{locator}/losses
Include loss	PATCH /claim/{tenantLocator}/fnols/{fnolLocator}/losses/{lossLocator}/include
Update loss	PATCH /claim/{tenantLocator}/fnols/{fnolLocator}/losses/{lossLocator}
Reset loss	PATCH /claim/{tenantLocator}/fnols/{fnolLocator}/losses/{lossLocator}/reset
List events	GET /claim/events

Fundamental Operations

Create FNOL

addFnol

POST /claim/{tenantLocator}/fnols

Request Parameters:

Name	Position	Type	Required
tenantLocator	path	uuid	required

Request:FnolCreateRequest
Response:FnolResponse
Security Group:fnols   Permission:write

FnolCreateRequest

required
autoValidate boolean
type string
data map<string,object>
contacts ContactRoles[]
losses FnolLoss[]

optional
accountLocator string?
policyLocator string?
region string?
incidentSummary string?
incidentTime datetime?
incidentTimezone string?

FnolResponse

required
locator string
fnolState Enum completed | discarded | draft | onClaim | rejected | validated
type string
data map<string,object>
createdAt datetime
createdBy uuid
claims string[]
contacts ContactRoles[]
losses FnolLoss[]

optional
accountLocator string?
policyLocator string?
segmentLocator string?
region string?
fnolNumber string?
incidentSummary string?
incidentTime datetime?
incidentTimezone string?
updatedAt datetime?
updatedBy uuid?
validationResult ValidationResult?

Validate FNOL

validate

PATCH /claim/{tenantLocator}/fnols/{locator}/validate

Request Parameters:

Name	Position	Type	Required
tenantLocator	path	uuid	required
locator	path	string	required

Response:FnolResponse
Security Group:fnols   Permission:write

Complete FNOL

complete

PATCH /claim/{tenantLocator}/fnols/{locator}/complete

Request Parameters:

Name	Position	Type	Required
tenantLocator	path	uuid	required
locator	path	string	required

Response:FnolResponse
Security Group:fnols   Permission:write

Discard FNOL

discard

PATCH /claim/{tenantLocator}/fnols/{locator}/discard

Request Parameters:

Name	Position	Type	Required
tenantLocator	path	uuid	required
locator	path	string	required

Response:FnolResponse
Security Group:fnols   Permission:write

Reject FNOL

reject

PATCH /claim/{tenantLocator}/fnols/{locator}/reject

Request Parameters:

Name	Position	Type	Required
tenantLocator	path	uuid	required
locator	path	string	required

Response:FnolResponse
Security Group:fnols   Permission:write

Update FNOL

patchFnol

PATCH /claim/{tenantLocator}/fnols/{locator}

Request Parameters:

Name	Position	Type	Required
tenantLocator	path	uuid	required
locator	path	string	required

Request:FnolPatchRequest
Response:FnolResponse
Security Group:fnols   Permission:write

FnolPatchRequest

required
removeData map<string,object>
setData map<string,object>

optional
accountLocator string?
policyLocator string?
region string?
incidentSummary string?
incidentTime datetime?
incidentTimezone string?

Create claim from FNOL

createClaim

PATCH /claim/{tenantLocator}/fnols/{locator}/createClaim

Request Parameters:

Name	Position	Type	Required
tenantLocator	path	uuid	required
locator	path	string	required
markAsComplete	query	boolean?	optional

Response:FnolResponse
Security Group:fnols   Permission:write

Data Fetch

Get FNOL

getFnol

GET /claim/{tenantLocator}/fnols/{locator}

Request Parameters:

Name	Position	Type	Required
tenantLocator	path	uuid	required
locator	path	string	required

Response:FnolResponse
Security Group:fnols   Permission:read

Get FNOL by number

getFnolByNumber

GET /claim/{tenantLocator}/fnols/number/{number}

Request Parameters:

Name	Position	Type	Required
tenantLocator	path	uuid	required
number	path	string	required

Response:FnolResponse
Security Group:fnols   Permission:read

Get FNOL claim locators

getFnolClaimLocators

GET /claim/{tenantLocator}/fnols/{locator}/claims

Request Parameters:

Name	Position	Type	Required
tenantLocator	path	uuid	required
locator	path	string	required

Response:string[]
Security Group:fnols   Permission:read

List FNOLs

listFnol

GET /claim/{tenantLocator}/fnols/list

Request Parameters:

Name	Position	Type	Required
tenantLocator	path	uuid	required
offset	query	int?	optional
count	query	int?	optional

Response:ListPageResponseFnolResponse
Security Group:fnols   Permission:read

ListPageResponseFnolResponse

required
listCompleted boolean
items FnolResponse[]

List FNOL History

listFnolHistory

GET /claim/{tenantLocator}/fnols/{locator}/history/list

Request Parameters:

Name	Position	Type	Required
tenantLocator	path	uuid	required
locator	path	string	required
offset	query	int?	optional
count	query	int?	optional

Response:ListPageResponseFnolResponse
Security Group:fnols   Permission:read

Numbering

Set FNOL number

setFnolNumber

POST /claim/{tenantLocator}/fnols/{locator}/number/set

Request Parameters:

Name	Position	Type	Required
tenantLocator	path	uuid	required
locator	path	string	required
fnolNumber	query	string	required

Response:FnolResponse
Security Group:fnols   Permission:write

Regenerate number

regenerateNumber

POST /claim/{tenantLocator}/fnols/{locator}/number/generate

Request Parameters:

Name	Position	Type	Required
tenantLocator	path	uuid	required
locator	path	string	required

Response:FnolResponse
Security Group:fnols   Permission:write

Contacts

Add FNOL contact

addFnolContact

POST /claim/{tenantLocator}/fnols/{fnolLocator}/contacts

Request Parameters:

Name	Position	Type	Required
tenantLocator	path	uuid	required
fnolLocator	path	string	required

Request:ContactRoles
Response:FnolResponse
Security Group:fnols   Permission:write

ContactRoles

required
contactLocator string
roles string[]

Delete FNOL contact

deleteFnolContact

DELETE /claim/{tenantLocator}/fnols/{fnolLocator}/contacts/{contactLocator}

Request Parameters:

Name	Position	Type	Required
tenantLocator	path	uuid	required
fnolLocator	path	string	required
contactLocator	path	string	required

Response:FnolResponse
Security Group:fnols   Permission:write

Fetch FNOL contacts

fetchFnolContacts

GET /claim/{tenantLocator}/fnols/{fnolLocator}/contacts

Request Parameters:

Name	Position	Type	Required
tenantLocator	path	uuid	required
fnolLocator	path	string	required

Response:ContactRoles[]
Security Group:fnols   Permission:write

Update FNOL contact

updateFnolContact

PATCH /claim/{tenantLocator}/fnols/{fnolLocator}/contacts/{contactLocator}

Request Parameters:

Name	Position	Type	Required
tenantLocator	path	uuid	required
fnolLocator	path	string	required
contactLocator	path	string	required

Request:ContactAssociationUpdateRequest
Response:FnolResponse
Security Group:fnols   Permission:write

Loss Management

Add losses

addLosses

PUT /claim/{tenantLocator}/fnols/{locator}/losses

Request Parameters:

Name	Position	Type	Required
tenantLocator	path	uuid	required
locator	path	string	required

Request:FnolLoss[]
Response:FnolResponse
Security Group:fnols   Permission:write

Check losses

checkLosses

PATCH /claim/{tenantLocator}/fnols/{locator}/losses/coverageCheck

Request Parameters:

Name	Position	Type	Required
tenantLocator	path	uuid	required
locator	path	string	required

Response:FnolResponse
Security Group:fnols   Permission:write

Delete losses

deleteLosses

DELETE /claim/{tenantLocator}/fnols/{locator}/losses

Request Parameters:

Name	Position	Type	Required
tenantLocator	path	uuid	required
locator	path	string	required

Request:string[]
Response:FnolResponse
Security Group:fnols   Permission:write

Exclude loss

excludeLoss

PATCH /claim/{tenantLocator}/fnols/{fnolLocator}/losses/{lossLocator}/exclude

Request Parameters:

Name	Position	Type	Required
tenantLocator	path	uuid	required
fnolLocator	path	string	required
lossLocator	path	string	required

Response:FnolLoss
Security Group:fnols   Permission:write

Get FNOL losses

getFnolLosses

GET /claim/{tenantLocator}/fnols/{locator}/losses

Request Parameters:

Name	Position	Type	Required
tenantLocator	path	uuid	required
locator	path	string	required

Response:FnolLoss[]
Security Group:fnols   Permission:read

FnolLoss

required
locator string
fnolLossState Enum excluded | pending | valid
category string
type string
data map<string,object>

optional
coverageElementLocator string?
exposureElementLocator string?
validationResult ValidationResult?

Include loss

includeLoss

PATCH /claim/{tenantLocator}/fnols/{fnolLocator}/losses/{lossLocator}/include

Request Parameters:

Name	Position	Type	Required
tenantLocator	path	uuid	required
fnolLocator	path	string	required
lossLocator	path	string	required

Response:FnolLoss
Security Group:fnols   Permission:write

Update loss

updateLoss

PATCH /claim/{tenantLocator}/fnols/{fnolLocator}/losses/{lossLocator}

Request Parameters:

Name	Position	Type	Required
tenantLocator	path	uuid	required
fnolLocator	path	string	required
lossLocator	path	string	required

Request:FnolLossPatchRequest
Response:FnolLoss
Security Group:fnols   Permission:write

FnolLossPatchRequest

required
removeData map<string,object>
setData map<string,object>

optional
coverageElementLocator string?
exposureElementLocator string?
fnolLossState Enum? excluded | pending | valid
type string?

Reset loss

resetLoss

PATCH /claim/{tenantLocator}/fnols/{fnolLocator}/losses/{lossLocator}/reset

Request Parameters:

Name	Position	Type	Required
tenantLocator	path	uuid	required
fnolLocator	path	string	required
lossLocator	path	string	required

Response:FnolLoss
Security Group:fnols   Permission:write

Events

List events

listEvents

GET /claim/events

Response:void
Security Group:public   Permission:public