Asset

This API is for the Asset resource of the Advisor API on the wealth.com platform. It allows connected systems to programmatically add, update and delete client assets. This can save clients time and not have them duplicate the effort of managing assets on multiple platforms.

Note: If your API user is set up to have access to multiple advisors, you will need to provide advisor_id and team_id as query parameters on all asset requests.

GETadvisor-api.wealth.com/v1/clients/{wid}/assets

List Assets

Returns all assets for specified client. Client is identified by the wid path parameter.

Request

GET

advisor-api.wealth.com/v1/clients/{wid}/assets

  curl --location --request GET 'https://advisor-api.wealth.com/v1/clients/2d6fb3ee-1617-4ee2-b402-6dd0e4449c85/assets' \
    --header 'Content-Type: application/json' \
    --header 'Authorization: Basic xxxxxxxxxxxxx'

List Assets Response Object

Get Assets return an array of assets objects for the client.

Name
id
Type
string (Max 255)
Description
Wealth.com unique identifier for the asset.
Name
name
Type
string (Max 255)
Description
The name of the asset.
Name
asset_type
Type
string enum
Description
Wealth.com asset type. One of Asset Types
Name
estimated_value
Type
number (optional)
Description
Wealth.com asset estimated value if specified.
Name
as_of_date
Type
date (ISO 8601)
Description
The date the asset was last updated.
Name
description
Type
string (Max 255)
Description
The description of the Asset.

Real Estate-specific additional properties

Name
street_address
Type
string
Description
The first line of an address.
Name
street_address2
Type
string
Description
The second line of an address.
Name
city
Type
string
Description
The city of the address.
Name
state
Type
string
Description
The state name of the address.
Name
zip_code
Type
string (Max 255)
Description
The zip code of the address.
Name
purchase_date
Type
date (ISO 8601)
Description
The date the property was purchased.
Name
purchase_cost
Type
number
Description
The purchase price of the property.
Name
category
Type
string enum
Description
Real Estate category. One of Real Estate Categories
Name
neighborhood
Type
string
Description
The neighborhood of the property.
Name
country_code
Type
string
Description
Country code of the address.
Name
use_estimation_by_zillow
Type
boolean
Description
True if the estimated value is provided&updated by Zillow.

Response

[{
   "id": "BywaJOaAIkOnJhp35u0qvA",
   "name": "Primary home",
   "asset_type": "RealEstate",
   "as_of_date": "2022-12-16T12:32:39+00:00",
   "primary_asset_category": "RealEstate",
   "street_address": "444 Washington Street",
   "city": "San Francisco",
   "state": "California",
   "country_code": "United States",
   "zip_code": "94111",
   "use_estimation_by_zillow": true
},
{
   "id": "cJCCwvkuGkSvcVQQgA0DJg",
   "name": "Bla",
   "asset_type": "Saving",
   "estimated_value": 100000,
   "as_of_date": "2023-07-27T20:18:18+00:00",
   "description_for_estate": "",
   "primary_asset_category": "Cash"
},
{
   "id": "Gq4eMC2W70qsoPJa2aLPtw",
   "name": "brokerage asset test1",
   "asset_type": "Brokerage",
   "estimated_value": 123456,
   "as_of_date": "2024-01-25T19:07:47+00:00",
   "description": "brokerage asset test description 1",
   "primary_asset_category": "Investment",
   "purchase_cost": 100,
   "location": "Earth"
}]

GETadvisor-api.wealth.com/v1/clients/{wid}/assets/{asset_id}

Get Asset

The GET asset call expects an asset Id to be passed on the URL. The asset id is unique to each asset.

Request

GET

advisor-api.wealth.com/v1/clients/{wid}/assets/{asset_id}

  curl --location --request GET 'https://advisor-api.wealth.com/v1/clients/2d6fb3ee-1617-4ee2-b402-6dd0e4449c85/assets/BywaJOaAIkOnJhp35u0qvA' \
    --header 'Content-Type: application/json' \
    --header 'Authorization: Basic xxxxxxxxxxxxx'

Get Asset Response Object

Same as the single response object from the List Assets call.

POSTadvisor-api.wealth.com/v1/clients/{wid}/assets

Add Asset

The Asset Request Object model contains all the information about your client asset(s).

Add Asset Request Object

Name
assets
Type
array of objects
Description
Array of asset objects to create.
Name
asset_type
Type
string enum
Description
Type of an asset. One of Asset Types
Name
name
Type
string (Max 255)
Description
The name of the Asset.
Name
description
Type
string (Max 255)
Description
The description of the Asset.
Name
estimated_value
Type
number
Description
Asset estimated value in USD.
Name
as_of_date
Type
date (ISO 8601)
Description
The date for which asset information is relevant.

Real Estate-specific additional properties

Name
street_address
Type
string
Description
The first line of an address.
Name
street_address2
Type
string
Description
The second line of an address.
Name
city
Type
string
Description
The city of the address.
Name
state
Type
string
Description
The state abbreviation of the address.
Name
zip_code
Type
string (Max 255)
Description
The zip code of the address.
Name
purchase_date
Type
date (ISO 8601)
Description
The date the property was purchased.
Name
purchase_cost
Type
number
Description
The purchase price of the property.
Name
category
Type
string enum
Description
Real Estate category. One of Real Estate Categories
Name
neighborhood
Type
string
Description
The neighborhood of the property.
Name
use_estimation_by_zillow
Type
boolean
Description
True if the estimated value should be provided&updated by Zillow.
Name
country_code
Type
string
Description
Country code of the address (i.e. US).

