Financial Institution

Get the collection of Financial Institutions

Changed on
get/fis

Request

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

Query parameters

namestring

Financial institution name search criteria (contains)

nameUserLoginURLstring

Financial institution name-plus-URL search criteria (contains)

pageinteger

page number

sizeinteger

number of records per page

Response

Ok

pageSizeinteger

Number of records per page

pageNumberinteger

Page number of this page

totalPagesinteger

Total number of pages in result set

totalElementsinteger

Total number of elements in result set

isFirstboolean

True if and only if this is the first page of data in the result set

isLastboolean

True if and only if this is the last page of data in the result set

summaryDefaultSummaryDto

Example response

{
  "pageSize": 25,
  "totalPages": 1,
  "totalElements": 1,
  "isFirst": true,
  "isLast": true,
  "data": [
    {
      "id": 12484,
      "name": "Chase Online",
      "userLoginURL": "https://chaseonline.chase.com/Logon.aspx?LOB=COLLogin",
      "websiteURL": "https://chaseonline.chase.com/Logon.aspx?LOB=COLLogin",
      "popularity": 1,
      "popularityConsumer": 1,
      "loginTerm": "User ID",
      "pwTerm": "Password",
      "accountNumberTerm": "Account Number",
      "loginTermDetails": "The User ID used to access this service",
      "pwTermDetails": "The password used to access this service",
      "accountNumberTermDetails": "Enter the account number as shown on the Portfolio Summary page. If the account number shown is not unique, enter the account name. If the account name is not unique, give it a unique nickname.",
      "accessInstructions": "This service uses Chase Online to retrieve your financial information...",
      "supportsAccountDiscovery": true,
      "supportsOAuth": true,
      "supportsTestCredential": true,
      "requiresInSessionActivation": true,
      "requiresSQA": true,
      "requiresSecondPW": true,
      "knownConnectionIssue": "We are currently experiencing a problem connecting to the financial institution and this may affect your ability to successfully connect accounts. We are working hard to resolve the problem. Please check back later.",
      "configuredOAuth": true,
      "logo": "https://www.byallaccounts.net/WebPortfolio/vendorResources/Default/assets/fi/logos/logo.png",
      "icon": "https://www.byallaccounts.net/WebPortfolio/vendorResources/Default/assets/fi/icons/icon.svg",
      "knownConnectionIssueLongTerm": "Aggregation access is blocked by this financial institution. Contact your representative at the financial institution and request aggregation access for Morningstar.",
      "licensed": true
    }
  ]
}

Changes