Skip to main content
GET
Get insurance policy

Authorizations

Authorization
string
header
required

OAuth 2.0 Bearer Token from Clerk authentication

Headers

Authorization
string

Path Parameters

id
string
required

Response

Successful financial resource access

id
string
required
name
string
insurance_type
enum<string>
Available options:
life,
disability,
ltc,
health,
property_casualty,
umbrella
carrier
string | null
policy_number
string | null

Masked policy number; the full number is never returned.

life_policy_type
enum<string> | null
Available options:
term,
permanent
permanent_policy_type
enum<string> | null
Available options:
whole_life,
universal_life,
indexed_universal_life,
variable_universal_life
term_duration_years
integer | null
convertible
boolean | null
face_amount
string | null

Money in dollars as a decimal string.

death_benefit
string | null

Money in dollars as a decimal string.

cash_value
string | null

Money in dollars as a decimal string.

coverage_amount
string | null

Money in dollars as a decimal string.

policy_date
string<date> | null
premium
string | null

Money in dollars as a decimal string.

premium_frequency
enum<string> | null
Available options:
monthly,
quarterly,
semiannual,
annual,
single,
other
premium_due_date
string<date> | null
current_policy_year
integer | null
property_casualty_type
string | null
effective_date
string<date> | null
renewal_date
string<date> | null
agent_broker
string | null
notes
string | null
beneficiary_id
string | null
beneficiary_type
enum<string> | null
Available options:
Person,
Trust,
Household,
Business
owner_ids
string[]

Replaces this role; omit to preserve existing people.

insured_ids
string[]

Replaces this role; omit to preserve existing people.

named_insured_ids
string[]

Replaces this role; omit to preserve existing people.

additional_insured_ids
string[]

Replaces this role; omit to preserve existing people.

deductibles
string[]
custom_fields
object
created_at
string<date-time>
updated_at
string<date-time>
book_id
string
household_id
string