Purpose: Creating and updating a prospect in the Advisor Portal (Element) for use with the New Account and Proposal process from outside of Element. This would allow you to gather data ahead of time, and push those prospects directly into Element.
Simple Use Case: Using data collected within a CRM or via a new client form, a firm creates a “Send to Orion” function that creates and/or updates a prospect record within the Advisor Portal (Element).
Scope and Outputs: While the Create prospect step only requires a few fields, the updating step does require numerous new fields. The proposal process of the Advisor Portal uses this method to allow an initial prospect to be created with simple data, but requires the full prospect object to be updated at the final step when the Rep completes the proposal. This can create confusion when attempting to create a prospect only through the API for the proposal process. It may be valuable to talk through this with an Advisor Portal technical expert before starting this work.
Process Overview:
- Create a prospect in Element for a Rep (Advisor)
- Update a prospect with additional information
- Get a list of all prospects for a given Rep
Process Steps:
- Get Advisor Portal (Element) Token. See guide specifically for getting an Element token.
- POST to New Household API to create prospect.
Example call to create a prospect with minimum data:
fetch("https://api.orionelement.com/v1/NewHouseholds?saveNewAccounts=true", {
"headers": {
"accept": "application/json, text/plain, */*",
"accept-language": "en-US,en;q=0.9",
"authorization": "{{elementToken}}",
"content-type": "application/json",
"sec-ch-ua": "\"Chromium\";v=\"92\", \" Not A;Brand\";v=\"99\", \"Google Chrome\";v=\"92\"",
"sec-ch-ua-mobile": "?0",
"sec-fetch-dest": "empty",
"sec-fetch-mode": "cors",
"sec-fetch-site": "same-site"
},
"referrer": "https://www.orionelement.com/",
"referrerPolicy": "strict-origin-when-cross-origin",
"body": "{"
name ":"
Test Prospect ","
newHouseholdOwners ":[{"
email ":"
testprospect @orion.com ","
firstName ":"
Test ","
lastName ":"
Prospect ","
middleInitial ":"
A "}],"
repId ":4232}",
"method": "POST",
"mode": "cors",
"credentials": "include"
});- POST to New Household API to update prospects as needed.
Example call to Update a prospect with additional values:
Fetch("https://api.orionelement.com/v1/NewHouseholds?saveNewAccounts=true", {
"headers": {
"accept": "application/json, text/plain, */*",
"accept-language": "en-US,en;q=0.9",
"authorization": "{{elementToken}}",
"content-type": "application/json",
"sec-ch-ua": "\"Chromium\";v=\"92\", \" Not A;Brand\";v=\"99\", \"Google Chrome\";v=\"92\"",
"sec-ch-ua-mobile": "?0",
"sec-fetch-dest": "empty",
"sec-fetch-mode": "cors",
"sec-fetch-site": "same-site"
},
"referrer": "https://www.orionelement.com/",
"referrerPolicy": "strict-origin-when-cross-origin",
"body": "{"
currentAccountInfoTab ":"
new - household ","
currentNavigation ":"
newaccount - allocations ","
currentPage ":"
3 ","
id ":100407,"
name ":"
Test Prospect ","
navigation ":{"
id ":8,"
name ":"
Accounts Allocation ","
order ":8,"
requiresIsOpenAccount ":true,"
section ":"
newaccount - allocations ","
subsectionOfPage ":3},"
newAccounts ":[{"
advisoryFee ":"
2: 746 ","
allocationsClicked ":true,"
allocationsStatus ":"
Complete ","
createdDate ":"
2021 - 08 - 12 T00: 04: 51.5864678 ","
custodian ":{"
code ":"
TDW ","
id ":2,"
isDocuSign ":true,"
isNewAccounts ":true,"
maxCombinedBeneficiary ":6,"
name ":"
TD Ameritrade ","
orionId ":17,"
useAccountNubmers ":true,"
useMaxCombinedBeneficiary ":true},"
custodianId ":2,"
elementVersion ":2,"
entityAccountInfo ":{"
controlPersonDOB ":"
0001 - 01 - 01 T00: 00: 00 "},"
hasPendingRegistrationInOC ":true,"
id ":109033,"
investmentAmount ":123123,"
isSelfDirected ":true,"
lastStatusDate ":"
2021 - 08 - 12 T00: 05: 03.4788073 Z ","
name ":"
Test Prospect ","
newHouseholdId ":100407,"
orionPayoutRateId ":746,"
primaryOwner ":{"
email ":"
testprospect @orion.com ","
firstName ":"
Test ","
lastName ":"
Prospect ","
middleInitial ":"
A ","
name ":"
Test Prospect ","
newHouseholdOwnerId ":204944,"
tempId ":"
d8653f92 - 781 d - b865 - ce10 - 94 db9476641b "},"
primaryOwnerId ":204944,"
rebalanceFrequency ":"
No Rebalance ","
registrationSleeve ":{"
accountSleeves ":[{"
canChangeModel ":true,"
isValid ":true,"
mandate ":"
Active ","
modelAgg ":"
AAMA Balanced Growth ","
modelAggId ":104882,"
modelId ":8,"
orionModelId ":8,"
subAdvisor ":"
Advanced Asset Management Advisors ","
subAdvisorId ":20,"
targetAllocation ":"
50 ","
targetRisk ":66},{"
canChangeModel ":true,"
isValid ":true,"
mandate ":"
Self Directed ","
targetAllocation ":50,"
targetRisk ":67}],"
createdBy ":"
joe.smith ","
createdDate ":"
2021 - 08 - 12 T00: 04: 51.5381003 Z ","
editedBy ":"
joe.smith ","
editedDate ":"
2021 - 08 - 12 T00: 05: 03.7960549 Z ","
newAccountId ":109033,"
newAccountRegistrationSleeveId ":97720},"
registrationType ":{"
category ":2,"
id ":4,"
name ":"
Individual ","
orionRegistrationTypeId ":8},"
registrationTypeId ":4,"
repId ":4232,"
riskQuestionnaireId ":104745,"
selfDirectedAccountProduct ":[{"
allocation ":"
99 ","
newAccountId ":109033,"
orionProductId ":115972,"
productCategoryName ":"
World Allocation ","
productClassName ":"
World Allocation ","
productName ":"
BlackRock Global Allocation A ","
riskScore ":68,"
ticker ":"
MDLOX "},{"
allocation ":1,"
newAccountId ":109033,"
orionProductId ":1174473,"
productCategoryName ":"
Money Market ","
productClassName ":"
Money Market ","
ticker ":"
CUSTODIAL_CASH "}],"
statusColor ":"
#61a2d8","statusDescription":"In Progress"}],
"newHouseholdOwners":[
{"email":"testprospect@orion.com",
"firstName":"Test","lastName":
"Prospect","lockedIn":true,
"middleInitial":"A",
"name":"Test Prospect",
"newHouseholdOwnerId":204944,
"tempId":"d8653f92-781d-b865-ce10-94db9476641b"}],
"repId":4232,
"riskQuestionnaire":{"id":104743,"targetRiskScore":"56"},
"riskQuestionnaireId":104743,
"selectedAccount":{"advisoryFee":"2: 746",
"allocationsClicked":true,
"allocationsStatus":
"Complete","createdDate":"2021-08-12T00:04:51.5864678",
"custodianId":2,
"elementVersion":2,
"hasPendingRegistrationInOC":true,
"id":109033,
"investmentAmount":123123,
"isSelfDirected":true,
"lastStatusDate":"2021-08-12T00:05:03.4788073Z",
"name":"Test Prospect",
"newHouseholdId":100407,
"orionPayoutRateId":746,
"primaryOwnerId":204944,
"rebalanceFrequency":"No Rebalance",
"registrationTypeId":4,
"repId":4232,
"riskQuestionnaireId":104745,
"selfDirectedAccountProduct":[
{"allocation":"99",
"newAccountId":109033,
"orionProductId":115972,
"productCategoryName":"World Allocation",
"productClassName":"World Allocation",
"productName":"BlackRock Global Allocation A",
"riskScore":68,
"ticker":"MDLOX"},
{"allocation":1,
"newAccountId":109033,
"orionProductId":1174473,
"productCategoryName":"Money Market",
"productClassName":"Money Market",
"ticker":"CUSTODIAL_CASH"}],
"statusColor":"# 61 a2d8 ","
statusDescription ":"
In Progress "}}",
"method": "POST",
"mode": "cors",
"credentials": "include"
});- Make call for a list of prospects for a given representative.
GET https://{devapi/stageapi/api}.orionelement.com/v1//Rep/{repId}/NewHouseholds
Example Call To Get All Prospects
fetch("https://api.orionelement.com/v1/Rep/4232/NewHouseholds", {
"headers": {
"accept": "application/json, text/plain, */*",
"accept-language": "en-US,en;q=0.9",
"authorization": "{{elementToken}}",
"sec-ch-ua": "\"Chromium\";v=\"92\", \" Not A;Brand\";v=\"99\", \"Google Chrome\";v=\"92\"",
"sec-ch-ua-mobile": "?0",
"sec-fetch-dest": "empty",
"sec-fetch-mode": "cors",
"sec-fetch-site": "same-site"
},
"referrer": "https://www.orionelement.com/",
"referrerPolicy": "strict-origin-when-cross-origin",
"body": null,
"method": "GET",
"mode": "cors",
"credentials": "include"
});
Process Tips or Controls:
As noted in the above calls, to create a prospect we only require the following fields:
"name":"Test Prospect", -- Name of the household you will be creating
"newHouseholdOwners":[ -- List of owners on the new household you will be creating
{
"email":"testprospect@orion.com",
"firstName":"Test",
"lastName":"Prospect",
"middleInitial":"A"
}
],
"repId":4232 -- The Id of the rep this will be created for.