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.

You may also send your own identifier for each asset using the external_id field, so you can correlate assets in your system with the assets stored in wealth.com.

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

Returns an array of asset objects for the client. Every asset object includes the common properties listed below; some asset types include additional properties (see Type-specific Properties ).

  • Name
    id
    Type
    string (Max 255)
    Description

    Wealth.com unique identifier for the asset.

  • Name
    external_id
    Type
    string (Max 255), optional
    Description

    Your integration's identifier for the asset, if it was provided when the asset was created or updated.

  • 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
    Description

    Wealth.com asset estimated value, in USD.

  • Name
    as_of_date
    Type
    date (ISO 8601)
    Description

    The date the asset was last updated.

  • Name
    description
    Type
    string (Max 255), optional
    Description

    The description of the asset.

  • Name
    description_for_estate
    Type
    string (Max 800), optional
    Description

    Free-form note attached to the asset for estate planning purposes.

  • Name
    primary_asset_category
    Type
    string enum, optional
    Description

    High-level category for the asset. One of Primary Asset Categories .

  • Name
    purchase_cost
    Type
    number, optional
    Description

    Original purchase cost of the asset.

  • Name
    location
    Type
    string (Max 255), optional
    Description

    Free-form text describing where the asset is located.

  • Name
    liquidity
    Type
    string enum, optional
    Description

    Whether the asset is liquid or illiquid. One of Liquidity .

  • Name
    holdings
    Type
    object, optional
    Description

    Asset class breakdown for the asset. See Holdings .

  • Name
    ownership
    Type
    object, optional
    Description

    Ownership composition for the asset. See Ownership .

  • Name
    beneficiaries
    Type
    object, optional
    Description

    Beneficiary composition for the asset. See Beneficiaries .

Response

[{
   "id": "BywaJOaAIkOnJhp35u0qvA",
   "external_id": "asset-primary-home-01",
   "name": "Primary home",
   "asset_type": "RealEstate",
   "as_of_date": "2026-02-16T12:32:39+00:00",
   "primary_asset_category": "RealEstate",
   "liquidity": "Illiquid",
   "street_address": "444 Washington Street",
   "city": "San Francisco",
   "state": "California",
   "country_code": "US",
   "zip_code": "94111",
   "use_estimation_by_zillow": true
},
{
   "id": "cJCCwvkuGkSvcVQQgA0DJg",
   "name": "Family savings",
   "asset_type": "Saving",
   "estimated_value": 100000,
   "as_of_date": "2026-03-27T20:18:18+00:00",
   "primary_asset_category": "Cash",
   "liquidity": "Liquid"
},
{
   "id": "Gq4eMC2W70qsoPJa2aLPtw",
   "external_id": "asset-brokerage-01",
   "name": "Joint brokerage account",
   "asset_type": "Brokerage",
   "estimated_value": 123456,
   "as_of_date": "2026-04-22T19:07:47+00:00",
   "description": "Joint taxable brokerage",
   "primary_asset_category": "Investment",
   "purchase_cost": 100,
   "location": "Earth",
   "holdings": {
       "majorAssetClasses": [{
           "majorClass": "PublicEquity",
           "assetClasses": [
               {"minorAssetClass": "USEquity", "value": 80000},
               {"minorAssetClass": "NonUSEquity", "value": 43456}
           ]
       }]
   },
   "ownership": {
       "shareType": "Percentage",
       "version": "V2",
       "ownershipType": "Joint",
       "owners": [{
           "id": "contact-jane-doe-01|contact-john-doe-01",
           "type": "Joint",
           "percentage": 100,
           "subOwners": [
               {"id": "contact-jane-doe-01", "type": "Individual"},
               {"id": "contact-john-doe-01", "type": "Individual"}
           ]
       }]
   }
}]

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 contains all the information about your client's asset(s). The request body holds an assets array; each entry has the common properties listed below, plus any additional properties for its asset type (see Type-specific Properties ).

asset_type must be one of the values listed in Asset Types .

