Data API ExamplesAuthentication
| API | Description |
|---|---|
| POST api/v1/advisor/authentication?username={username}&password={password}&apiKey={apiKey} |
Validates the consumer's username, password, and apiKey and returns the unique external identifier for the associated advisor. |
Investor
| API | Description |
|---|---|
| GET api/v1/advisor/investor?investorId[0]={investorId[0]}&investorId[1]={investorId[1]}&firstName={firstName}&lastName={lastName}&userName={userName} |
Returns a list of investors for a given advisor |
| GET api/v1/advisor/investor?emailAddress={emailAddress} |
Returns a unique client identifier |
| GET api/v1/advisor/investor?fullInvestorList={fullInvestorList} |
Returns all unique client identifiers for an advisor |
Firm
| API | Description |
|---|---|
| GET api/v1/advisor/firm?firm={firm} |
Returns a list of all clients under a firm. |
OrionInvestors
| API | Description |
|---|---|
| GET api/v1/firm/orioninvestors?firm={firm} |
Returns a list of all clients under a firm. |
FinancialInstitution
| API | Description |
|---|---|
| GET api/v1/advisor/financialinstitution?investorId[0]={investorId[0]}&investorId[1]={investorId[1]}&includeTransactions={includeTransactions}&includeClassifications={includeClassifications}&startDate={startDate}&endDate={endDate} |
Returns a list of financial institutions, Accounts, Holdings, and Transactions for the investors associated to an advisor. |
MGP
| API | Description |
|---|---|
| GET api/v1/advisor/mgp?householdId={householdId} |
Returns a Household which contains a list of household users, custodians, and accounts. |
| GET api/v1/advisor/mgp?orionHouseholdId={orionHouseholdId} |
No documentation available. |
Validation
| API | Description |
|---|---|
| GET api/v1/advisor/validation?apiKey={apiKey}&externalUserId={externalUserId} |
Returns a boolean that indicates if an ApiKey/ExternalUserId combination is valid. |
FirmMGP
| API | Description |
|---|---|
| GET api/v1/firm/mgp?orionHouseholdId={orionHouseholdId}&externalUserId={externalUserId}&apiKey={apiKey} |
Returns a Household which contains a list of household users, custodians, and accounts. |
Vault
| API | Description |
|---|---|
| GET api/v1/advisor/vault |
Gets Vault upload file settings. |
| POST api/v1/advisor/vault?investorId={investorId}&fileName={fileName}&fileUploadFolder={fileUploadFolder} |
Upload a vault file for an given investor. |