First Notice of Loss ("FNOL") API

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 FNOLs by policy locator	GET/claim/{tenantLocator}/fnols/policy/{policyLocator}/list
List FNOL History	GET/claim/{tenantLocator}/fnols/{locator}/history/list
Set FNOL number	POST/claim/{tenantLocator}/fnols/{locator}/number/set
Generate FNOL 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}
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
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
Unknown: fetchClaimEventDefinitions

Fundamental Operations

Create FNOL

Create FNOLaddFnol

POST/claim/{tenantLocator}/fnols

Parameters

Name	In	Type	Required	Description
`tenantLocator`	path	`uuid`	Yes

Request:FnolCreateRequest

Response:FnolResponse

Security Group:fnols

Permission:

write

FnolCreateRequest

Required properties

Property	Type	Description
`autoValidate`	`boolean`
`type`	`string`
`data`	`map<string, object>`
`contacts`	`ContactRoles[]`
`losses`	`FnolLoss[]`

Optional properties

Property	Type	Description
`accountLocator`	`ulid?`
`policyLocator`	`ulid?`
`region`	`string?`
`incidentSummary`	`string?`
`incidentTime`	`datetime?`
`incidentTimezone`	`string?`

FnolResponse

Required properties

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

Optional properties

Property	Type	Description
`accountLocator`	`ulid?`
`policyLocator`	`ulid?`
`segmentLocator`	`ulid?`
`region`	`string?`
`anonymizedAt`	`datetime?`
`fnolNumber`	`string?`
`incidentSummary`	`string?`
`incidentTime`	`datetime?`
`incidentTimezone`	`string?`
`updatedAt`	`datetime?`
`updatedBy`	`uuid?`
`validationResult`	`ValidationResult?`

Validate FNOL

Validate FNOLvalidate

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

Parameters

Name	In	Type	Required	Description
`tenantLocator`	path	`uuid`	Yes
`locator`	path	`ulid`	Yes

Response:FnolResponse

Security Group:fnols

Permission:

write

Complete FNOL

Complete FNOLcomplete

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

Parameters

Name	In	Type	Required	Description
`tenantLocator`	path	`uuid`	Yes
`locator`	path	`ulid`	Yes

Response:FnolResponse

Security Group:fnols

Permission:

write

Discard FNOL

Discard FNOLdiscard

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

Parameters

Name	In	Type	Required	Description
`tenantLocator`	path	`uuid`	Yes
`locator`	path	`ulid`	Yes

Response:FnolResponse

Security Group:fnols

Permission:

write

Reject FNOL

Reject FNOLreject

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

Parameters

Name	In	Type	Required	Description
`tenantLocator`	path	`uuid`	Yes
`locator`	path	`ulid`	Yes

Response:FnolResponse

Security Group:fnols

Permission:

write

Update FNOL

Update FNOLpatchFnol

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

Parameters

Name	In	Type	Required	Description
`tenantLocator`	path	`uuid`	Yes
`locator`	path	`ulid`	Yes

Request:FnolPatchRequest

Response:FnolResponse

Security Group:fnols

Permission:

write

FnolPatchRequest

Required properties

Property	Type	Description
`removeData`	`map<string, object>`
`setData`	`map<string, object>`

Optional properties

Property	Type	Description
`accountLocator`	`ulid?`
`policyLocator`	`ulid?`
`region`	`string?`
`incidentSummary`	`string?`
`incidentTime`	`datetime?`
`incidentTimezone`	`string?`

Create claim from FNOL

Create claim from FNOLcreateClaim

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

Parameters

Name	In	Type	Required
`tenantLocator`	path	`uuid`	Yes
`locator`	path	`ulid`	Yes
`markAsComplete`	query	`boolean?`	No

Response:FnolResponse

Security Group:fnols

Permission:

write

Data Fetch

Get FNOL

Get FNOLgetFnol

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

Parameters

Name	In	Type	Required	Description
`tenantLocator`	path	`uuid`	Yes
`locator`	path	`ulid`	Yes

Response:FnolResponse

Security Group:fnols

Permission:

read

Get FNOL by number

Get FNOL by numbergetFnolByNumber

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

Parameters

Name	In	Type	Required	Description
`tenantLocator`	path	`uuid`	Yes
`number`	path	`string`	Yes

Response:FnolResponse

Security Group:fnols

Permission:

read

Get FNOL claim locators

Get FNOL claim locatorsgetFnolClaimLocators

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

Parameters

Name	In	Type	Required	Description
`tenantLocator`	path	`uuid`	Yes
`locator`	path	`ulid`	Yes

Response:ulid[]

Security Group:fnols

Permission:

read

List FNOLs

List FNOLslistFnol

GET/claim/{tenantLocator}/fnols/list

Parameters

Name	In	Type	Required
`tenantLocator`	path	`uuid`	Yes
`offset`	query	`integer?`	No
`count`	query	`integer?`	No

Response:ListPageResponseFnolResponse

Security Group:fnols

Permission:

read

List FNOLs by policy locator

List FNOLs by policy locatorlistFnolsByPolicyLocator

GET/claim/{tenantLocator}/fnols/policy/{policyLocator}/list

Parameters

Name	In	Type	Required
`tenantLocator`	path	`uuid`	Yes
`policyLocator`	path	`ulid`	Yes
`offset`	query	`integer?`	No
`count`	query	`integer?`	No

Response:ListPageResponseFnolResponse

Security Group:fnols

Permissions:

read,list

ListPageResponseFnolResponse

Required properties

Property	Type	Description
`listCompleted`	`boolean`
`items`	`FnolResponse[]`

List FNOL History

List FNOL HistorylistFnolHistory

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

Parameters

