---
title: "Get credentials and accounts summary information"
method: GET
path: "/credentials/accounts/summary"
tags: ["Credentials"]
---

# Get credentials and accounts summary information

`GET /credentials/accounts/summary`

## Request

- Base URL: `//basrvqaap6001.morningstar.com/WPDemo/webportfolio/api/v1` (relative, and the document’s source URL is not known)
- URL: `//basrvqaap6001.morningstar.com/WPDemo/webportfolio/api/v1/credentials/accounts/summary`
- Auth: API key in header `Authorization`

Get credentials and any associated accounts in a single list. Credentials that have no associated accounts will also be included. This response also includes information about asynchronous activities for the credentials and accounts.  </br></br>The applicable scope of this endpoint is always a single authenticated investor. This endpoint can provide information on  asynchronous activity for the current session or for all activity in the  system. Use the scope parameter with value session to request  information about activity initiated during the current session. Use the  `scope` parameter with value global to request information for all activity in the system. When `scope` is `global`, asynchronous activity  progress will be available for terminated sessions up to 15 minutes  after completion of that activity. If the `scope` parameter is not  provided then the endpoint will report on activity for the current  session, if there is one. If there is no current session (UIM) then it  will report on all activity for the authenticated investor.  </br></br>You can specify the number of the page to return and the  number of records per page. </br>  </br>**Response Model**  - Special situations for Credentials and Accounts</br>  Credentials and accounts in the aggregation system are complex objects for which the following statements are true: </br></br><span>&#8226;</span> Credentials or accounts can be incomplete, meaning they do not contain enough information to access data from the Financial Institution.  This situation can occur if the user has not yet provided all necessary information (e.g. has not yet provided their password or completed OAUTH authorization) </br></br><span>&#8226;</span> The aggregation system may encounter a variety of errors when attempting to use a credential or an account to access data from a Financial Institution. These errors can occur because the information in the object is incorrect (e.g. a wrong password), problems with the aggregation system’s support (e.g. Financial Institution web site has changed and we need to update our support), or problems at the Financial Institution (e.g. site not available). </br></br>These conditions are not errors from an application perspective, instead they are “normal” things that can happen in the day-to-day of aggregation activities.  It is important to properly represent these conditions to the end user and, whenever possible, help the user to understand when they must take action to resolve the condition or when the solution is not under their control.  Due to the complexity of these error conditions, it is not always possible to make the condition clear to the user.  ByAllAccounts continues to work to improve the clarity of these error conditions.  </br></br>In addition to these situations, the system may be asynchronously performing activities that the user requested, directly or indirectly, on credentials and accounts.  For example, if a request was made to obtain the latest data for an account then an asynchronous aggregation process is going on in the background and we want the end user to understand that it is in process and when that process completes.  This endpoint includes information at the individual object level (credential or account) as well as the summary level (for the collection) to aid in the presentation of this information to the user.  Note also that any asynchronous activity can result in the clearing of an error condition or the encountering of a new condition, so that information should be queried and redisplayed upon completion of the asynchronous activity.  </br></br>For Supplemental Response Model Information including Account and Credential Error Information and Activity in Progress information, refer to the **Overview** page for the ByAllAccounts Account Aggregation at https://developer.morningstar.com/apis/account-aggregation/byallaccounts/overview.

## Query parameters

- `page` integer
- `scope` string
- `size` integer
- `view` string

## Response `200`

Ok

- PageCredentialAccountPairDefaultSummaryDto: A page of data records
  - `pageSize` integer: Number of records per page
  - `pageNumber` integer: Page number of this page
  - `totalPages` integer: Total number of pages in result set
  - `totalElements` integer: Total number of elements in result set
  - `isFirst` boolean: True if and only if this is the first page of data in the result set
  - `isLast` boolean: True if and only if this is the last page of data in the result set
  - `activitySummary` ActivitySummary
    - `activityInProgress` boolean: If scope=`session` (or not set), then true indicates aggregation or authentication is in-progress for at least one credential in the session. If scope=`global`, then true indicates aggregation or authentication is in-progress for at least one credential in the session or authentication or discover/add/aggregate is in progress for at least one credential outside the current session. true, then aggregation is in-progress for at least one credential
  - `summary` DefaultSummaryDto
  - `data` CredentialAccountPair[]
    - `account` Account
      - `accountType` string
      - `aggregationStatusErrorCode` integer
      - `creationDate` string, date-time, required: Account creation date
      - `id` integer, required
      - `lastUpdated` string, date-time
      - `marketValue` CurrencyValue
        - `amount` number
        - `currencyCode` string
      - `maskedAccountNumber` string: Masked account number
      - `name` string
      - `relativeLastUpdatedText` string
    - `activityInProgressStatus` string
    - `authenticationStatusErrorCode` integer: Error code from the latest authentication attempt
    - `creationDate` string, date-time, required: Credential creation date
    - `credentialComplete` boolean, required: Indicates whether the credential contains sufficient information to perform authentication
    - `financialInstitution` FinancialInstitution
      - `accountNumberTerm` string: Term used for the account number at this financial institution
      - `icon` string: The name used for icon at the respective Financial Institution
      - `id` integer, required: ID of the Financial Institution
      - `loginTerm` string: Term used for the login at this financial institution
      - `name` string: Name of the Financial Institution
      - `pwTerm` string: Term used for the password at this financial institution
      - `supportsOauth` boolean, required: Indicates whether the FI supports OAuth flag
    - `group` string, required: Indicates the group to which the records belong
    - `id` integer, required: ID of the Account Credential
    - `lastAuthenticationAttempt` string, date-time: Last authentication attempt
    - `unifiedStatusInfoActionType` string: unifiedStatusInfoActionType computed using type of status information from the latest authentication attempt
    - `unifiedStatusInfoActionableType` string: unifiedStatusInfoActionableType computed using type of status information from the latest authentication attempt
    - `unifiedStatusInfoMiniType` string: unifiedStatusInfoMiniType computed using type of status information from the latest authentication attempt
    - `unifiedStatusInfoMsg` string: Status information from the latest authentication attempt (simplified)
    - `unifiedStatusInfoType` string: Type of status information from the latest authentication attempt

## Other responses

- `400`: Bad Request
- `401`: Not Authorized
- `500`: Internal Server Error

## Changes

- **2026-11-03** `475f167d1874`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/morningstar/apis/byallaccounts-api-07302024/changes/credentials/accounts/summary/get.md)

---

[API](https://skmtc.dev/morningstar/apis/byallaccounts-api-07302024.md) - [All operations](https://skmtc.dev/morningstar/apis/byallaccounts-api-07302024/llms.txt) - [OpenAPI document](https://skmtc.dev/morningstar/apis/byallaccounts-api-07302024/revisions/475f167d1874?raw)
