GET api/v1/firm/mgp?orionHouseholdId={orionHouseholdId}&externalUserId={externalUserId}&apiKey={apiKey}
Returns a Household which contains a list of household users, custodians, and accounts.
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| orionHouseholdId |
Required: Id that identifies the Orion household. |
integer |
Required |
| externalUserId |
Required: Unique identifier provided by Wealth Access. |
string |
Required |
| apiKey |
Required: Unique identifier provided by Wealth Access. |
string |
Required |
Body Parameters
None.
Response Information
Resource Description
List of financial institution models
MGPResponse| Name | Description | Type | Additional information |
|---|---|---|---|
| Household | Household |
None. |
|
| Resources | Resources |
None. |
Response Formats
application/json, text/json
Sample:
{
"Household": {
"Id": 1,
"Participants": {
"Client": {
"UniqueClientKey": 1,
"FirstName": "sample string 2",
"LastName": "sample string 3",
"DOB": "sample string 4",
"State": "sample string 5",
"MaritalStatus": 6,
"Gender": 7
},
"Coclient": {
"UniqueCoClientKey": 1,
"FirstName": "sample string 1",
"LastName": "sample string 2",
"DOB": "sample string 3",
"Gender": 1
},
"Dependents": [
{
"UniqueDependentId": 1,
"FirstName": "sample string 2",
"DOB": "sample string 3",
"Type": 4
},
{
"UniqueDependentId": 1,
"FirstName": "sample string 2",
"DOB": "sample string 3",
"Type": 4
}
]
}
},
"Resources": {
"InvestmentAssets": [
{
"UniqueInvestmentId": 1,
"Source": "sample string 2",
"CurrentValue": 3.0,
"CostBasis": 4.0,
"AsOfDate": "2025-01-04T07:26:09.257542-06:00",
"Type": "sample string 6",
"Description": "sample string 7",
"Holdings": [
{
"UniqueHoldingKey": 1,
"Description": "sample string 2",
"Ticker": "sample string 3",
"Quantity": 4.0,
"CurrentValue": 5.0
},
{
"UniqueHoldingKey": 1,
"Description": "sample string 2",
"Ticker": "sample string 3",
"Quantity": 4.0,
"CurrentValue": 5.0
}
]
},
{
"UniqueInvestmentId": 1,
"Source": "sample string 2",
"CurrentValue": 3.0,
"CostBasis": 4.0,
"AsOfDate": "2025-01-04T07:26:09.257542-06:00",
"Type": "sample string 6",
"Description": "sample string 7",
"Holdings": [
{
"UniqueHoldingKey": 1,
"Description": "sample string 2",
"Ticker": "sample string 3",
"Quantity": 4.0,
"CurrentValue": 5.0
},
{
"UniqueHoldingKey": 1,
"Description": "sample string 2",
"Ticker": "sample string 3",
"Quantity": 4.0,
"CurrentValue": 5.0
}
]
}
],
"OtherAssets": [
{
"UniqueOtherAssetId": 1,
"Source": "sample string 2",
"Description": "sample string 3",
"Type": "sample string 4",
"AsOfDate": "2025-01-04T07:26:09.257542-06:00",
"CurrentValue": 6.0
},
{
"UniqueOtherAssetId": 1,
"Source": "sample string 2",
"Description": "sample string 3",
"Type": "sample string 4",
"AsOfDate": "2025-01-04T07:26:09.257542-06:00",
"CurrentValue": 6.0
}
],
"Liabilities": [
{
"UniqueLiabilitiesKey": 1,
"Source": "sample string 2",
"Description": "sample string 3",
"Type": "sample string 4",
"AsOfDate": "2025-01-04T07:26:09.257542-06:00",
"OutstandingBalance": 6.0,
"MonthlyPaymentAmount": 1.0,
"LoanAmount": 1.0,
"InterestRate": 1.0
},
{
"UniqueLiabilitiesKey": 1,
"Source": "sample string 2",
"Description": "sample string 3",
"Type": "sample string 4",
"AsOfDate": "2025-01-04T07:26:09.257542-06:00",
"OutstandingBalance": 6.0,
"MonthlyPaymentAmount": 1.0,
"LoanAmount": 1.0,
"InterestRate": 1.0
}
]
}
}
application/xml, text/xml
Sample:
<MGPResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ExternalAPI.Models.MGP">
<Household>
<Id>1</Id>
<Participants>
<Client>
<DOB>sample string 4</DOB>
<FirstName>sample string 2</FirstName>
<Gender>7</Gender>
<LastName>sample string 3</LastName>
<MaritalStatus>6</MaritalStatus>
<State>sample string 5</State>
<UniqueClientKey>1</UniqueClientKey>
</Client>
<Coclient>
<DOB>sample string 3</DOB>
<FirstName>sample string 1</FirstName>
<Gender>1</Gender>
<LastName>sample string 2</LastName>
<UniqueCoClientKey>1</UniqueCoClientKey>
</Coclient>
<Dependents>
<Dependent>
<DOB>sample string 3</DOB>
<FirstName>sample string 2</FirstName>
<Type>4</Type>
<UniqueDependentId>1</UniqueDependentId>
</Dependent>
<Dependent>
<DOB>sample string 3</DOB>
<FirstName>sample string 2</FirstName>
<Type>4</Type>
<UniqueDependentId>1</UniqueDependentId>
</Dependent>
</Dependents>
</Participants>
</Household>
<Resources>
<InvestmentAssets>
<InvestmentAsset>
<AsOfDate>2025-01-04T07:26:09.257542-06:00</AsOfDate>
<CostBasis>4</CostBasis>
<CurrentValue>3</CurrentValue>
<Description>sample string 7</Description>
<Holdings>
<Holding>
<CurrentValue>5</CurrentValue>
<Description>sample string 2</Description>
<Quantity>4</Quantity>
<Ticker>sample string 3</Ticker>
<UniqueHoldingKey>1</UniqueHoldingKey>
</Holding>
<Holding>
<CurrentValue>5</CurrentValue>
<Description>sample string 2</Description>
<Quantity>4</Quantity>
<Ticker>sample string 3</Ticker>
<UniqueHoldingKey>1</UniqueHoldingKey>
</Holding>
</Holdings>
<Source>sample string 2</Source>
<Type>sample string 6</Type>
<UniqueInvestmentId>1</UniqueInvestmentId>
</InvestmentAsset>
<InvestmentAsset>
<AsOfDate>2025-01-04T07:26:09.257542-06:00</AsOfDate>
<CostBasis>4</CostBasis>
<CurrentValue>3</CurrentValue>
<Description>sample string 7</Description>
<Holdings>
<Holding>
<CurrentValue>5</CurrentValue>
<Description>sample string 2</Description>
<Quantity>4</Quantity>
<Ticker>sample string 3</Ticker>
<UniqueHoldingKey>1</UniqueHoldingKey>
</Holding>
<Holding>
<CurrentValue>5</CurrentValue>
<Description>sample string 2</Description>
<Quantity>4</Quantity>
<Ticker>sample string 3</Ticker>
<UniqueHoldingKey>1</UniqueHoldingKey>
</Holding>
</Holdings>
<Source>sample string 2</Source>
<Type>sample string 6</Type>
<UniqueInvestmentId>1</UniqueInvestmentId>
</InvestmentAsset>
</InvestmentAssets>
<Liabilities>
<Liability>
<AsOfDate>2025-01-04T07:26:09.257542-06:00</AsOfDate>
<Description>sample string 3</Description>
<InterestRate>1</InterestRate>
<LoanAmount>1</LoanAmount>
<MonthlyPaymentAmount>1</MonthlyPaymentAmount>
<OutstandingBalance>6</OutstandingBalance>
<Source>sample string 2</Source>
<Type>sample string 4</Type>
<UniqueLiabilitiesKey>1</UniqueLiabilitiesKey>
</Liability>
<Liability>
<AsOfDate>2025-01-04T07:26:09.257542-06:00</AsOfDate>
<Description>sample string 3</Description>
<InterestRate>1</InterestRate>
<LoanAmount>1</LoanAmount>
<MonthlyPaymentAmount>1</MonthlyPaymentAmount>
<OutstandingBalance>6</OutstandingBalance>
<Source>sample string 2</Source>
<Type>sample string 4</Type>
<UniqueLiabilitiesKey>1</UniqueLiabilitiesKey>
</Liability>
</Liabilities>
<OtherAssets>
<OtherAsset>
<AsOfDate>2025-01-04T07:26:09.257542-06:00</AsOfDate>
<CurrentValue>6</CurrentValue>
<Description>sample string 3</Description>
<Source>sample string 2</Source>
<Type>sample string 4</Type>
<UniqueOtherAssetId>1</UniqueOtherAssetId>
</OtherAsset>
<OtherAsset>
<AsOfDate>2025-01-04T07:26:09.257542-06:00</AsOfDate>
<CurrentValue>6</CurrentValue>
<Description>sample string 3</Description>
<Source>sample string 2</Source>
<Type>sample string 4</Type>
<UniqueOtherAssetId>1</UniqueOtherAssetId>
</OtherAsset>
</OtherAssets>
</Resources>
</MGPResponse>