Introduction
The Wealth.com Advisor API allows for Advisor partners to integrate Wealth.com functionality directly into on-premiss workflows and systems not accessible to Wealth.com. A common example is a proprietary in house Custom Relationship Management Systems (CRM) or document management platforms. In addition to executing invitation workflows inside of wealth.com, webhooks are used to keep partner systems up to date regarding their clients progress and activities inside of Wealth.com.
Addressing a client
Client-scoped endpoints for clients, documents, assets, and contacts accept the client by either identifier, using interchangeable path forms:
- Wealth.com id (
wid) —/v1/clients/{wid}/... - Your
external_id—/v1/clients/by-external-id/{external_id}/...
external_id is the identifier you assign to a client (the same value you supply when creating the client and when referencing it elsewhere). For these endpoints the two forms behave identically — same authentication, request bodies, responses, and status codes. It covers getting, updating, and deleting a client, the client summary, and the client's documents, assets, and contacts.
Because an external_id is unique only within a team, API users who can access more than one advisor or team must include advisor_id and team_id as query parameters so the client resolves to the correct team; a request whose team cannot be determined returns 400. Single-team API users do not need to send anything extra. An external_id that matches no client returns 404, just like an unknown wid.
Security / Encryption
All connections will be encrypted using TLS 1.2 or better to protect data in the request payload. A customer request for a lower TLS version will require notification of the Wealth Security Team.
Rate Limiting
The Advisor API has a per client rate limit of 10 request a second. This limit protects our system and ensure that each client receives a quick response to queries from the API. If you are experiencing rate limit errors, you can ask for a limit increase through your support representative.