Client

This API is for the Client resource of the Advisor API on the wealth.com platform. It allows connected systems to programmatically manage clients. This can be useful for integrating your internal system with the wealth.com platform, allowing you to automate client management tasks such as initiating invitation workflows.

Note: If your api user is set up to have access to multiple advisors, you will need to provide advisor_id and team_id query parameters (unless they are specified as part of request object).

GETadvisor-api.wealth.com/v1/clients

List Clients

Clients Request Parameters

Name
advisor_id
Type
string (Max 64)
Description
Unique identifier for the advisor making the request on behalf of their client.
Name
page
Type
number (optional)
Description
The page number to retrieve. The default is 0.
Name
page_size
Type
number (optional)
Description
The number of clients to retrieve for each page. The default is 100.

Request

GET

advisor-api.wealth.com/v1/

  curl --location --request GET 'https://advisor-api.wealth.com/v1/clients?advisor_id=26889708-54a7-4ce1-a1ee-d43104c319f5&page_size=3&page=1' \
    --header 'Content-Type: application/json' \
    --header 'Authorization: Basic xxxxxxxxxxxxx'

Clients Response Object

Get Clients return an array of client objects.

Name
wid
Type
string (Max 64)
Description
Wealth.com unique identifier for the client.
Name
client_email
Type
string (Max 255)
Description
Email of the client to be created.
Name
client_first_name
Type
string (Max 255)
Description
First Name of the client to be created.
Name
client_last_name
Type
string (Max 255)
Description
Last name of the client to be created.
Name
invitation_link
Type
string (Max 2048)
Description
Link to the client invitation on the Wealth.com dashboard
Name
estate_plan
Type
string (Max 50)
Description
The selected plan - one of Estate Plan Values
Name
completion_status
Type
string (Max 50)
Description
Completion status for the client - one of Completion Status Values

Response

[{
   "wid": "786bb91c-35ec-49bb-bc28-1d2930d7db6a",
   "client_first_name": "Brad",
   "client_last_name": "Pitt",
   "client_email": "brad@fightclub.com",
   "estate_plan": "joint_will",
   "completion_status": "PreFlightNotInvited",
   "invitation_link": "https://mydashboard.wealth.com/invited/f6das3ioh57bg18sw"
},
{
   "wid": "89882706-0ad3-4af2-95ca-44b4f76d315d",
   "client_first_name": "angelina",
   "client_last_name": "jolie",
   "client_email": "angelina@hackers.com",
   "estate_plan": "individual_trust",
   "completion_status": "InProgress",
   "invitation_link": "https://mydashboard.wealth.com/invited/kj3lk43kh21kh4hh3"
}]

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

Get Client

The GET client call expects a Wealth.com Id (wid) to be passed on the URL. The wid is unique to each client.

Request

GET

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

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

Get Client Response Object

Name
wid
Type
string (Max 64)
Description
Wealth.com unique identifier for the client.
Name
client_email
Type
string (Max 255)
Description
Email of the client to be created.
Name
client_first_name
Type
string (Max 255)
Description
First Name of the client to be created.
Name
client_last_name
Type
string (Max 255)
Description
Last name of the client to be created.
Name
estate_plan
Type
string (Max 50)
Description
The selected plan - one of Estate Plan Values
Name
completion_status
Type
string (Max 50)
Description
Completion status for the client - one of Completion Status Values
Name
invitation_link
Type
string (Max 2048)
Description
Link to the client invitation on the Wealth.com dashboard
Name
subscription_start_date
Type
ISO 8601 date-time
Description
Client's subscription start date if were provided during the client creation.

Response

{
   "wid": "786bb91c-35ec-49bb-bc28-1d2930d7db6a",
   "client_first_name": "Brad",
   "client_last_name": "Pitt",
   "estate_plan": "joint_will",
   "completion_status": "PreFlightNotInvited",
   "client_email": "brad@fightclub.com",
   "invitation_link": "https://mydashboard.wealth.com/invited/f6das3ioh57bg18sw",
   "subscription_start_date": "2024-02-01T00:00:00Z"
}