Name	In	Type	Required
`tenantLocator`	path	`uuid`	Yes
`locator`	path	`ulid`	Yes
`offset`	query	`integer?`	No
`count`	query	`integer?`	No

Response:ListPageResponseFnolResponse

Security Group:fnols

Permission:

read

Numbering

Set FNOL number

Set FNOL numbersetFnolNumber

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

Parameters

Name	In	Type	Required
`tenantLocator`	path	`uuid`	Yes
`locator`	path	`ulid`	Yes
`fnolNumber`	query	`string`	Yes

Response:FnolResponse

Security Group:fnols

Permission:

write

Generate FNOL number

Generate FNOL numbergenerateFnolNumber

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

Parameters

Name	In	Type	Required	Description
`tenantLocator`	path	`uuid`	Yes
`locator`	path	`ulid`	Yes

Response:FnolResponse

Security Group:fnols

Permission:

write

Contacts

Add FNOL contact

Add FNOL contactaddFnolContact

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

Parameters

Name	In	Type	Required	Description
`tenantLocator`	path	`uuid`	Yes
`fnolLocator`	path	`ulid`	Yes

Request:ContactRoles

Response:FnolResponse

Security Group:fnols

Permission:

write

ContactRoles

Required properties

Property	Type	Description
`contactLocator`	`ulid`
`roles`	`string[]`

Delete FNOL contact

Delete FNOL contactdeleteFnolContact

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

Parameters

Name	In	Type	Required
`tenantLocator`	path	`uuid`	Yes
`fnolLocator`	path	`ulid`	Yes
`contactLocator`	path	`ulid`	Yes

Response:FnolResponse

Security Group:fnols

Permission:

write

Update FNOL contact

Update FNOL contactupdateFnolContact

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

Parameters

Name	In	Type	Required
`tenantLocator`	path	`uuid`	Yes
`fnolLocator`	path	`ulid`	Yes
`contactLocator`	path	`ulid`	Yes

Request:ContactAssociationUpdateRequest

Response:FnolResponse

Security Group:fnols

Permission:

write

Loss Management

Add losses

Add lossesaddLosses

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

Parameters

Name	In	Type	Required	Description
`tenantLocator`	path	`uuid`	Yes
`locator`	path	`ulid`	Yes

Request:FnolLoss[]

Response:FnolResponse

Security Group:fnols

Permission:

write

Check losses

Check lossescheckLosses

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

Parameters

Name	In	Type	Required	Description
`tenantLocator`	path	`uuid`	Yes
`locator`	path	`ulid`	Yes

Response:FnolResponse

Security Group:fnols

Permission:

write

Delete losses

Delete lossesdeleteLosses

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

Parameters

Name	In	Type	Required	Description
`tenantLocator`	path	`uuid`	Yes
`locator`	path	`ulid`	Yes

Request:ulid[]

Response:FnolResponse

Security Group:fnols

Permission:

write

Exclude loss

Exclude lossexcludeLoss

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

Parameters

Name	In	Type	Required
`tenantLocator`	path	`uuid`	Yes
`fnolLocator`	path	`ulid`	Yes
`lossLocator`	path	`ulid`	Yes

Response:FnolLoss

Security Group:fnols

Permission:

write

FnolLoss

Required properties

Property	Type	Description
`locator`	`ulid`
`fnolLossState`	`Enum pending \| valid \| excluded`
`category`	`string`
`type`	`string`
`data`	`map<string, object>`

Optional properties

Property	Type	Description
`coverageElementLocator`	`ulid?`
`exposureElementLocator`	`ulid?`
`anonymizedAt`	`datetime?`
`validationResult`	`ValidationResult?`

Include loss

Include lossincludeLoss

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

Parameters

Name	In	Type	Required
`tenantLocator`	path	`uuid`	Yes
`fnolLocator`	path	`ulid`	Yes
`lossLocator`	path	`ulid`	Yes

Response:FnolLoss

Security Group:fnols

Permission:

write

Update loss

Update lossupdateLoss

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

Parameters

Name	In	Type	Required
`tenantLocator`	path	`uuid`	Yes
`fnolLocator`	path	`ulid`	Yes
`lossLocator`	path	`ulid`	Yes

Request:FnolLossPatchRequest

Response:FnolLoss

Security Group:fnols

Permission:

write

FnolLossPatchRequest

Required properties

Property	Type	Description
`removeData`	`map<string, object>`
`setData`	`map<string, object>`

Optional properties

Property	Type	Description
`coverageElementLocator`	`ulid?`
`exposureElementLocator`	`ulid?`
`fnolLossState`	`Enum? pending \| valid \| excluded`
`type`	`string?`

Reset loss

Reset lossresetLoss

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

Parameters

Name	In	Type	Required
`tenantLocator`	path	`uuid`	Yes
`fnolLocator`	path	`ulid`	Yes
`lossLocator`	path	`ulid`	Yes

Response:FnolLoss

Security Group:fnols

Permission:

write

Events

List events

ClaimServiceEventTypeDefinitions

Required properties

Property	Type	Description
`fnolEvents`	`FnolEvents`

First Notice of Loss ("FNOL") API

Fundamental Operations

Create FNOL

Validate FNOL

Complete FNOL

Discard FNOL

Reject FNOL

Update FNOL

Create claim from FNOL

Data Fetch

Get FNOL

Get FNOL by number

Get FNOL claim locators

List FNOLs

List FNOLs by policy locator

List FNOL History

Numbering

Set FNOL number

Generate FNOL number

Contacts

Add FNOL contact

Delete FNOL contact

Update FNOL contact

Loss Management

Add losses

Check losses

Delete losses

Exclude loss

Include loss

Update loss

Reset loss

Events

List events

See Also

On this page