Add Asset Request Object

  • Name
    assets
    Type
    array of objects
    Description

    Array of asset objects to create. Required.

  • Name
    asset_type
    Type
    string enum
    Description

    Type of an asset. One of Asset Types . Required.

  • Name
    name
    Type
    string (Max 255)
    Description

    The name of the asset. Required.

  • Name
    external_id
    Type
    string (Max 255), optional
    Description

    Your integration's identifier for the asset. Stored on the asset and returned by GET calls; cannot be changed once set.

  • Name
    description
    Type
    string (Max 255), optional
    Description

    The description of the asset.

  • Name
    description_for_estate
    Type
    string (Max 800), optional
    Description

    Free-form note attached to the asset for estate planning purposes.

  • Name
    estimated_value
    Type
    number, optional
    Description

    Asset estimated value in USD.

  • Name
    as_of_date
    Type
    date (ISO 8601), optional
    Description

    The date for which asset information is relevant.

  • Name
    purchase_cost
    Type
    number, optional
    Description

    Original purchase cost of the asset.

  • Name
    location
    Type
    string (Max 255), optional
    Description

    Free-form text describing where the asset is located.

  • Name
    primary_asset_category
    Type
    string enum, optional
    Description

    High-level category for the asset. One of Primary Asset Categories .

  • Name
    liquidity
    Type
    string enum, optional
    Description

    Whether the asset is liquid or illiquid. One of Liquidity .

  • Name
    holdings
    Type
    object, optional
    Description

    Asset class breakdown for the asset. See Holdings .

  • Name
    ownership
    Type
    object, optional
    Description

    Ownership composition for the asset. See Ownership .

  • Name
    beneficiaries
    Type
    object, optional
    Description

    Beneficiary composition for the asset. See Beneficiaries .

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",
        "external_id": "asset-brokerage-01",
        "name": "Joint brokerage account",
        "description": "Joint taxable brokerage",
        "estimated_value": 123456,
        "as_of_date": "2026-04-22T11:31:42Z",
        "purchase_cost": 100,
        "location": "Earth",
        "ownership": {
          "shareType": "Percentage",
          "version": "V2",
          "ownershipType": "Joint",
          "owners": [{
            "id": "contact-jane-doe-01|contact-john-doe-01",
            "type": "Joint",
            "percentage": 100,
            "subOwners": [
              {"id": "contact-jane-doe-01", "type": "Individual"},
              {"id": "contact-john-doe-01", "type": "Individual"}
            ]
          }]
        }
      },
      {
        "asset_type": "Cash",
        "external_id": "asset-cash-01",
        "name": "Cash on hand",
        "estimated_value": 49345,
        "as_of_date": "2026-04-22T11:31:42Z",
        "quantity": 100500,
        "currency_code": "GBP"
      },
      {
        "asset_type": "Cryptocurrency",
        "external_id": "asset-crypto-wallet-01",
        "name": "BTC wallet",
        "estimated_value": 18000,
        "as_of_date": "2026-04-22T11:31:42Z",
        "purchase_cost": 12000,
        "slug": "bitcoin",
        "symbol": "BTC",
        "cryptocurrency_name": "Bitcoin",
        "wallet_address": "bc1qxy2kgdygjrsqtzq2n0yrf2493p83kkfjhx0wlh"
      },
      {
        "asset_type": "Vehicle",
        "external_id": "asset-vehicle-01",
        "name": "BMW 5 series",
        "estimated_value": 25000,
        "purchase_cost": 24000,
        "vehicle_category": "Car",
        "vin": "WBAJB1C50JB084123",
        "model_name": "5 series",
        "manufacturer": "BMW",
        "model_year": 2017,
        "color": "black",
        "registered_state": "AZ",
        "license_plate": "49438AZ44"
      },
      {
        "asset_type": "ExecutiveCompensation",
        "external_id": "asset-executive-comp-01",
        "name": "RSU grant 2024",
        "estimated_value": 88000,
        "as_of_date": "2026-04-22T00:00:00Z",
        "fmv_at_vest": 45.25,
        "vesting_date": "2027-06-01",
        "grant_date": "2024-06-01",
        "grant_type": "RSU",
        "custodian": "Fidelity",
        "quantity": "1200",
        "cost_basis_share_value": 18.5,
        "current_market_value": 54000,
        "strike_price": 14.75
      },
      {
        "asset_type": "RealEstate",
        "external_id": "asset-real-estate-01",
        "name": "Primary home",
        "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

The response contains a results array with one entry per asset in the request, in the same order as the request. Each entry is either a successful create (with id, name, asset_type) or an error (with error).

  • 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 (success entries only).

  • Name
    name
    Type
    string (Max 255)
    Description

    Asset name (success entries only).

  • Name
    asset_type
    Type
    string enum
    Description

    Wealth.com asset type - one of Asset Types (success entries only).

  • Name
    error
    Type
    string
    Description

    Error message for an asset that could not be created (failure entries only).

Asset Response

{
  "results": [
    {
      "id": "w9hlz2o29Emr3tOoUv7VXQ",
      "name": "Joint brokerage account",
      "asset_type": "Brokerage"
    },
    {
      "id": "80k8lIcN6EegPl35NVrPmg",
      "name": "Cash on hand",
      "asset_type": "Cash"
    },
    {
      "id": "24tzB0Z9e0uZR9LXNbOUzA",
      "name": "BTC wallet",
      "asset_type": "Cryptocurrency"
    },
    {
      "id": "Rd1aQ9hYpEiV4EwsT03Egw",
      "name": "BMW 5 series",
      "asset_type": "Vehicle"
    },
    {
      "id": "qtXxqhTbREaR9Uk0BwG3yQ",
      "name": "RSU grant 2024",
      "asset_type": "ExecutiveCompensation"
    },
    {
      "id": "nsW7p4f0WUuJ2C0L8t6qPg",
      "name": "Primary home",
      "asset_type": "RealEstate"
    }
  ]
}

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

Update Asset

The Update Asset Request Object has the same shape as a single entry in the Add Asset request body (no assets array wrapper). Path parameter asset_id is required to identify the asset to be updated.

Update rules:

  • asset_type must match the existing asset type and cannot be changed. A mismatch returns 422 with Asset type cannot be changed - should be {existing_type}.
  • external_id cannot be changed once set. Attempting to change it returns 422 with Changing externalId is not allowed.
  • name and asset_type are required on the request body, just like on create.

A successful update returns the full updated asset object (same shape as a single item from the List Assets response).

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": "Aventis Metaverse position",
        "asset_type": "Cryptocurrency",
        "estimated_value": 200,
        "as_of_date": "2026-04-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 is the full updated 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 identifier 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"}.

