Skip to main content
POST
Create financial account

Authorizations

Authorization
string
header
required

OAuth 2.0 Bearer Token from Clerk authentication

Headers

Authorization
string
Idempotency-Key
string

Body

application/json
name
string
required
account_type
enum<string>
required
Available options:
checking,
savings,
investment,
insurance,
unknown
household_id
string
required

Authorized household placement.

tax_advantaged_type
enum<string>
Available options:
not_applicable,
hsa,
traditional_401k,
roth_401k,
traditional_ira,
roth_ira,
education_fivetwonine,
sep_ira,
simple_ira,
solo_401k,
traditional_403b,
roth_403b,
traditional_four_five_seven,
roth_four_five_seven,
pension_plan,
profit_sharing_plan,
rollover_ira,
ugma,
utma,
non_deductible_ira,
beneficiary_ira,
traditional_401a,
coverdell_esa,
inherited_ira,
unknown,
other
other_tax_advantaged_type_label
string | null
account_number
string | null
institution_name
string | null
balance_in_cents
integer | null

Money in integer cents.

notes
string | null
owner_ids
string[]

Replaces this role; omit to preserve existing people.

custom_fields
object
book_id
string

Optional book context; must match the household.

Response

Successful financial resource access

id
string
required
name
string
account_type
enum<string>
Available options:
checking,
savings,
investment,
insurance,
unknown
tax_advantaged_type
enum<string>
Available options:
not_applicable,
hsa,
traditional_401k,
roth_401k,
traditional_ira,
roth_ira,
education_fivetwonine,
sep_ira,
simple_ira,
solo_401k,
traditional_403b,
roth_403b,
traditional_four_five_seven,
roth_four_five_seven,
pension_plan,
profit_sharing_plan,
rollover_ira,
ugma,
utma,
non_deductible_ira,
beneficiary_ira,
traditional_401a,
coverdell_esa,
inherited_ira,
unknown,
other
other_tax_advantaged_type_label
string | null
account_number
string | null

Masked account number; the full number is never returned.

institution_name
string | null
balance_in_cents
integer | null

Money in integer cents.

notes
string | null
owner_ids
string[]

Replaces this role; omit to preserve existing people.

custom_fields
object
created_at
string<date-time>
updated_at
string<date-time>
book_id
string
household_id
string
balance_as_of
string<date-time> | null