Document

This API is for the Document resource of the Advisor API on the wealth.com platform. It allows connected systems to programmatically manage Vault documents within top accounts.

GETadvisor-api.wealth.com/v2/top-accounts/{wid}/documents/{vault_id}

Get Document Metadata

The Get Document Metadata call expects a wid for the top account and a vault_id for the document to be passed as part of the URL. The wid is unique to each top account and the vault_id is unique to each document.

Request

GET

advisor-api.wealth.com/v2/top-accounts/{wid}/documents/{vault_id}

  curl --location --request GET 'https://advisor-api.wealth.com/v2/top-accounts/786bb91c-35ec-49bb-bc28-1d2930d7db6a/documents/53ac20e4-8287-4bd7-b7e7-8f09b056325f' \
    --header 'Content-Type: application/json' \
    --header 'Authorization: Bearer xxxxxxxxxxxxx'

Get Document Metadata Response Object

Name
wid
Type
string (Max 64)
Description
Wealth.com unique identifier for the top account.
Name
vault_id
Type
string (Max 64)
Description
Wealth.com unique identifier for the document.
Name
description
Type
string (Max 2000), optional
Description
The description for the document (if provided).
Name
category
Type
string enum
Description
The category for the document. See Category Sub-Category Type Values for enum values.
Name
sub_category
Type
string enum
Description
The sub-category for the document. See Category Sub-Category Type Values for enum values.
Name
type
Type
string enum, optional
Description
The type for the document (if provided). See Category Sub-Category Type Values for enum values.
Name
tags
Type
string array, optional
Description
An array of tags associated with the document.
Name
creation_date
Type
ISO 8601 date-time
Description
The UTC timestamp when the document was created within the Wealth.com Vault.
Name
modification_date
Type
ISO 8601 date-time
Description
The UTC timestamp when the document was last modified within the Wealth.com Vault.
Name
file_status
Type
string enum
Description
The upload status of the file to the Vault. Possible values are:
'No File Uploaded' 'In Progress' 'Succeeded' 'Failed'

Response

{
   "wid": "786bb91c-35ec-49bb-bc28-1d2930d7db6a",
   "vault_id": "53ac20e4-8287-4bd7-b7e7-8f09b056325f",
   "description": "John Doe SLAT",
   "category": "EstatePlanning",
   "sub_category": "IrrevocableTrusts",
   "type": "SLAT",
   "tags": ["trust", "estate-planning", "slat"],
   "creation_date": "2024-02-01T07:23:12Z",
   "modification_date": "2024-02-05T02:11:48Z",
   "file_status": "Succeeded"
}

GETadvisor-api.wealth.com/v2/top-accounts/{wid}/documents/

List All Documents

The List All Documents call expects a wid for the top account to be passed as part of the URL. It returns a paginated array of documents associated with the specified top account.

Query Parameters

Name
page
Type
integer, optional
Description
The page number to retrieve. Defaults to 1 if not specified.
Name
limit
Type
integer, optional
Description
The number of documents per page. Must be between 1 and 100. Defaults to 20 if not specified.

Request

GET

advisor-api.wealth.com/v2/top-accounts/{wid}/documents/

  curl --location --request GET 'https://advisor-api.wealth.com/v2/top-accounts/786bb91c-35ec-49bb-bc28-1d2930d7db6a/documents/?page=1&limit=10' \
    --header 'Content-Type: application/json' \
    --header 'Authorization: Bearer xxxxxxxxxxxxx'

List All Documents Response Object

Name
documents
Type
array
Description
An array of document objects. Each object has the same structure as the Get Document Metadata response object.
Name
pagination
Type
object
Description
Pagination metadata for the response.
Name
pagination.page
Type
integer
Description
The current page number.
Name
pagination.limit
Type
integer
Description
The number of documents per page.
Name
pagination.total_count
Type
integer
Description
The total number of documents available.
Name
pagination.total_pages
Type
integer
Description
The total number of pages available, given the limit used.

Response

{
   "documents": [
       {
           "wid": "786bb91c-35ec-49bb-bc28-1d2930d7db6a",
           "vault_id": "53ac20e4-8287-4bd7-b7e7-8f09b056325f",
           "description": "John Doe SLAT",
           "category": "EstatePlanning",
           "sub_category": "IrrevocableTrusts",
           "type": "SLAT",
           "tags": ["trust", "estate-planning", "slat"],
           "creation_date": "2024-02-01T07:23:12Z",
           "modification_date": "2024-02-05T02:11:48Z",
           "file_status": "Succeeded"
       },
       {
           "wid": "786bb91c-35ec-49bb-bc28-1d2930d7db6a",
           "vault_id": "67bd31f5-9398-5ce8-cd39-2e4041e8db7b",
           "description": "Jane Doe Trust",
           "category": "EstatePlanning",
           "sub_category": "RevocableTrustsSupportingDocuments",
           "tags": ["trust", "revocable"],
           "creation_date": "2024-02-03T14:15:22Z",
           "modification_date": "2024-02-07T09:33:15Z",
           "file_status": "Succeeded"
       }
   ],
   "pagination": {
       "page": 1,
       "limit": 10,
       "total_count": 25,
       "total_pages": 3
   }
}

