Document

This API is for the Document resource of the Advisor API on the wealth.com platform. It allows connected systems to programmatically manage documents for a client.

The V1 Document API uses the same document request and response objects as the Advisor API v2 Document 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 document requests.

Shared Document Model

Use the Advisor API v2 Document page as the canonical reference for document fields and document upload behavior:

• Get Document response object
• List Documents response object
• Upload Document request and response objects
• Update Document request and response objects
• Using Upload URI
• Supported Tag Values
• Category Sub-Category Type Values

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

List Documents

The List Documents call expects a client wid in the URL. It returns a paginated array of documents for that client. You can optionally filter results by passing a tags query parameter containing a comma-separated list of tag names.

Query Parameters

  curl --location --request GET 'https://advisor-api.wealth.com/v1/clients/2d6fb3ee-1617-4ee2-b402-6dd0e4449c85/documents?limit=10&tags=current,funded' \
    --header 'Content-Type: application/json' \
    --header 'Authorization: Basic xxxxxxxxxxxxx'

HTTP Status Codes

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

Upload Document

The Upload Document call expects a client wid in the URL and a JSON request body describing the document metadata. A successful response includes an upload_uri; use it to upload the file content as described in Using Upload URI.

  curl --location 'https://advisor-api.wealth.com/v1/clients/2d6fb3ee-1617-4ee2-b402-6dd0e4449c85/documents' \
    --header 'Content-Type: application/json' \
    --header 'Authorization: Basic xxxxxxxxxxxxx' \
    --data-raw '{
        "name": "john-doe-slat",
        "extension": ".pdf",
        "description": "John Doe SLAT",
        "category": "estate_planning",
        "sub_category": "irrevocable_trusts",
        "type": "slat",
        "tags": ["current", "reviewed"]
    }'

HTTP Status Codes

The request and response objects are the same as the Advisor API v2 Upload Document request and response objects.

Get Document

The Get Document call expects a client wid and document vault_id in the URL.

  curl --location --request GET 'https://advisor-api.wealth.com/v1/clients/2d6fb3ee-1617-4ee2-b402-6dd0e4449c85/documents/53ac20e4-8287-4bd7-b7e7-8f09b056325f' \
    --header 'Content-Type: application/json' \
    --header 'Authorization: Basic xxxxxxxxxxxxx'

HTTP Status Codes

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

Update Document

The Update Document call expects a client wid and document vault_id in the URL. The request body may contain any supported mutable document metadata fields.

  curl --location 'https://advisor-api.wealth.com/v1/clients/2d6fb3ee-1617-4ee2-b402-6dd0e4449c85/documents/53ac20e4-8287-4bd7-b7e7-8f09b056325f' -X PATCH \
    --header 'Content-Type: application/json' \
    --header 'Authorization: Basic xxxxxxxxxxxxx' \
    --data-raw '{
        "name": "john-doe-slat-revised",
        "description": "John Doe SLAT Revised",
        "tags": ["current", "ready-to-publish", "reviewed"]
    }'

HTTP Status Codes

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

Delete Document

The Delete Document call expects a client wid and document vault_id in the URL.

  curl --location --request DELETE 'https://advisor-api.wealth.com/v1/clients/2d6fb3ee-1617-4ee2-b402-6dd0e4449c85/documents/53ac20e4-8287-4bd7-b7e7-8f09b056325f' \
    --header 'Content-Type: application/json' \
    --header 'Authorization: Basic xxxxxxxxxxxxx'

HTTP Status Codes

The response object is the same as the Advisor API v2 Delete Document response object.