external_id, the claim number, the adjuster, the date of loss, the policy number, the carrier’s name, the loss location and the policyholder (a first and last name or a company name, and a phone number or an email address). Everything on this page is optional. Send what your claims system knows, and the adjuster starts with it already filled in instead of typing it.
The API reference lists every field of a claim. This page explains the building, flood map, date, coverage and estimate details, and the two combinations the API refuses. Carrier details have their own page.
Where the adjuster sees them
In the OSA app, an accepted claim has a Back Office screen that holds the claim’s details. Each field on this page fills in the Back Office field named in the tables below. The adjuster can still change any of them in the app.Building and flood map details
These go insidebuilding and appear under Building/Rating Information in Back Office.
A first floor 1 foot 6 inches high is sent as
"first_floor_height_feet": 1, "first_floor_height_inches": 6.
building also takes occupancy_type and building_type. Only certain pairs of those two are accepted: see Occupancy and building type.
FIRM status
FIRM stands for Flood Insurance Rate Map.building.firm_status says whether the building dates from before or after its community’s first map:
pre_firm: built or substantially improved on or before 31 December 1974, or before the community’s initial Flood Insurance Rate Map (FIRM) took effect, whichever is later.post_firm: built or substantially improved after that.
Flood zones
building.flood_zone accepts these 72 values. They are written as FEMA writes them on the Flood Insurance Rate Map, in capital letters, and must be sent exactly as listed.
More zones may be added later. Any other value is refused with
422 validation_failed, so if the zone on your record isn’t in the list, leave flood_zone out.
Dates of contact and inspection
These two sit at the top level of the claim, besidereported_date, and appear under Claim Information in Back Office. Send them when they have already happened, for example on a claim that is being reassigned.
inspection_date fills in the date only. It does not create an appointment in the app.
Like the date of loss, these are calendar dates and are never converted between time zones.
Coverage and estimate figures
- When you don’t send
coverages.special_limits_cap, the app uses the NFIP standard of $2,500. estimateis an object of its own at the top level of the claim. Send the tax rate as a fraction, not a percentage: 7% is0.07, not7. A value above 1 is refused with422 validation_failed.
Example
The optional details on this page, as part of aPOST /v1/claims body:
Rules that compare two fields
Most validation looks at one field at a time. Two rules compare one field with another. A request that breaks either is refused with422 validation_failed, and nothing is created.
- Occupancy and building type.
building.building_typemust go withbuilding.occupancy_type. The allowed pairs are in Occupancy and building type. - Policy dates.
policy.expiration_datemust not be earlier thanpolicy.effective_date. The same day for both is accepted. The rule applies only when you send both dates.
code and on the pointer in errors. The wording of detail may change. See Errors.
Reading them back
GET /v1/claims/{id} and GET /v1/claims return each of these fields as you sent it. Optional fields you didn’t send are left out of the response. The adjuster’s later edits in the app don’t change what the API returns.