POSTadvisor-api.wealth.com/v2/top-accounts/{wid}/documents/{vault_id}/download

Download Document

The Download Document call creates a temporary presigned URL for downloading the document. This endpoint expects a wid for the top account and a vault_id for the document to be passed as part of the URL.

Request

POST

advisor-api.wealth.com/v2/top-accounts/{wid}/documents/{vault_id}/download

  curl --location --request POST 'https://advisor-api.wealth.com/v2/top-accounts/786bb91c-35ec-49bb-bc28-1d2930d7db6a/documents/53ac20e4-8287-4bd7-b7e7-8f09b056325f/download' \
    --header 'Content-Type: application/json' \
    --header 'Authorization: Bearer xxxxxxxxxxxxx'

Download Document Response Object

Name
download_url
Type
string (Max 2000)
Description
A secure presigned URL to download the file.
Name
expiration_date
Type
ISO 8601 date-time
Description
The UTC timestamp when the download URL expires.

Response

{
   "download_url": "https://vault.files.wealth.com/download/...",
   "expiration_date": "2024-02-05T03:26:12Z"
}

POSTadvisor-api.wealth.com/v2/top-accounts/{wid}/documents/

Upload Document

The Upload Document Request Object model contains all the information about your client's document. This endpoint expects a wid for the top account to be passed as part of the URL.

Upload Document Request Object

Name
description
Type
string (Max 2000), optional
Description
The description for the document.
Name
category
Type
string enum
Description
The category for the document. See Category Sub-Category Type Values for enum values.
Name
sub_category
Type
string enum
Description
The sub-category for the document. See Category Sub-Category Type Values for enum values.
Name
type
Type
string enum, optional
Description
The type for the document. See Category Sub-Category Type Values for enum values.
Name
tags
Type
string array, optional
Description
An array of tags to associate with the document.

Request

POST

advisor-api.wealth.com/v2/top-accounts/{wid}/documents/

  curl --location 'https://advisor-api.wealth.com/v2/top-accounts/786bb91c-35ec-49bb-bc28-1d2930d7db6a/documents/' \
    --header 'Content-Type: application/json' \
    --header 'Authorization: Bearer xxxxxxxxxxxxx' \
    --data-raw '{
        "description": "John Doe SLAT",
        "category": "EstatePlanning",
        "sub_category": "IrrevocableTrusts",
        "type": "SLAT",
        "tags": ["trust", "estate-planning", "slat"]
    }'

Upload Document Response Object

Name
wid
Type
string (Max 64)
Description
Wealth.com unique identifier for the top account.
Name
vault_id
Type
string (Max 64)
Description
Wealth.com unique identifier for the document.
Name
upload_url
Type
string (Max 2000)
Description
A secure link to upload the file.

Response

{
   "wid": "786bb91c-35ec-49bb-bc28-1d2930d7db6a",
   "vault_id": "53ac20e4-8287-4bd7-b7e7-8f09b056325f",
   "upload_url": "https://vault.files.wealth.com/upload/..."
}

PATCHadvisor-api.wealth.com/v2/top-accounts/{wid}/documents/{vault_id}

Update Document Metadata

The Update Document Metadata call allows you to update the metadata for a document without changing the file. This endpoint expects a wid for the top account and a vault_id for the document to be passed as part of the URL.

Update Document Metadata Request Object

Name
description
Type
string (Max 2000), optional
Description
The description for the document.
Name
category
Type
string enum, optional
Description
The category for the document. See Category Sub-Category Type Values for enum values.
Name
sub_category
Type
string enum, optional
Description
The sub-category for the document. See Category Sub-Category Type Values for enum values.
Name
type
Type
string enum, optional
Description
The type for the document. See Category Sub-Category Type Values for enum values.
Name
tags
Type
string array, optional
Description
An array of tags to associate with the document.

Request

PATCH

advisor-api.wealth.com/v2/top-accounts/{wid}/documents/{vault_id}

