Independently approve or reject a beneficiary classification

POST/accounts/{id}/retirement-inheritances/{inheritance}/decisions

Path parameters

idstringRequired

inheritancestringRequired

Headers

Idempotency-KeystringRequired

Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.

Body parameters

decisionstringRequired

Approve/reject

evidence_refstringRequired

evidence_sha256stringRequired

reasonstringRequired

Returns

200 OK

account_idstringRequired

Example acct_2tVh8nqLxq4GbDe0K1F6S9zRcWm

beneficiary_typestringRequired

customer_idstringRequired

Example cust_2tVh8nqLxq4GbDe0K1F6S9zRcWm

decedent_customer_idstringRequired

Example cust_2tVh8nqLxq4GbDe0K1F6S9zRcWm

decided_atstring · date-time or nullOptional

decided_bystringOptional

destination_ownership_revisionintegerRequired

idstringRequired

ira_typestringOptional

original_owner_customer_idstringRequired

Example cust_2tVh8nqLxq4GbDe0K1F6S9zRcWm

ownership_revisionintegerRequired

predecessor_inheritance_idstringOptional

proposed_atstring · date-timeRequired

proposed_bystringRequired

requestobjectRequired

InheritanceRequest classifies one beneficiary interest captured in the original title of a deceased holder's cash IRA or HSA.

37 child attributes

beneficiary_indexintegerRequired

categorystringRequired

contract_default_methodstringOptional

contract_permits_electionbooleanOptional

contract_refstringRequired

contract_sha256stringRequired

customer_idstringRequired

Example cust_2tVh8nqLxq4GbDe0K1F6S9zRcWm

death_report_idstringRequired

Example strp_2tVh8nqLxq4GbDe0K1F6S9zRcWm

death_revisionintegerRequired

destination_account_idstringRequired

Example acct_2tVh8nqLxq4GbDe0K1F6S9zRcWm

documentation_receivedstring · dateRequired

A business date, YYYY-MM-DD

documentation_refstringOptional

documentation_sha256stringOptional

electionstringOptional

election_datestring · dateRequired

A business date, YYYY-MM-DD

election_refstringOptional

election_sha256stringOptional

estate_account_idstringOptional

Example acct_2tVh8nqLxq4GbDe0K1F6S9zRcWm

evidence_refstringRequired

evidence_sha256stringRequired

expected_versionintegerRequired

jurisdictionstringRequired

minimum_recipient_ageintegerRequired

owner_rmd_review_idstringOptional

policy_refstringRequired

policy_sha256stringRequired

predecessor_rmd_review_idstringOptional

reasonstringRequired

relationship_refstringOptional

relationship_sha256stringOptional

restriction_idstringRequired

rmd_policy_idstringOptional

trust_account_idstringOptional

Example acct_2tVh8nqLxq4GbDe0K1F6S9zRcWm

trust_determination_refstringOptional

trust_determination_sha256stringOptional

trust_instrument_refstringOptional

trust_instrument_sha256stringOptional

scheduleobjectRequired

InheritanceSchedule is the distribution rule fixed at classification. Life expectancies are read from the reviewed Single Life Table for each year.

21 child attributes

annual_distributionsbooleanRequired

beneficiary_base_yearintegerOptional

beneficiary_birth_datestring · dateRequired

A business date, YYYY-MM-DD

beneficiary_lifestringOptional

Fixed or recalculated

date_of_deathstring · dateRequired

A business date, YYYY-MM-DD

death_year_entire_balancebooleanOptional

death_year_required_minorintegerOptional

DeathYearRequiredMinor is this beneficiary's allocated share of the requirement for the year of death that the deceased holder had not taken; DeathYearEntireBalance marks a successor whose predecessor's entire interest was due in that year.

died_before_required_beginning_datebooleanRequired

election_deadlinestring · dateRequired

A business date, YYYY-MM-DD

eligible_designatedbooleanRequired

final_distribution_yearintegerOptional

first_distribution_yearintegerOptional

majority_datestring · dateRequired

A business date, YYYY-MM-DD

methodstringRequired

owner_birth_datestring · dateRequired

A business date, YYYY-MM-DD

owner_date_of_deathstring · dateRequired

A business date, YYYY-MM-DD

owner_lifebooleanOptional

owner_required_ageintegerOptional

predecessor_date_of_deathstring · dateRequired

A business date, YYYY-MM-DD

required_beginning_datestring · dateRequired

A business date, YYYY-MM-DD

transfer_deadlinestring · dateRequired

A business date, YYYY-MM-DD

share_bpsintegerRequired

statusstringRequired

title_sharesarray of integersRequired

versionintegerRequired

wrapperstringRequired

Errors

Every error is a problem document with a stable code. See Errors.

400401403404409412413422424429500503