If the specified asset does not exist for the client, the API returns 404 with {"message": "Asset not found"}.


Type-specific Properties

In addition to the common properties described above, certain asset_type values accept extra fields. Send these fields as siblings of the common fields on the same asset object (do not nest them); the same fields are returned at the top level of the asset object on GET calls.

All asset types not covered by a subsection below accept only the common properties — no additional type-specific fields apply.

Cash

  • Name
    quantity
    Type
    number, optional
    Description

    Amount held in the cash position, expressed in currency_code.

  • Name
    currency_code
    Type
    string (2-10), optional
    Description

    ISO currency code for the cash position (e.g. USD, GBP).

Cryptocurrency

  • Name
    slug
    Type
    string (Max 255), optional
    Description

    Wealth.com slug for the cryptocurrency (e.g. bitcoin).

  • Name
    symbol
    Type
    string (Max 255), optional
    Description

    Cryptocurrency ticker symbol (e.g. BTC).

  • Name
    cryptocurrency_name
    Type
    string (Max 255), optional
    Description

    Display name for the cryptocurrency.

  • Name
    cryptocurrency_description
    Type
    string (Max 5000), optional
    Description

    Optional descriptive text for the position.

  • Name
    quantity
    Type
    number, optional
    Description

    Quantity of the cryptocurrency held.

  • Name
    wallet_address
    Type
    string (Max 255), optional
    Description

    Public wallet address for the position. When wallet_address is provided and quantity is omitted, balances are tracked from the wallet address.

Insurance, OtherInsurance, AnnuityInsurance

The same fields apply to all three types.

  • Name
    insured_benefit
    Type
    number, optional
    Description

    Insured benefit amount in USD.

  • Name
    expiration_date
    Type
    date (ISO 8601), optional
    Description

    The expiration date of the insurance policy.

CreditCard

  • Name
    current_balance
    Type
    number, optional
    Description

    Current balance owed on the credit card.

  • Name
    available_credit
    Type
    number, optional
    Description

    Available credit on the credit card.

Loan, SecuredLoans, UnsecuredLoans, IntraFamilyLoan, Mortgage

The same fields apply to all five types.

  • Name
    principal_balance
    Type
    number, optional
    Description

    Outstanding principal balance on the loan.

  • Name
    original_loan_amount
    Type
    number, optional
    Description

    Original amount of the loan when it was originated.

