SLslant
Insurance Policies

Update insurance policy

Changed on

Financial terms and values; no custodian data or attachments. Numbers are masked. Imported annuity terms and parties are read-only except notes. Values use dollars; balances use cents. Party arrays replace submitted roles or accessible annuity parties. Only advisor valuations can be edited.

patch/v1/insurance_policies/{id}

Request

  • Base URL
    https://api.slant.app
  • URL
    https://api.slant.app/v1/insurance_policies/{id}
  • Auth
    HTTP bearer

Headers

Authorizationstring
Idempotency-Keystring

Request body

namestring
insurance_type'life' | 'disability' | 'ltc' | 'health' | 'property_casualty' | 'umbrella'
carrierstring nullable
policy_numberstring nullable
life_policy_type'term' | 'permanent' | 'group' nullable
permanent_policy_type'whole_life' | 'universal_life' | 'indexed_universal_life' | 'variable_universal_life' nullable
term_duration_yearsinteger nullable
convertibleboolean nullable
face_amountnumber nullable

Money in dollars.

death_benefitnumber nullable

Money in dollars.

cash_valuenumber nullable

Money in dollars.

coverage_amountnumber nullable

Money in dollars.

policy_datestring date nullable
premiumnumber nullable

Money in dollars.

premium_frequency'monthly' | 'quarterly' | 'semiannual' | 'annual' | 'single' | 'other' nullable
premium_due_datestring date nullable
current_policy_yearinteger nullable
property_casualty_typestring nullable
effective_datestring date nullable
renewal_datestring date nullable
agent_brokerstring nullable
notesstring nullable
beneficiary_idstring nullable
beneficiary_type'Person' | 'Trust' | 'Household' | 'Business' nullable
owner_idsstring[]

Replaces this role; omit to preserve existing people.

insured_idsstring[]

Replaces this role; omit to preserve existing people.

named_insured_idsstring[]

Replaces this role; omit to preserve existing people.

additional_insured_idsstring[]

Replaces this role; omit to preserve existing people.

deductiblesstring[]
custom_fieldsobject
book_idstring

Optional book context; must match the household.

disability_policy_type'individual' | 'group' nullable
ltc_policy_type'traditional' | 'hybrid' nullable
benefit_amountnumber nullable

Money in dollars.

benefit_frequency'daily' | 'monthly' nullable
benefit_period'one_year' | 'two_years' | 'three_years' | 'four_years' | 'five_years' | 'six_years' | 'seven_years' | 'ten_years' | 'thirty_days' | 'sixty_days' | 'ninety_days' | 'one_eighty_days' | 'age_65' | 'age_67' | 'age_70' | 'lifetime' nullable
elimination_period_daysinteger nullable
benefit_inflation_ratenumber nullable

Annual inflation as a decimal ratio from 0 to 1; for example, 0.035 means 3.5%.

benefit_inflation_type'simple' | 'compound' nullable
survivorship_type'first_to_die' | 'last_to_die' nullable
premium_inflation_ratenumber nullable

Annual inflation as a decimal ratio from 0 to 1; for example, 0.035 means 3.5%.

coverage_end_kind'date' | 'year' | 'age' | 'retirement' | 'end_of_plan' | 'years_after_start' | 'end_of_both_plans' nullable
coverage_end_datestring date nullable
coverage_end_valueinteger nullable
coverage_end_person_idstring nullable
premium_end_kind'date' | 'year' | 'age' | 'retirement' | 'end_of_plan' | 'years_after_start' | 'end_of_both_plans' nullable
premium_end_datestring date nullable
premium_end_valueinteger nullable
premium_end_person_idstring nullable

Response

Successful financial resource access

namestring
insurance_type'life' | 'disability' | 'ltc' | 'health' | 'property_casualty' | 'umbrella'
carrierstring nullable
policy_numberstring nullable

Masked policy number; the full number is never returned.

life_policy_type'term' | 'permanent' | 'group' nullable
permanent_policy_type'whole_life' | 'universal_life' | 'indexed_universal_life' | 'variable_universal_life' nullable
term_duration_yearsinteger nullable
convertibleboolean nullable
face_amountstring nullable

Money in dollars as a decimal string.

death_benefitstring nullable

Money in dollars as a decimal string.

cash_valuestring nullable

Money in dollars as a decimal string.

coverage_amountstring nullable

Money in dollars as a decimal string.

policy_datestring date nullable
premiumstring nullable

Money in dollars as a decimal string.

premium_frequency'monthly' | 'quarterly' | 'semiannual' | 'annual' | 'single' | 'other' nullable
premium_due_datestring date nullable
current_policy_yearinteger nullable
property_casualty_typestring nullable
effective_datestring date nullable
renewal_datestring date nullable
agent_brokerstring nullable
notesstring nullable
beneficiary_idstring nullable
beneficiary_type'Person' | 'Trust' | 'Household' | 'Business' nullable
owner_idsstring[]

Replaces this role; omit to preserve existing people.

insured_idsstring[]

Replaces this role; omit to preserve existing people.

named_insured_idsstring[]

Replaces this role; omit to preserve existing people.

additional_insured_idsstring[]

Replaces this role; omit to preserve existing people.

deductiblesstring[]
custom_fieldsobject
idstring required
created_atstring date-time
updated_atstring date-time
book_idstring
household_idstring
disability_policy_type'individual' | 'group' nullable
ltc_policy_type'traditional' | 'hybrid' nullable
benefit_amountstring nullable

Money in dollars as a decimal string.

benefit_frequency'daily' | 'monthly' nullable
benefit_period'one_year' | 'two_years' | 'three_years' | 'four_years' | 'five_years' | 'six_years' | 'seven_years' | 'ten_years' | 'thirty_days' | 'sixty_days' | 'ninety_days' | 'one_eighty_days' | 'age_65' | 'age_67' | 'age_70' | 'lifetime' nullable
elimination_period_daysinteger nullable
benefit_inflation_ratestring nullable

Annual inflation as a decimal ratio string from 0 to 1; for example, "0.035" means 3.5%.

benefit_inflation_type'simple' | 'compound' nullable
survivorship_type'first_to_die' | 'last_to_die' nullable
premium_inflation_ratestring nullable

Annual inflation as a decimal ratio string from 0 to 1; for example, "0.035" means 3.5%.

coverage_end_kind'date' | 'year' | 'age' | 'retirement' | 'end_of_plan' | 'years_after_start' | 'end_of_both_plans' nullable
coverage_end_datestring date nullable
coverage_end_valueinteger nullable
coverage_end_person_idstring nullable
premium_end_kind'date' | 'year' | 'age' | 'retirement' | 'end_of_plan' | 'years_after_start' | 'end_of_both_plans' nullable
premium_end_datestring date nullable
premium_end_valueinteger nullable
premium_end_person_idstring nullable

Changes