Get credentials and account information
Changed onGet 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. Use the limitToProgressAfter parameter to request that information for asynchronous activities in the response should be limited to those initiated after the specified point in time. </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>•</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>•</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.
Request
- Base URL//basrvqaap6001.morningstar.com/WPDemo/webportfolio/api/v1 (relative, and the document’s source URL is not known)
- AuthAPI key in header Authorization
Query parameters
Show only credentials/accounts authenticated/aggregated by the user after the specified date. If not specified will return the full list of credentials/accounts. </br></br>Date-time ISO 8601 JSON format yyyy-mm-ddThh:mm:ss.nnnnnn+|-hh:mm Local time relative to GMT. For example: 2019-08-22T15:16:33.045-04:00
Page number
Scope of activity for the authenticated user. Values can be session, to include only session-specific information, or global to also include information from other sessions for this user. Default is session for session-based users and global for users authenticated by Morningstar Authentication.
Number of records per page
Response
Ok
Example response
{
"pageSize": 25,
"totalPages": 1,
"totalElements": 1,
"isFirst": true,
"isLast": true,
"data": [
{
"account": {
"accountType": "CREDITCARD",
"aggregationStatusErrorCode": 1005,
"id": 11223344,
"marketValue": {
"amount": 2078.34,
"currencyCode": "USD"
},
"maskedAccountNumber": "x-1234",
"name": "BofA Checking Account",
"relativeLastUpdatedText": "Updated 05/21/18"
},
"activityInProgressStatus": "In Progress",
"authenticationStatusErrorCode": 1006,
"credentialComplete": true,
"financialInstitution": {
"accountNumberTerm": "Plan Number",
"icon": "https://www.byallaccounts.net/WebPortfolio/vendorResources/Default/assets/fi/icons/icon.svg",
"id": 254367,
"loginTerm": "Login",
"name": "Bank of America - Banking",
"pwTerm": "Password",
"supportsOauth": true
},
"group": "MAIN_GROUP",
"id": 778899,
"lastAuthenticationAttempt": "2022-09-27T05:02:20Z",
"unifiedStatusInfoActionType": "authenticate",
"unifiedStatusInfoActionableType": "userActionable",
"unifiedStatusInfoMiniType": "cannotConnect",
"unifiedStatusInfoMsg": "Cannot connect. Missing Login or Password.",
"unifiedStatusInfoType": "cannotConnectMissingLoginPW"
}
]
}Changes
- info
endpoint added
- info