POSTadvisor-api.wealth.com/v1/clients/

Add Client

The Client Request Object model contains all the information about your advisor tenant and your clients information.

Add Client Request Object

Name
advisor_id
Type
string (Max 64)
Description
Unique identifier for the advisor making the request on behalf of their client.
Name
team_id
Type
string (Max 64)
Description
Unique identifier for the advisory team that the advisor belongs to.
Name
client_email
Type
string (Max 255)
Description
Email of the client to be created.
Name
client_first_name
Type
string (Max 255)
Description
First Name of the client to be created.
Name
client_last_name
Type
string (Max 255)
Description
Last name of the client to be created.
Name
send_invitation_email
Type
boolean
Description
Boolean flag to indicate if Wealth.com should send an invitation email to the client. The wealth.com default is to not send an invitation email and let the calling system invite the user.
Name
subscription_start_date
Type
ISO 8601 date-time
Description
Client's subscription start date. Optional. Must be in the past. If not provided or is set in the future then current date will be used.
Name
marital_status
Type
string enum
Description
Client's marital status. Optional.
Accepted values:
'Single' 'Married' 'DomesticPartnership' 'CivilUnion' 'Engaged' 'OtherCommittedRelationship' 'Widowed'
Name
address
Type
object
Description
Client's address. Optional.
Name
line1
Type
string (Max 255)
Description
Street address line 1. Optional.
Name
line2
Type
string (Max 255)
Description
Street address line 2. Optional.
Name
city
Type
string (Max 255)
Description
City. Optional.
Name
state
Type
string (Max 255)
Description
Zip code. Optional.
Name
zip
Type
string (Max 255)
Description
Zip code. Optional.
Name
has_children
Type
boolean
Description
Boolean flag to indicate if the client has children. Optional.
Name
has_pets
Type
boolean
Description
Boolean flag to indicate if the client has pets. Optional.
Name
existing_estate_plan
Type
string enum
Description
The client existing estate plan information. Optional. Accepted values:
'IndividualTrust' 'JointTrust' 'LastWillAndTestament' 'NoEstatePlan' 'Unknown'
Name
own_property
Type
boolean
Description
Boolean flag to indicate if the client owns property selected as address. Optional.
Name
spouse_first_name
Type
string (Max 255)
Description
First Name of the client's spouse. Optional.
Name
spouse_last_name
Type
string (Max 255)
Description
Last name of the client's spouse. Optional.

Name

selected_primary_document

Type

string enum

Description

The primary document that the client selected. Optional. Accepted values:

'One Joint Revocable Trust'
'One Individual Revocable Trust'
'Two Individual Revocable Trusts'
'One Last Will and Testament'
'Two Last Will and Testaments'

Request

POST

advisor-api.wealth.com/v1/clients

  curl --location 'https://advisor-api.wealth.com/v1/clients/' \
    --header 'Content-Type: application/json' \
    --header 'Authorization: Basic xxxxxxxxxxxxx' \
    --data-raw '{
        "advisor_id": "cn4910ny98ec9vb3ghj",
        "team_id": "cn4910ny98ec9vb3ghj",
        "client_email": "brad@fightclub.com",
        "client_first_name": "Brad",
        "client_last_name": "Pitt",
        "send_invitation_email": "false",
        "subscription_start_date": "2024-02-01T00:00:00Z",
        "selected_primary_document": "One Individual Revocable Trust"
    }'

Add Client Response Object

Name
wid
Type
string (Max 64)
Description
Wealth.com unique identifier for the client.
Name
invitation_link
Type
string (Max 2048)
Description
Link to the client invitation on the Wealth.com dashboard
Name
message
Type
string (Max 2048)
Description
Error message if the client creation failed.
Returns "{error=User is already registered on a platform}" if user with this email is already registered on the platform.

Returns "{error=User with this email is already your registered client}" if user with this email is already your client with completed registration.

