Skip to main content
POST
Create household

Authorizations

Authorization
string
header
required

API key authentication. Use Authorization: Bearer idx_....

Body

application/json
name
string
required
Minimum string length: 1
dsueReceived
number | null
deceasedSpouseName
string | null
dsueDateOfDeath
string<date> | null
metadata
object
primaryClient
object
coClient
object
primaryClientAsDonor
boolean
coClientAsDonor
boolean

Response

Household created

household
object
required

Created household; full shape matches the service response.