Appendix
Feature Flags
We allow feature flags to be turned on/off using headers following the pattern of
x-feature-fnol--name
where name is a feature. using the strings on
or off
to put the feature on or off.
The current available feature flags are:
x-feature-fnol--error-shape
This flag is off by default, and re-shapes the error array in 422 responses for Claim Submission, examples can be seen in the claim submission responses in this documentation
Section Field Types
These are the section field types which are possible in the FNOL
string
return a string
email
return a string representation of a valid email (eg. "[email protected]")
date
return a string representation of a date (eg. "2019-03-25")
datetime
return a string representation of a date and time (eg. "2019-09-09 12:15:31")
numeric
return a number
url
return a valid url
boolean
return true or false (JSON boolean)
enum
return one of the options for the field (eg: "red")
geolocation
return a JSON object with latitude and longitude properties
file
return array of file UUIDs, obtained from the file upload endpoint
set
return an array of selected options for the field
country
return a ISO 3166-2 country code (eg. "AU")
currency
return a ISO 4217 currency code (eg. "AUD")
Section Field Validations
These are the validations currently supported for a section field.
length
how short/long a
string
field should beoptions:
min
,max
numeric
how low/high a
numeric
field should beoptions
min
,max
multiselect
how many items should be included in an array (used with
set
fields)options
min
,max
float
numeric
field should include decimal(s)no options
Status Categories / External Statuses
All claim statuses are grouped into a finite set of what we call "external statuses" or "status categories", that are used for easier communicating the status of a claim. The following is the list of these statuses:
Submitted
Under Assessment
Action Required
Payment Processing
Payment Complete
Processing
Declined
Settled
Duplicate Claim
Under Review
Closed
Withdrawn
Typically claims are considered completed when they are either in Declined
, Settled
or Payment Sent
status - but in reality, it could be any of the statuses below and including the "payment sent" one.
Due to the nature of insurance claims, most claims do not truly become "closed" for a long period of time (ie. while the policy is in effect). Some of these other statuses are there to capture very special cases.
Last updated