Skip to main content
POST
Create annuity contract value

Authorizations

Authorization
string
header
required

OAuth 2.0 Bearer Token from Clerk authentication

Headers

Authorization
string
Idempotency-Key
string

Path Parameters

annuity_contract_id
string
required

Body

application/json
kind
enum<string>
required
Available options:
accumulation_value,
surrender_value,
surrender_charge,
death_benefit,
premiums_paid_to_date,
cash_value,
loan_value
amount
number
required

Money in dollars.

as_of_date
string<date>
required
book_id
string

Optional book context; must match the household.

Response

Successful financial resource access

id
string
required
kind
enum<string>
Available options:
accumulation_value,
surrender_value,
surrender_charge,
death_benefit,
premiums_paid_to_date,
cash_value,
loan_value
amount
string | null

Money in dollars as a decimal string.

as_of_date
string<date>
created_at
string<date-time>
updated_at
string<date-time>
annuity_contract_id
string
source_kind
enum<string>
Available options:
integration,
statement,
advisor