Response

{
   "wid": "786bb91c-35ec-49bb-bc28-1d2930d7db6a",
   "invitation_link": "https://mydashboard.wealth.com/invited/f6das3ioh57bg18sw"
}

PATCHadvisor-api.wealth.com/v1/clients/{wid}

Update Client

The Client Update Object model contains all updatable client properties.
Note that properties spouse_first_name, spouse_last_name, marital_status, has_children, has_pets, existing_estate_plan, own_property, address (and all components of address) can be set to null to remove the value.

Update Client Request Object

Name
client_first_name
Type
string (Max 255)
Description
First Name of the client.
Name
client_last_name
Type
string (Max 255)
Description
Last name of the client.
Name
subscription_start_date
Type
ISO 8601 date-time
Description
Client's subscription start date. Optional. Must be in the past. If not provided or is set in the future then current date will be used.
Name
marital_status
Type
string enum
Description
Client's marital status. Optional.
Accepted values:
'Single' 'Married' 'DomesticPartnership' 'CivilUnion' 'Engaged' 'OtherCommittedRelationship' 'Widowed'
Name
address
Type
object
Description
Client's address. Optional.
Name
line1
Type
string (Max 255)
Description
Street address line 1. Optional.
Name
line2
Type
string (Max 255)
Description
Street address line 2. Optional.
Name
city
Type
string (Max 255)
Description
City. Optional.
Name
state
Type
string (Max 255)
Description
Zip code. Optional.
Name
zip
Type
string (Max 255)
Description
Zip code. Optional.
Name
has_children
Type
boolean
Description
Boolean flag to indicate if the client has children. Optional.
Name
has_pets
Type
boolean
Description
Boolean flag to indicate if the client has pets. Optional.
Name
existing_estate_plan
Type
string enum
Description
The client existing estate plan information. Optional. Accepted values:
'NotSure' 'HaveTrust' 'HaveWill' 'DontHaveEstatePlan' 'Irt' 'Jrt'
Name
own_property
Type
boolean
Description
Boolean flag to indicate if the client owns property selected as address. Optional.
Name
spouse_first_name
Type
string (Max 255)
Description
First Name of the client's spouse. Optional.
Name
spouse_last_name
Type
string (Max 255)
Description
Last name of the client's spouse. Optional.

Name

selected_primary_document

Type

string enum

Description

The primary document that the client selected. Optional. Accepted values:

'One Joint Revocable Trust'
'One Individual Revocable Trust'
'Two Individual Revocable Trusts'
'One Last Will and Testament'
'Two Last Will and Testaments'

Request

PATCH

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

curl --location 'https://advisor-api.wealth.com/v1/clients/' \
-X PATCH \
--header 'Content-Type: application/json' \
--header 'Authorization: Basic xxxxxxxxxxxxx' \
--data-raw '{
"subscription_start_date": "2024-02-01T00:00:00Z"
}'

Update Client Response Object

See the Get Client response object.

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

Delete Client

The DELETE client call expects a Wealth.com Id (wid) to be passed on the URL. The wid is unique to each client.
NOTE: The client will not loose access to the Wealth.com platform, but the advisor will no longer have access to the client's information.

Request

DELETE

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

curl --location --request DELETE 'https://advisor-api.wealth.com/v1/clients/786bb91c-35ec-49bb-bc28-1d2930d7db6a' \
  --header 'Authorization: Basic xxxxxxxxxxxxx'

Delete Client Response

Upon successful deletion a HTTP status code of 204 is returned with no body content.

Estate Plan Values

List of estate plan values.

Plan code	Description
individual_will	Will plan for individuals
joint_will	Will plan for couples
individual_trust	Trust plan for individuals
joint_trust	Trust plan for couples

Completion Status Values

List of available client statuses for the progress in completing the estate plan.

Registration refers to the initial sign in to the Wealth.com platform.

Before Registration	After Registration
PreFlightNotInvited	NotStarted
PreFlightInvited	InProgress
	Pending
	Completed