curl --location 'https://advisor-api.wealth.com/v2/top-accounts/786bb91c-35ec-49bb-bc28-1d2930d7db6a/documents/53ac20e4-8287-4bd7-b7e7-8f09b056325f' -X PATCH \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer xxxxxxxxxxxxx' \
  --data-raw '{
      "description": "John Doe SLAT Revised",
      "tags": ["trust", "estate-planning", "slat", "revised"]
    }'

Update Document Metadata Response Object

See the Get Document Metadata response object.

PATCHadvisor-api.wealth.com/v2/top-accounts/{wid}/documents/{vault_id}/re-upload

Re-Upload Document

The Re-Upload Document call generates a new upload URL to replace the existing file for a document. This endpoint expects a wid for the top account and a vault_id for the document to be passed as part of the URL. No request body is required.

Request

PATCH

advisor-api.wealth.com/v2/top-accounts/{wid}/documents/{vault_id}/re-upload

curl --location 'https://advisor-api.wealth.com/v2/top-accounts/786bb91c-35ec-49bb-bc28-1d2930d7db6a/documents/53ac20e4-8287-4bd7-b7e7-8f09b056325f/re-upload' -X PATCH \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer xxxxxxxxxxxxx'

Re-Upload Document Response Object

Name
wid
Type
string (Max 64)
Description
Wealth.com unique identifier for the top account.
Name
vault_id
Type
string (Max 64)
Description
Wealth.com unique identifier for the document.
Name
upload_url
Type
string (Max 2000)
Description
A secure link to upload the file. This replaces the existing file.

Response

{
   "wid": "786bb91c-35ec-49bb-bc28-1d2930d7db6a",
   "vault_id": "53ac20e4-8287-4bd7-b7e7-8f09b056325f",
   "upload_url": "https://vault.files.wealth.com/upload/..."
}

Category Sub-Category Type Values

Category	Sub-Category	Type
Identification	BirthCertificate	—
Identification	DriversLicense	—
Identification	Passport	—
Identification	GreenCardVisa	—
Identification	TSAPreGlobalEntry	—
Identification	AirlineFrequentFlyerIdentification	—
Identification	NameChangeOrders	—
Identification	MedicalIdentificationCards	—
Identification	MilitaryDischargePapers	—
Identification	Other	—
Family	MarriageCertificate	—
Family	MaritalAgreements	—
Family	DivorceSeparationDocuments	—
Family	DomesticPartnershipCertificate	—
Family	AdoptionDocuments	—
Family	DeathCertificate	—
Family	Other	—
EstatePlanning	WillsSupportingDocuments	—
EstatePlanning	RevocableTrustsSupportingDocuments	—
EstatePlanning	RevocableTrustsSupportingDocuments	PourOverWill
EstatePlanning	IrrevocableTrusts	—
EstatePlanning	IrrevocableTrusts	DynastyTrust
EstatePlanning	IrrevocableTrusts	SLAT
EstatePlanning	IrrevocableTrusts	GRAT
EstatePlanning	IrrevocableTrusts	ILIT
EstatePlanning	IrrevocableTrusts	CRUT
EstatePlanning	IrrevocableTrusts	QPRT
EstatePlanning	IrrevocableTrusts	OtherIrrevocableTrust
EstatePlanning	AdvanceHealthCareDirectiveLivingWills	—
EstatePlanning	FinancialPowersofAttorney	—
EstatePlanning	NominationsofGuardianship	—
EstatePlanning	LettersofIntent	—
EstatePlanning	PersonalInventoryList	—
EstatePlanning	BeneficiaryDesignations	—
EstatePlanning	InsurancePolicies	—
EstatePlanning	CharitableGiving	—
EstatePlanning	Other	—
EstatePlanning	PresentationMaterials	—
Assets	RealEstateLeasesDeeds	—
Assets	Investments	—
Assets	StorageUnits	—
Assets	SafeDepositBoxes	—
Assets	GunFirearmPermits	—
Assets	Other	—
Taxes	Form1099	—
Taxes	Form1040IncomeTaxReturn	—
Taxes	FormW2	—
Taxes	ScheduleK1	—
Taxes	Form8949Crypto	—
Taxes	Form709Form706	—
Taxes	Form1098	—
Taxes	Other	—
WorkBusiness	EmploymentConsultingAgreements	—
WorkBusiness	OptionsAgreements	—
WorkBusiness	NDAs	—
WorkBusiness	PartnershipsLLCs	—
WorkBusiness	Corporations	—
WorkBusiness	EmployeeBenefits	—
WorkBusiness	PerformanceReviews	—
WorkBusiness	Other	—
Miscellaneous	Uncategorized	—
Miscellaneous	Other	—