> ## Documentation Index
> Fetch the complete documentation index at: https://api.hellosunset.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Pro Users Guide

> Managing multiple estates, running asset searches, and reviewing search results as a Pro user.

# Pro Users

Pro users can manage multiple estate cases from a single account. This is designed for estate professionals, attorneys, financial advisors, and family members handling multiple estates simultaneously.

## Plans

| Plan           | Cases          | Features                                            |
| -------------- | -------------- | --------------------------------------------------- |
| **Pro**        | Up to 50 cases | Multi-estate dashboard, all tools, priority support |
| **Enterprise** | Unlimited      | Custom integrations, dedicated support, SSO         |

## Your Profile

Retrieve your profile and plan details:

```bash theme={null}
curl "https://api.example.com/v1/users/me"
```

Response:

```json theme={null}
{
  "data": {
    "id": "01K8PU01AJ0T77HRYE78AN7AAA",
    "email": "logan@example.com",
    "first_name": "John",
    "last_name": "Johnson",
    "plan": "pro",
    "cases_limit": 50,
    "cases_count": 12,
    "organization": "Johnson Estate Services",
    "role": "owner"
  }
}
```

## Listing All Your Cases

See all estates you have access to, including cases shared with you:

```bash theme={null}
curl "https://api.example.com/v1/users/me/cases?sort_by=updated_at&sort_order=desc"
```

### Filter by your role

```bash theme={null}
# Only cases you own
curl ".../users/me/cases?role=owner"

# Cases shared with you (editor or viewer access)
curl ".../users/me/cases?role=editor"
curl ".../users/me/cases?role=viewer"
```

### Search across estates

```bash theme={null}
# Search by deceased name
curl ".../users/me/cases?search=Johnson"
```

## Roles

| Role     | Description                                                                                                                          |
| -------- | ------------------------------------------------------------------------------------------------------------------------------------ |
| `owner`  | Full control. Can delete the case, manage collaborators, and access all features.                                                    |
| `editor` | Can modify case data, upload documents, and use tools. Cannot delete the case or manage collaborators (unless explicitly permitted). |
| `viewer` | Read-only access. Can view all case data but cannot make changes.                                                                    |

## Working with Multiple Cases

Each API call targets a specific case via `case_id` in the URL:

```bash theme={null}
# Work on case A
curl "https://api.example.com/v1/cases/CASE_A_ID/deceased"
# Work on case B
curl "https://api.example.com/v1/cases/CASE_B_ID/deceased"
```

If you attempt to access a case you don't have permission for, you'll receive a `403 Forbidden` response.

***

# Asset Searches

Sunset runs asset and background searches to discover what the deceased owned: bank accounts, real estate, life insurance, retirement accounts, investments, businesses, vehicles, credit obligations, and unclaimed property. As a Pro user you can review search progress and results across every case you manage.

## Reviewing a Case's Searches

List all searches on a case, with optional filters:

```bash theme={null}
# All searches on a case
curl "https://api.example.com/v1/cases/{case_id}/searches"

# Only completed searches
curl ".../cases/{case_id}/searches?status=completed"

# Only bank account searches
curl ".../cases/{case_id}/searches?type=bank_accounts"
```

Retrieve a single search to check its status:

```bash theme={null}
curl "https://api.example.com/v1/cases/{case_id}/searches/{search_id}"
```

Response:

```json theme={null}
{
  "data": {
    "id": "01K5XC08DJ6T33HRYE78AN7GHI",
    "type": "real_estate",
    "status": "completed",
    "completed_at": "2025-09-24T12:52:00Z",
    "results_summary": "2 properties found in Cache County, UT",
    "created_at": "2025-09-24T12:00:00Z",
    "updated_at": "2025-09-24T12:52:00Z"
  }
}
```

### Search Types

| Type                 | What it looks for                                 |
| -------------------- | ------------------------------------------------- |
| `bank_accounts`      | Checking, savings, CDs, and money market accounts |
| `credit`             | Credit cards, loans, and other debts              |
| `investments`        | Brokerage and investment accounts                 |
| `life_insurance`     | Life insurance policies                           |
| `retirement`         | IRAs, 401(k)s, and pensions                       |
| `real_estate`        | Properties and land holdings                      |
| `businesses`         | Business entities and ownership interests         |
| `vehicles`           | Cars, trucks, boats, and other titled vehicles    |
| `unclaimed_property` | State unclaimed property records                  |

### Search Statuses

| Status        | Meaning                          |
| ------------- | -------------------------------- |
| `pending`     | Search is queued                 |
| `in_progress` | Sunset is actively searching     |
| `completed`   | Finished — results are available |
| `failed`      | Search could not be completed    |
| `cancelled`   | Search was cancelled             |

Initial searches typically complete within **5–14 days**. Searches cannot be deleted — they form part of the case's audit trail.

## Where Results Land

When a search completes, each discovered asset is created as a full record under the matching case resource — the search's `results_summary` is only a human-readable recap. For example, a completed `bank_accounts` search that found two accounts adds two records to:

```bash theme={null}
curl "https://api.example.com/v1/cases/{case_id}/bank-accounts"
```

The same applies to the other types: `real_estate` results appear under `/real-estate-properties`, `life_insurance` under `/life-insurance`, `businesses` under `/businesses`, and so on. Review the discovered records there — balances, institution details, and statuses — using the corresponding guide for each asset type.

## Requesting a New Search

<Note>
  Searches are initiated from the Sunset app today. An API endpoint for requesting searches programmatically is in development — see the [changelog](/changelog) for updates.
</Note>

## Reviewing Searches Across All Your Cases

Combine the cases list with per-case searches to sweep your whole book of business:

```bash theme={null}
# 1. List your cases
curl "https://api.example.com/v1/users/me/cases?sort_by=updated_at&sort_order=desc"

# 2. For each case, check for newly completed searches
curl ".../cases/{case_id}/searches?status=completed"
```
