Skip to main content
GET
/
cases
/
{case_id}
/
retirement-accounts
List retirement accounts
curl --request GET \
  --url https://api.example.com/v1/cases/{case_id}/retirement-accounts \
  --header 'Authorization: Bearer <token>'
{
  "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"
    }
  ],
  "meta": {
    "page": 1,
    "per_page": 25,
    "total_count": 142,
    "total_pages": 6,
    "next_cursor": "eyJpZCI6IjAxSzVXRjA2TUo2VDk5SFJZRTQ4QU43WE04In0=",
    "has_more": true
  }
}

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).

Query Parameters

page
integer
default:1

Page number for pagination.

Required range: x >= 1
per_page
integer
default:25

Number of items per page.

Required range: 1 <= x <= 100
account_type
enum<string>
Available options:
traditional_ira,
roth_ira,
401k,
403b,
457,
sep_ira,
simple_ira,
keogh,
pension,
tsp,
military_pension,
fegli,
inherited_ira,
other
distribution_status
enum<string>
Available options:
not_started,
in_progress,
completed,
pending_beneficiary_docs

Response

List of retirement accounts.

data
object[]
meta
object