Vehicle

  • Name
    vehicle_category
    Type
    string enum, optional
    Description

    Vehicle category. One of Vehicle Categories .

  • Name
    vin
    Type
    string (Max 255), optional
    Description

    Vehicle identification number.

  • Name
    model_name
    Type
    string (Max 255), optional
    Description

    Model name of the vehicle.

  • Name
    manufacturer
    Type
    string (Max 255), optional
    Description

    Manufacturer of the vehicle.

  • Name
    model_year
    Type
    number, optional
    Description

    Model year of the vehicle.

  • Name
    classification_name
    Type
    string (Max 255), optional
    Description

    Classification name of the vehicle (e.g. saloon).

  • Name
    color
    Type
    string (Max 255), optional
    Description

    Vehicle color.

  • Name
    registered_state
    Type
    string (Max 255), optional
    Description

    State the vehicle is registered in.

  • Name
    license_plate
    Type
    string (Max 255), optional
    Description

    License plate of the vehicle.

PersonalInventory

ExecutiveCompensation

  • Name
    grant_type
    Type
    string enum, optional
    Description

    Type of grant. One of Executive Compensation Grant Types .

  • Name
    grant_date
    Type
    date (ISO 8601), optional
    Description

    Date the grant was issued.

  • Name
    vesting_date
    Type
    date (ISO 8601), optional
    Description

    Date the grant vests.

  • Name
    custodian
    Type
    string (Max 255), optional
    Description

    Name of the custodian holding the grant.

  • Name
    quantity
    Type
    string (Max 255), optional
    Description

    Number of shares/units in the grant.

  • Name
    cost_basis_share_value
    Type
    number, optional
    Description

    Cost basis per share/unit.

  • Name
    current_market_value
    Type
    number, optional
    Description

    Current market value of the grant.

  • Name
    fmv_at_vest
    Type
    number, optional
    Description

    Fair market value per share/unit at vest.

  • Name
    strike_price
    Type
    number, optional
    Description

    Strike price of the grant (for option-based grants).

StorageFacility

  • Name
    facility_name
    Type
    string (Max 255), optional
    Description

    Name of the storage facility.

  • Name
    unit_number
    Type
    string (Max 255), optional
    Description

    Storage unit number.

  • Name
    payment_amount
    Type
    number, optional
    Description

    Amount of recurring payment.

  • Name
    frequency
    Type
    string (Max 255), optional
    Description

    Payment frequency (e.g. Monthly).

StockCertificate

  • Name
    company
    Type
    string (Max 255), optional
    Description

    Issuing company name.

  • Name
    symbol
    Type
    string (Max 255), optional
    Description

    Ticker symbol.

  • Name
    isin
    Type
    string (Max 255), optional
    Description

    International Securities Identification Number.

  • Name
    cusip
    Type
    string (Max 255), optional
    Description

    CUSIP identifier.

  • Name
    sedol
    Type
    string (Max 255), optional
    Description

    SEDOL identifier.

  • Name
    quantity
    Type
    number, optional
    Description

    Number of shares represented by the certificate.

  • Name
    date_issued
    Type
    date (ISO 8601), optional
    Description

    Date the certificate was issued.

PreciousMetal

  • Name
    quantity
    Type
    number, optional
    Description

    Quantity of metal held, in weight_unit units.

  • Name
    symbol
    Type
    string enum, optional
    Description

    Metal symbol. One of Precious Metal Symbols .

  • Name
    weight_unit
    Type
    string enum, optional
    Description

    Unit used for quantity. One of Precious Metal Weight Units .

RealEstate

  • Name
    street_address
    Type
    string (Max 255), optional
    Description

    The first line of an address.

  • Name
    street_address2
    Type
    string (Max 255), optional
    Description

    The second line of an address.

  • Name
    city
    Type
    string (Max 255), optional
    Description

    The city of the address.

  • Name
    state
    Type
    string (Max 255), optional
    Description

    The state name (or abbreviation) of the address.

  • Name
    zip_code
    Type
    string (Max 255), optional
    Description

    The zip code of the address.

  • Name
    country_code
    Type
    string (Max 255), optional
    Description

    Country code of the address (e.g. US).

  • Name
    neighborhood
    Type
    string (Max 255), optional
    Description

    The neighborhood of the property.

  • Name
    purchase_date
    Type
    date (ISO 8601), optional
    Description

    The date the property was purchased.

  • Name
    category
    Type
    string enum, optional
    Description

    Real estate category. One of Real Estate Categories .

  • Name
    use_estimation_by_zillow
    Type
    boolean, optional
    Description

    Set to true to have the estimated value provided and updated by Zillow.


Holdings

holdings describes the asset class breakdown for the asset. majorClass and minorAssetClass accept the values from the default Wealth.com taxonomy listed under Major and Minor Asset Classes . Firms with a custom asset-class taxonomy may use their own string identifiers instead.

  • Name
    majorAssetClasses
    Type
    array of objects
    Description

    Major asset class buckets. Each entry has a majorClass and an assetClasses array of minor asset classes. Required.