Asset Request

POST

advisor-api.wealth.com/v1/clients/{wid}/assets

  curl --location 'https://advisor-api.wealth.com/v1/clients/2d6fb3ee-1617-4ee2-b402-6dd0e4449c85/assets' \
    --header 'Content-Type: application/json' \
    --header 'Authorization: Basic xxxxxxxxxxxxx' \
    --data '{
  "assets": [
      {
        "asset_type":"Brokerage",
        "name":"brokerage asset test1",
        "description":"brokerage asset test description 1",
        "estimated_value": 123456,
        "as_of_date": "2023-12-19T11:31:42Z",
        "purchase_cost": 100,
        "location": "Earth"
      },
      {
        "asset_type": "Cash",
        "name":"cash asset test1",
        "description": "cash asset test description 1",
        "estimated_value": 49345565,
        "as_of_date": "2023-12-18T11:31:42Z",
        "location": "Moon",
        "quantity": 100500,
        "currency_code": "GBP"
      },
      {
        "asset_type": "RealEstate",
        "name": "RealEstate asset test1",
        "purchase_cost": 120000,
        "purchase_date": "2020-12-18T11:31:42Z",
        "category": "House",
        "street_address": "3431 W Darien Way",
        "city": "Phoenix",
        "state": "AZ",
        "zip_code": "85086",
        "country_code": "US",
        "use_estimation_by_zillow": true
      }
  ]
}'

Add Asset Response Object

Name
results
Type
array of objects
Description
Array of per-asset results for the create request.
Name
id
Type
string (Max 255)
Description
Wealth.com unique identifier for the created asset.
Name
name
Type
string (Max 255)
Description
Asset name.
Name
asset_type
Type
string enum
Description
Wealth.com asset type - one of Asset Types
Name
error
Type
string (Max 255)
Description
Error message for an asset that could not be created.

Asset Response

{
  "results": [
    {
      "id": "w9hlz2o29Emr3tOoUv7VXQ",
      "name": "brokerage asset test1",
      "asset_type": "Brokerage"
    },
    {
      "id": "80k8lIcN6EegPl35NVrPmg",
      "name": "cash asset test1",
      "asset_type": "Cash"
    },
    {
      "id": "24tzB0Z9e0uZR9LXNbOUzA",
      "name": "checking asset test1",
      "asset_type": "Checking"
    }
  ]
}

PUTadvisor-api.wealth.com/v1/clients/{wid}/assets/{asset_id}

Update Asset

The Asset Request Object model contains all the information about your client asset. It contains the same properties as the Add Asset request object. Additionally, path parameter asset_id is required to identify the asset to be updated. The asset_type must match the existing asset type and cannot be changed.

Update Asset Request

PUT

advisor-api.wealth.com/v1/clients/{wid}/assets/{asset_id}

  curl --location --request PUT 'https://advisor-api.wealth.com/v1/clients/bb5a8089-ce61-490c-bb42-fb64f56758fd/assets/t9qU544PHUK7BVDuB6gOcA' \
    --header 'Content-Type: application/json' \
    --header 'Authorization: Basic xxxxxxxxxxxxx' \
    --data '
      {
        "name": "cryptocurrency asset test1",
        "asset_type": "Cryptocurrency",
        "estimated_value": 200,
        "as_of_date": "2023-12-21T01:00:22+00:00",
        "primary_asset_category": "Investment",
        "purchase_cost": 986433,
        "cryptocurrency_name": "Aventis Metaverse",
        "quantity": 100499,
        "slug": "aventis-metaverse",
        "symbol": "AVTM"
      }
    '

Update Asset Response Object

The response object is the full asset object (same shape as a single item from the List Assets response).

DELETEadvisor-api.wealth.com/v1/clients/{wid}/assets/{asset_id}

Delete Asset

The DELETE asset call expects an asset and client identifiers to be passed as path parameters.

Request

DELETE

advisor-api.wealth.com/v1/clients/{wid}/assets/{asset_id}

  curl --location --request DELETE 'https://advisor-api.wealth.com/v1/clients/bb5a8089-ce61-490c-bb42-fb64f56758fd/assets/Ni6yS0sgJ0eCLlK5TZyAuQ' \
    --header 'Authorization: Basic xxxxxxxxxxxxx'

Delete Asset Response

Upon successful deletion the API returns HTTP status code 200 with {"message": "Asset deleted"}.

Asset Types

List of available types used to categorize assets in the wealth.com system.


Brokerage	IRA	PersonalInventory
Cash	Insurance	RealEstate
Checking	Loan	Retirement401K
CreditCard	OtherAsset	Saving
Crowdfunding	OtherInsurance	StockOption
Cryptocurrency	OtherInvestment	Vehicle
Education529	OtherLiability
HSAFSA

Real estate categories

List of real estate categories.


House
Commercial
Timeshare
Land
Other