Skip to main content
POST
/
api
/
v1
/
tax-home
Create Tax Home
curl --request POST \
  --url https://api.example.com/api/v1/tax-home \
  --header 'Content-Type: application/json' \
  --data '
{
  "address": "<string>",
  "city": "<string>",
  "state": "<string>",
  "rent_amount": 123,
  "last_visit_date": "<string>",
  "voter_reg": true,
  "drivers_license_state": "<string>",
  "property_rented_out": true
}
'

​
Request Body

​
address
string
required
Street address (max 255 chars).
​
city
string
required
City name (max 255 chars).
​
state
string
required
2-letter state code.
​
rent_amount
integer
Monthly rent or mortgage in cents. Must be ≥ 0.
​
last_visit_date
string
Date of last visit home (YYYY-MM-DD).
​
voter_reg
boolean
Whether voter registration is at this address.
​
drivers_license_state
string
2-letter state code on driver’s license.
​
property_rented_out
boolean
Whether the property is rented to tenants.

​
Response

Returns the created tax home with status 201.

​
Errors

StatusCause
400Missing required fields, invalid state code, rent_amount < 0