Each element of majorAssetClasses (MajorAssetClass):

  • Name
    majorClass
    Type
    string
    Description

    Major asset class identifier. One of Major and Minor Asset Classes (or your firm's custom identifier). Required.

  • Name
    assetClasses
    Type
    array of objects
    Description

    Minor asset class entries. Required.

Each element of assetClasses (MinorAssetClass):

  • Name
    minorAssetClass
    Type
    string
    Description

    Minor asset class identifier. One of the minor classes for the parent majorClass listed in Major and Minor Asset Classes (or your firm's custom identifier). Required.

  • Name
    value
    Type
    number
    Description

    Value held within this minor asset class, in USD. Required.

  • Name
    externalId
    Type
    string, optional
    Description

    Your integration's identifier for the minor asset class entry.


Ownership

ownership (OwnershipComposition) describes who owns the asset and in what shares. id values inside owners (and inside subOwners, separatePropertyOf and separatePropertyOwners) must reference the external_id of an existing contact for the same client.

  • Name
    shareType
    Type
    string enum
    Description

    Whether shares are expressed as a Percentage or a Fraction. Required.

  • Name
    version
    Type
    string enum
    Description

    Schema version. One of V1, V2. Required.

  • Name
    ownershipType
    Type
    string enum, optional
    Description

    Joint or NotJoint.

  • Name
    owners
    Type
    array of objects
    Description

    Ownership entries (Owner objects). Required.

Each Owner:

  • Name
    id
    Type
    string
    Description

    external_id of the contact (for Joint owners, the API returns a composite identifier built from the joint contacts' external_ids separated by |). Required.

  • Name
    type
    Type
    string enum
    Description

    One of Individual, Joint, Trust, Entity. Required.

  • Name
    percentage
    Type
    number, optional
    Description

    Ownership percentage (used when shareType is Percentage).

  • Name
    fraction
    Type
    object, optional
    Description

    Ownership fraction (used when shareType is Fraction). See Fraction .

  • Name
    subOwners
    Type
    array of objects, optional
    Description

    Required when type is Joint. Each entry references an existing contact by external_id with a type of Individual, Trust, or Entity.

  • Name
    note
    Type
    string (Max 5000), optional
    Description

    Free-form note attached to the owner.

  • Name
    noteDate
    Type
    date (ISO 8601), optional
    Description

    Date attached to the note.

  • Name
    isCommunityProperty
    Type
    boolean, optional
    Description

    Whether the owner's share is community property.

  • Name
    separatePropertyOf
    Type
    string, optional
    Description

    external_id of the contact who owns this share as separate property.

  • Name
    separatePropertyOwners
    Type
    array of strings, optional
    Description

    external_id values of contacts who together own this share as separate property.


Beneficiaries

beneficiaries (BeneficiaryComposition) describes the beneficiaries of the asset. As with ownership, id values reference existing contacts by external_id. Beneficiary contacts must have a contact type of Individual, Trust, Entity, or Charity.

  • Name
    primaryBeneficiaries
    Type
    array of objects
    Description

    Primary beneficiaries (PrimaryBeneficiary objects). Required.

  • Name
    secondaryBeneficiaries
    Type
    array of objects, optional
    Description

    Secondary beneficiaries (Beneficiary objects).

  • Name
    version
    Type
    string enum
    Description

    Schema version. One of V1, V2. Required.

  • Name
    shareType
    Type
    string enum
    Description

    Whether shares are expressed as a Percentage or a Fraction. Required.

  • Name
    contingentCondition
    Type
    string enum, optional
    Description

    One of AllPrimaryBeneficiaries, SpecificPrimaryBeneficiary, PerStirpes.

  • Name
    note
    Type
    string (Max 5000), optional
    Description

    Free-form note attached to the composition.

  • Name
    noteDate
    Type
    date (ISO 8601), optional
    Description

    Date attached to the note.

Each Beneficiary:

  • Name
    id
    Type
    string
    Description

    external_id of the contact. Required.

  • Name
    percentage
    Type
    number, optional
    Description

    Share expressed as a percentage (used when shareType is Percentage).

  • Name
    fraction
    Type
    object, optional
    Description

    Share expressed as a fraction (used when shareType is Fraction). See Fraction .

  • Name
    note
    Type
    string (Max 5000), optional
    Description

    Free-form note attached to the beneficiary.

  • Name
    noteDate
    Type
    date (ISO 8601), optional
    Description

    Date attached to the note.

PrimaryBeneficiary extends Beneficiary with:

  • Name
    contingentBeneficiaries
    Type
    array of objects, optional
    Description

    Beneficiary objects that inherit if the primary beneficiary cannot.


Fraction

  • Name
    numerator
    Type
    number
    Description

    Numerator. Required.

  • Name
    denominator
    Type
    number
    Description

    Denominator. Required.


Asset Types

The Advisor API recognizes the asset types listed below. Every type can be created and updated via this API and can also be returned by GET calls.

AdvisoryHSAFSARetirement457Plan
AnnuityInsuranceInsuranceRetirementDBP
BrokerageIntraFamilyLoanRetirementRolloverIRA
CashIRARetirementRoth401K
CashAccountLoanRetirementSEPIRA
CertificateOfDepositMoneyMarketRetirementSimpleIRA
CheckingMortgageReward
CloselyHeldInvestmentOtherAlternativeInvestmentRoboAdvisor
CreditCardOtherAssetRothIRA
CrowdfundingOtherInsuranceSafetyDepositBox
CryptocurrencyOtherInvestmentSaving
DerivativesAndNotesOtherLiabilitySecuredLoans
Education529OtherRetirementStockCertificate
EducationCustodialPersonalInventoryStockOption
ESAPreciousMetalStorageFacility
EscrowPrivateEquityTrust
EstatePublicEquityUGMA
ExecutiveCompensationRealEstateUnsecuredLoans
FixedIncomeRealEstateInvestmentUTMA
HedgeFundRetirement401KVehicle
HightYieldSavingsRetirement403bVentureCapital

Major and Minor Asset Classes

The default Wealth.com taxonomy used inside holdings. Each minor asset class belongs to the major asset class shown to its left. Firms with a custom asset-class taxonomy may send their own string identifiers for majorClass and minorAssetClass instead of these values.

Major Asset ClassMinor Asset Class
CashDepositsMoneyMarketFundsCash
DepositsMoneyMarketFunds
FixedIncomeInvestmentGradeFixedIncome
HybridFixedIncome
OtherFixedIncome
PublicEquityUSEquity
NonUSEquity
GlobalEquity
IncomeOrientedEquity
OtherEquity
AlternativeInvestmentsPrivateEquity
HedgeFunds
RealEstate
Commodities
VentureCapital
PersonalRealEstate
Other
OtherInvestmentsAssetAllocation
Miscellaneous
LiabilitiesCreditCard
Loan
IntraFamilyLoan
OtherLiability
ResidentialMortgages
SecurityBasedLoans
StructuredLoans

Real Estate Categories

House
Commercial
Timeshare
Land
Other

Vehicle Categories

Car
Boat
Airplane
Motorcycle
RVTrailer
Other

Personal Inventory Categories

Artwork
Devices
Equipment
HouseholdGoods
Jewelry
NFT
Other

Executive Compensation Grant Types

RSU
ISO
NSO
ESPP
PerformanceShares

Precious Metal Symbols

SymbolMetal
XAUGold
XAGSilver
XPTPlatinum
XPDPalladium
XCUCopper
XRHRhodium
RUTHRuthenium
ALUAluminum
NINickel
ZNCZinc
TINTin

Precious Metal Weight Units

oz
g
kg

Primary Asset Categories

Cash
Investment
Retirement
Education
AlternativeInvestments
RealEstate
OtherProperty
Insurance
Liability

Liquidity

Liquid
Illiquid

Errors

In addition to the per-result error returned by Add Asset (one entry per asset, allowing partial success), the asset endpoints can return the following HTTP status codes with a {"message": "..."} body:

CodeWhenExample message
400asset_type is not a recognized value (see Asset Types ).Unsupported asset type: NotARealAssetType
400ownership references a contact external_id that does not exist.ownership.owners[0].id references non-existing contact card: contact-123
400beneficiaries references a contact whose type is not allowed for beneficiaries.beneficiaries.primaryBeneficiaries[0].id references unsupported beneficiary contact card type Joint: contact-456
400Required path parameters or fields are missing.Bad request - missing one of the required asset parameters
403The caller does not have access to the targeted client.Forbidden
404The asset cannot be found for the targeted client.Asset not found
422asset_type does not match the existing asset on PUT.Asset type cannot be changed - should be Cryptocurrency
422external_id is being changed on PUT.Changing externalId is not allowed
500Unexpected server-side error.Internal server error