Top Account

This API is for the Top Account resource of the Advisor API on the wealth.com platform. It allows connected systems to programmatically manage top accounts. Note: Deleting top accounts via API is currently not supported (given the irreversible nature of that operation).

A "top account" is a family in the largest sense; within a top account, you will be able to create one or more client groups, which would represent separate households or reporting groups within that top account (family).

GETadvisor-api.wealth.com/v2/top-accounts/{wid}

Get Top Account

The Get Top Account call expects a Wealth.com Id (wid) to be passed as part of the URL. The wid is unique to each top account.

Request

GET

advisor-api.wealth.com/v2/top-accounts/{wid}

  curl --location --request GET 'https://advisor-api.wealth.com/v2/top-accounts/786bb91c-35ec-49bb-bc28-1d2930d7db6a' \
    --header 'Content-Type: application/json' \
    --header 'Authorization: Bearer xxxxxxxxxxxxx'

Get Top Account Response Object

Name
wid
Type
string (Max 64)
Description
Wealth.com unique identifier for the top account.
Name
external_id
Type
string (Max 255)
Description
Your firm's unique identifier for the top account.
Name
name
Type
string (Max 255)
Description
The name of the top account.

Response

{
   "wid": "786bb91c-35ec-49bb-bc28-1d2930d7db6a",
   "external_id": "cn4910ny98ec9vb3ghj",
   "name": "Doe Family"
}

POSTadvisor-api.wealth.com/v2/top-accounts/

Add Top Account

The Add Top Account Request Object model contains your firm's unique identifier for the top account as well as the top account name.

Add Top Account Request Object

Name
external_id
Type
string (Max 255)
Description
Your firm's unique identifier for the top account.
Name
name
Type
string (Max 255)
Description
The name of the top account.

Request

POST

advisor-api.wealth.com/v2/top-accounts

  curl --location 'https://advisor-api.wealth.com/v2/top-accounts/' \
    --header 'Content-Type: application/json' \
    --header 'Authorization: Bearer xxxxxxxxxxxxx' \
    --data-raw '{
        "external_id": "cn4910ny98ec9vb3ghj",
        "name": "Doe Family"
    }'

Add Top Account Response Object

Name
wid
Type
string (Max 64)
Description
Wealth.com unique identifier for the top account.

Response

{
   "wid": "786bb91c-35ec-49bb-bc28-1d2930d7db6a"
}

PATCHadvisor-api.wealth.com/v2/top-accounts/{wid}

Update Top Account

The Update Top Account Object model contains your firm's unique identifier for the top account as well as the top account name.

Update Top Account Request Object

Name
external_id
Type
string (Max 255), optional
Description
Your firm's unique identifier for the top account.
Name
name
Type
string (Max 255), optional
Description
The name of the top account.

Request

PATCH

advisor-api.wealth.com/v2/top-accounts/{wid}

curl --location 'https://advisor-api.wealth.com/v2/top-accounts/786bb91c-35ec-49bb-bc28-1d2930d7db6a' -X PATCH \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer xxxxxxxxxxxxx' \
  --data-raw '{
      "name": "Doe-Jones Family"
    }'

Update Top Account Response Object

See the Get Top Account response object.