GET api/v2/investor/accounts2?clientIdentifier={clientIdentifier}&showAway={showAway}&showHome={showHome}

Returns a list of accounts for a given user.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
clientIdentifier

source system client identifier for end-user

 string

Required
showAway

show Held Away Accounts (true by default)

 boolean

None.
showHome

show Managed Accounts (true by default)

 boolean

None.

Body Parameters

None.

Response Information

Resource Description

List of accounts models

ApiListResponseOfInvestorAccountModel
NameDescriptionTypeAdditional information
Records

Collection of InvestorAccountModel

None.
TotalLength

integer

None.

Response Formats

application/json, text/json

Sample: 
{
  "Records": [
    {
      "AccountId": 1,
      "IsAsset": true,
      "Name": "sample string 3",
      "AccountNumber": "sample string 4",
      "Balance": 5.0,
      "InstitutionName": "sample string 6",
      "InstitutionId": 7,
      "ClassificationId": 8,
      "ClassificationName": "sample string 9",
      "ClassificationSort": 10,
      "SubClassificationId": 11,
      "SubClassificationName": "sample string 12",
      "CreatedDate": "2025-01-02T15:28:39.9783947-06:00",
      "LastUpdated": "2025-01-02T15:28:39.9783947-06:00",
      "HasError": true,
      "IsUpdating": true,
      "ClosedDate": "2025-01-02T15:28:39.9783947-06:00"
    },
    {
      "AccountId": 1,
      "IsAsset": true,
      "Name": "sample string 3",
      "AccountNumber": "sample string 4",
      "Balance": 5.0,
      "InstitutionName": "sample string 6",
      "InstitutionId": 7,
      "ClassificationId": 8,
      "ClassificationName": "sample string 9",
      "ClassificationSort": 10,
      "SubClassificationId": 11,
      "SubClassificationName": "sample string 12",
      "CreatedDate": "2025-01-02T15:28:39.9783947-06:00",
      "LastUpdated": "2025-01-02T15:28:39.9783947-06:00",
      "HasError": true,
      "IsUpdating": true,
      "ClosedDate": "2025-01-02T15:28:39.9783947-06:00"
    }
  ],
  "TotalLength": 1
}

application/xml, text/xml

Sample: 
<ApiListResponseOfInvestorAccountModelV4p3MQZm xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ExternalAPI.Models">
  <Records xmlns:d2p1="http://schemas.datacontract.org/2004/07/WealthAccessDataModels.Investors.Models">
    <d2p1:InvestorAccountModel>
      <d2p1:AccountId>1</d2p1:AccountId>
      <d2p1:AccountNumber>sample string 4</d2p1:AccountNumber>
      <d2p1:Balance>5</d2p1:Balance>
      <d2p1:ClassificationId>8</d2p1:ClassificationId>
      <d2p1:ClassificationName>sample string 9</d2p1:ClassificationName>
      <d2p1:ClassificationSort>10</d2p1:ClassificationSort>
      <d2p1:ClosedDate>2025-01-02T15:28:39.9783947-06:00</d2p1:ClosedDate>
      <d2p1:CreatedDate>2025-01-02T15:28:39.9783947-06:00</d2p1:CreatedDate>
      <d2p1:HasError>true</d2p1:HasError>
      <d2p1:InstitutionId>7</d2p1:InstitutionId>
      <d2p1:InstitutionName>sample string 6</d2p1:InstitutionName>
      <d2p1:IsAsset>true</d2p1:IsAsset>
      <d2p1:IsUpdating>true</d2p1:IsUpdating>
      <d2p1:LastUpdated>2025-01-02T15:28:39.9783947-06:00</d2p1:LastUpdated>
      <d2p1:Name>sample string 3</d2p1:Name>
      <d2p1:SubClassificationId>11</d2p1:SubClassificationId>
      <d2p1:SubClassificationName>sample string 12</d2p1:SubClassificationName>
    </d2p1:InvestorAccountModel>
    <d2p1:InvestorAccountModel>
      <d2p1:AccountId>1</d2p1:AccountId>
      <d2p1:AccountNumber>sample string 4</d2p1:AccountNumber>
      <d2p1:Balance>5</d2p1:Balance>
      <d2p1:ClassificationId>8</d2p1:ClassificationId>
      <d2p1:ClassificationName>sample string 9</d2p1:ClassificationName>
      <d2p1:ClassificationSort>10</d2p1:ClassificationSort>
      <d2p1:ClosedDate>2025-01-02T15:28:39.9783947-06:00</d2p1:ClosedDate>
      <d2p1:CreatedDate>2025-01-02T15:28:39.9783947-06:00</d2p1:CreatedDate>
      <d2p1:HasError>true</d2p1:HasError>
      <d2p1:InstitutionId>7</d2p1:InstitutionId>
      <d2p1:InstitutionName>sample string 6</d2p1:InstitutionName>
      <d2p1:IsAsset>true</d2p1:IsAsset>
      <d2p1:IsUpdating>true</d2p1:IsUpdating>
      <d2p1:LastUpdated>2025-01-02T15:28:39.9783947-06:00</d2p1:LastUpdated>
      <d2p1:Name>sample string 3</d2p1:Name>
      <d2p1:SubClassificationId>11</d2p1:SubClassificationId>
      <d2p1:SubClassificationName>sample string 12</d2p1:SubClassificationName>
    </d2p1:InvestorAccountModel>
  </Records>
  <TotalLength>1</TotalLength>
</ApiListResponseOfInvestorAccountModelV4p3MQZm>