Skip to main content
POST
Create annuity contract

Authorizations

Authorization
string
header
required

OAuth 2.0 Bearer Token from Clerk authentication

Headers

Authorization
string
Idempotency-Key
string

Body

application/json
carrier_name
string
required
contract_number
string
required
contract_type
enum<string>
required
Available options:
variable_annuity,
other_annuity
household_id
string
required

Authorized household placement.

carrier_key
string | null
product_code
string | null
product_name
string | null
status
string | null
tax_status
string | null
established_on
string<date> | null
issued_on
string<date> | null
anniversary_on
string<date> | null
matures_on
string<date> | null
notes
string | null
parties
object[]
book_id
string

Optional book context; must match the household.

Response

Successful financial resource access

id
string
required
carrier_key
string | null
carrier_name
string
contract_number
string

Masked contract number; the full number is never returned.

contract_type
enum<string>
Available options:
variable_annuity,
other_annuity
product_code
string | null
product_name
string | null
status
string | null
tax_status
string | null
established_on
string<date> | null
issued_on
string<date> | null
anniversary_on
string<date> | null
matures_on
string<date> | null
notes
string | null
parties
object[]
created_at
string<date-time>
updated_at
string<date-time>
term_authority
enum<string>
Available options:
advisor,
integration
data_provider
string | null
last_synced_at
string<date-time> | null
registration_type
string | null
placements
object[]

Only placements in accessible books.

current_values
object
values
object[]