---
title: "Onboard Household"
method: POST
path: "/api/v1/households/onboarding"
tags: ["households"]
---

# Onboard Household

`POST /api/v1/households/onboarding`

## Request

- Base URL: `https://bazous.com` (the document declares no server; this is the origin it was published from)
- URL: `https://bazous.com/api/v1/households/onboarding`
- Auth: none declared. Required headers: `Idempotency-Key`

## Headers

- `Idempotency-Key` string, required

## Request body

- OnboardingRequest
  - `name` string, required
  - `currency` string, required
  - `timezone` string, required
  - `balance` union, required
    - number
    - string
  - `income_date` string, date, required
  - `income_amount` union, required
    - number
    - string
  - `income_frequency` 'weekly' | 'monthly', required

## Response `201`

Successful Response

- object

## Other responses

- `422`: Validation Error

---

[API](https://skmtc.dev/bazous/apis/bazous-api.md) · [All operations](https://skmtc.dev/bazous/apis/bazous-api/llms.txt) · [OpenAPI document](https://skmtc.dev/bazous/apis/bazous-api/revisions/e5379d45e5b3?raw)