Skip to main content
PATCH
/
cases
/
{case_id}
/
retirement-accounts
/
{account_id}
Update retirement account
curl --request PATCH \
  --url https://api.example.com/v1/cases/{case_id}/retirement-accounts/{account_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "account_type": "traditional_ira",
  "custodian_name": "<string>",
  "account_number": "<string>",
  "status": "active",
  "balance": 123,
  "employer_name": "<string>",
  "beneficiaries": [
    {
      "name": "<string>",
      "relationship": "<string>",
      "percentage_share": 123,
      "designation": "primary"
    }
  ],
  "distribution_options": [
    "lump_sum"
  ],
  "rmd_required": true,
  "tax_treatment": "pre_tax",
  "distribution_status": "not_started",
  "institution_contact_id": "<string>",
  "notes": "<string>"
}
'
{
  "data": {
    "id": "01K9RA01AJ0T33HRYE78AN7RRR",
    "case_id": "<string>",
    "account_type": "401k",
    "custodian_name": "Fidelity Investments",
    "account_number": "***9012",
    "status": "active",
    "balance": 185000,
    "employer_name": "Acme Corporation",
    "beneficiaries": [
      {
        "name": "<string>",
        "relationship": "<string>",
        "percentage_share": 123,
        "designation": "primary"
      }
    ],
    "distribution_options": [
      "lump_sum"
    ],
    "rmd_required": true,
    "rmd_amount": 123,
    "tax_treatment": "pre_tax",
    "distribution_status": "not_started",
    "institution_contact_id": "<string>",
    "notes": "<string>",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z"
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
case_id
string
required

Unique case identifier (ULID format).

​
account_id
string
required

Body

application/json
​
account_type
enum<string>
required
Available options:
traditional_ira,
roth_ira,
401k,
403b,
457,
sep_ira,
simple_ira,
keogh,
pension,
tsp,
military_pension,
fegli,
inherited_ira,
other
​
custodian_name
string
required
​
account_number
string
​
status
enum<string>
Available options:
active,
inactive,
dormant,
distributed,
rolled_over,
closed,
unknown
​
balance
number<double>
​
employer_name
string
​
beneficiaries
object[]
​
distribution_options
enum<string>[]
Available options:
lump_sum,
rollover_to_inherited_ira,
periodic_payments,
five_year_rule,
life_expectancy
​
rmd_required
boolean
​
tax_treatment
enum<string>
Available options:
pre_tax,
post_tax_roth,
mixed
​
distribution_status
enum<string>
Available options:
not_started,
in_progress,
completed,
pending_beneficiary_docs
​
institution_contact_id
string
​
notes
string

Response

Account updated.

​
data
object