Field reference

Every field POST /claims accepts. Required fields are marked; the rest sharpen the match, and a fuller request is placed faster.

Where and when

Field	Type		Notes
`loss_address`	string	required	Street address of the damaged home
`loss_city`	string	required
`loss_state`	string	required	State or province
`loss_zip`	string	required	ZIP or postal code
`loss_lat`	number		Latitude. Send it — non-US postcodes match on coordinates only
`loss_lng`	number		Longitude
`date_of_loss`	date		`YYYY-MM-DD`. Defaults to today
`target_move_in`	date	required	`YYYY-MM-DD`
`est_length_months`	number	required	How long housing is needed. Fractions are fine: `0.5` is about two weeks
`search_radius`	number		Miles from the loss address. Defaults to your account’s setting

The household

Field	Type		Notes
`adults`	integer	required	At least 1
`children`	integer		Defaults to 0
`bedrooms`	integer	required	Minimum bedrooms, 1–20
`bathrooms`	integer	required	Minimum bathrooms, 1–20
`sqft`	integer	required	Minimum square footage
`property_type`	string	required	`apartment`, `house`, `condo`, `townhouse`
`furnishing`	string	required	`furnished`, `partial`, `unfurnished`
`accessibility_needs`	string[]		Hard requirements, not preferences
`amenities`	string[]		Preferences — they rank homes rather than exclude them
`laundry_preference`	string
`parking_preference`	string

Pets

has_pets: true makes three fields required. A landlord’s first three questions are how many, what, and what breed, and a request that says only “pets: yes” stalls on a phone call.

Field	Type		Notes
`has_pets`	boolean		Defaults to `false`
`number_of_pets`	integer	with pets
`pet_details`	string	with pets	e.g. “1 dog, 1 cat”
`pet_breeds`	string	with pets	“unknown” is an acceptable answer
`pet_types`	string
`pet_size`	string
`pet_weight`	number		Pounds

Money

Field	Type		Notes
`max_budget`	number		Monthly ceiling. Homes above it are not offered
`min_budget`	number		Defaults to 0
`ale_limit`	number		Total approved for the whole stay
`rent_payer`	string	required	`carrier`, `tpa`, `temporary_housing_company`, `housing_recipient`
`deposit_payer`	string	required	Same values
`pet_deposit_payer`	string		Same values
`payment_mode`	string		`carrier_direct_billing` (default) or `policyholder_reimbursement_in_platform`

The people

Field	Type	Notes
`policyholder_name`	string	The household. Left unnamed, it reads as “Pending” until you set it
`policyholder_email`	string	Gives them a Havnly login to choose and sign
`policyholder_phone`	string
`adjuster_name`	string	Whoever owns this request on your side
`adjuster_email`	string	The adjuster who owns it — see Who owns the request
`adjuster_phone`	string
`insurance_carrier`	string	Carrier name, when it differs from your organisation
`policy_number`	string

Your references

Field	Type	Notes
`external_id`	string	Your id for the request. Makes the call idempotent
`external_reference`	string	Your claim number, shown to your staff in Havnly
`priority`	string	`standard` (default), `priority`, `emergency`

Validation

One field at a time, with the field named:

{
  "error": {
    "code": "invalid_field",
    "message": "City is required",
    "field": "loss_city"
  }
}

422 for a field problem, 400 for a malformed body.

Submit a request Who owns it