Data API Examples

Introduction

This is an API which allows external vendors to integrate with Wealth Access. In order to successfully call this API, the following values must first be provided by Wealth Access: API Key, Secret and at least one Advisor External User Id.

Read About Authentication See Documentation for Version 1

ADVISOR Based Endpoints

Diversifications

API	Description
GET api/v2/Advisor/Diversifications	Returns a list of possible diversifications for an advisor.

Accounts

API	Description
GET api/v2/advisor/accounts?ignoreOrion={ignoreOrion}	Returns a list of accounts for a given advisor.

AdvisorInvestorDiversificationHoldings

API	Description
GET api/v2/advisor/investors/{investorId}/diversificationholdings?diversificationId={diversificationId}&categoryId={categoryId}&ignoreOrion={ignoreOrion}	Returns a list of holdings and their diversification for a given investor. Investor is specified by the investorId returned from the advisor/investors endpoint.

AdvisorInvestorDocuments

API	Description
GET api/v2/advisor/investors/{investorId}/documents?parentId={parentId}&searchTerm={searchTerm}	Returns a list of documents for a given investor. Investor is specified by the investorId returned from the advisor/investors endpoint.
GET api/v2/advisor/investors/{investorId}/documents/{VaultFileId}?IsPreview={IsPreview}&AdvisorId={AdvisorId}	Download specific file or folder. Investor is specified by the investorId returned from the advisor/investors endpoint.
POST api/v2/advisor/investors/{InvestorId}/documents?ParentId={ParentId}	Upload file specified by the investorId returned from the advisor/investors endpoint.

AdvisorInvestorBrokerageTransactions

API	Description
GET api/v2/advisor/investors/{investorId}/brokeragetransactions?startDate={startDate}&endDate={endDate}&ignoreOrion={ignoreOrion}	Returns a list of brokerage transactions for a given investor. Investor is specified by the investorId returned from the advisor/investors endpoint.

AdvisorInvestorBankTransactions

API	Description
GET api/v2/advisor/investors/{investorId}/banktransactions?hideTransfers={hideTransfers}&startDate={startDate}&endDate={endDate}&ignoreOrion={ignoreOrion}	Returns a list of transactions for a given investor.

MGPInvestorAccess

API	Description
GET api/v2/advisor/mgpinvestoraccess?householdId={householdId}	Returns a list of eligible members who have access to the household
PUT api/v2/advisor/mgpinvestoraccess?uniqueKey={uniqueKey}&hasMoneyGuideClientPortalAccess={hasMoneyGuideClientPortalAccess}	Enables or disables access for a specific MGP member.

AdvisorInvestorAccounts

API	Description
GET api/v2/advisor/investors/{investorId}/accounts?ignoreOrion={ignoreOrion}	Returns a list of accounts for a given investor. Investor is specified by the investorId returned from the advisor/investors endpoint.
GET api/v2/advisor/orioninvestors/{householdId}/accounts	No documentation available.

AdvisorInvestorTransactions

API	Description
GET api/v2/advisor/investors/{investorId}/transactions?startDate={startDate}&endDate={endDate}&ignoreOrion={ignoreOrion}	Returns a list of brokerage transactions for a given investor. Investor is specified by the investorId returned from the advisor/investors endpoint.
GET api/v2/advisor/orioninvestors/{householdId}/transactions?startDate={startDate}&endDate={endDate}	No documentation available.

Investors

API	Description
GET api/v2/advisor/investors	Returns a list of investors for a given advisor.

Transactions

API	Description
GET api/v2/advisor/transactions?startDate={startDate}&endDate={endDate}&transactionId={transactionId}&ignoreOrion={ignoreOrion}	Returns a list of brokerage transactions for all investors under an advisor within the date range or after the transactionId.

Holdings

API	Description
GET api/v2/advisor/holdings?ignoreOrion={ignoreOrion}	Returns a list of holdings for a given advisor.

Classifications

API	Description
GET api/v2/Advisor/Classifications	Returns a list of possible classifications for an advisor

AdvisorInvestorProfile

API	Description
GET api/v2/advisor/investors/{investorId}/profile	Returns the user profile for a given user.

AdvisorInvestorHoldings

API	Description
GET api/v2/advisor/investors/{investorId}/holdings?ignoreOrion={ignoreOrion}	Returns a list of holdings for a given investor. Investor is specified by the investorId returned from the advisor/investors endpoint.
GET api/v2/advisor/orioninvestors/{householdId}/holdings	No documentation available.

INVESTOR Based Endpoints

InvestorAccountTransactions

API	Description
GET api/v2/investor/accounts/transactions?clientIdentifier={clientIdentifier}&accountNumber={accountNumber}&startDate={startDate}&endDate={endDate}	Returns a list of transactions for a given account and user.

InvestorAccountDocuments

API	Description
GET api/v2/investor/accounts/documents?clientIdentifier={clientIdentifier}&accountNumber={accountNumber}	Returns a list of documents for a given account and user.
GET api/v2/investor/accounts/documents/{vaultFileId}?clientIdentifier={clientIdentifier}&accountNumber={accountNumber}	Returns an investor's vault file document for download.
POST api/v2/investor/accounts/documents?clientIdentifier={clientIdentifier}&accountNumber={accountNumber}	Uploads a document for a given account and user.

InvestorAccountOverrides

API	Description
GET api/v2/investor/accounts2?clientIdentifier={clientIdentifier}&showAway={showAway}&showHome={showHome}	Returns a list of accounts for a given user.

InvestorAccounts

API	Description
GET api/v2/investor/accounts?clientIdentifier={clientIdentifier}&showAway={showAway}&showHome={showHome}	Returns a list of accounts for a given user.

InvestorProfile

API	Description
GET api/v2/investor/profile?clientIdentifier={clientIdentifier}	Returns the user profile for a given user.

InvestorAccountHoldings

API	Description
GET api/v2/investor/accounts/holdings?clientIdentifier={clientIdentifier}&accountNumber={accountNumber}	Returns a list of holdings for a given account and user.

FIRM Based Endpoints

FirmInvestors

API	Description
GET api/v2/firm/investors?firm={firm}	Returns a list of all clients under a firm.