Contact

This API is for the Contact resource of the Advisor API on the wealth.com platform. It allows connected systems to programmatically manage contact cards for a client. A contact card can represent an individual, trust, entity, charity, will, or class.

The V1 Contact API uses the same contact request and response objects as the Advisor API v2 Contact resource, with V1 client-scoped paths and Basic Auth. If your API user has access to multiple advisors, include advisor_id and team_id as query parameters on contact requests.

Shared Contact Model

Use the Advisor API v2 Contact page as the canonical reference for contact fields and validation rules:

• Contact Types And Input Rules
• List Contacts response object
• Add Contact request and response objects
• Get Contact response object
• Update Contact request and response objects

The differences for V1 are the URL path, authentication header, and the optional advisor_id and team_id query parameters.

List Contacts

The List Contacts call expects a client wid in the URL. It returns the contact cards supported by this API for that client.

Query Parameters

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

HTTP Status Codes

The response object is the same as the Advisor API v2 List Contacts response object.

Add Contact

The Add Contact call expects a client wid in the URL and a JSON request body describing the new contact card. The body must include external_id, type, and any additional required fields for the selected contact type.

  curl --location 'https://advisor-api.wealth.com/v1/clients/2d6fb3ee-1617-4ee2-b402-6dd0e4449c85/contacts' \
    --header 'Content-Type: application/json' \
    --header 'Authorization: Basic xxxxxxxxxxxxx' \
    --data-raw '{
        "external_id": "trust-external-id",
        "type": "Trust",
        "legal_name": "Doe Family Trust",
        "trust_type": "DynastyTrust",
        "trust_creator": ["creator-external-id"],
        "initial_trustee": ["trustee-external-id"],
        "governing_state": "FL",
        "trust_creation_date": "2026-01-20"
    }'

HTTP Status Codes

The request and response objects are the same as the Advisor API v2 Add Contact request and response objects.

Get Contact

The Get Contact call expects a client wid and contact id in the URL.

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

HTTP Status Codes

The response object is the same as the Advisor API v2 Get Contact response object.

Update Contact

The Update Contact call expects a client wid and contact id in the URL. The request body may contain only mutable fields for the contact's existing type. Do not send type or external_id in an update request.

  curl --location --request PUT 'https://advisor-api.wealth.com/v1/clients/2d6fb3ee-1617-4ee2-b402-6dd0e4449c85/contacts/class-card-id' \
    --header 'Content-Type: application/json' \
    --header 'Authorization: Basic xxxxxxxxxxxxx' \
    --data-raw '{
        "notes": "Children in good standing",
        "current_parties": {
            "is_distributed_evenly": true,
            "parties": [
                {
                    "contact_id": "party-a-external-id",
                    "distribution_percentage": 60
                }
            ]
        }
    }'

HTTP Status Codes

The request and response objects are the same as the Advisor API v2 Update Contact request and response objects.