Financial Institution

Get a financial institution by ID

Changed on
get/fis/{id}

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

Path parameters

idinteger required

The ID of the Financial institution requested

Response

Ok

idinteger required

ID of the Financial Institution

namestring required

Name of the Financial Institution

userLoginURLstring required

User login URL of the Financial Institution

websiteURLstring

User login URL of the Financial Institution

popularityinteger required

Popularity of the Financial Institution, with larger values indicating higher popularity level (currently always either 0 or 1, but other values possible in the future)

popularityConsumerinteger required

Popularity of the Financial Institution at Consumer UI, with larger values indicating higher popularity level (currently always either 0 or 1, but other values possible in the future)

loginTermstring required

The term used for login at the Financial Institution

login2Termstring

The term used for second login at the Financial Institution

pwTermstring required

The term used for PIN at the Financial Institution

pw2Termstring

The term used for second PIN at the Financial Institution

accountNumberTermstring required

The term used for Account Number at the Financial Institution

accountNumber2Termstring

The term used for second Account Number at the Financial Institution

loginTermDetailsstring required

Detailed instructions for the login field at this Financial Institution

login2TermDetailsstring

Detailed instructions for the second login field at this Financial Institution

pwTermDetailsstring required

Detailed instructions for the PIN field at this Financial Institution

pw2TermDetailsstring

Detailed instructions for the second PIN field at this Financial Institution

accountNumberTermDetailsstring required

Detailed instructions for the Account Number field at this Financial Institution

accountNumber2TermDetailsstring

Detailed instructions for the second Account Number at this Financial Institution

accessInstructionsstring required

Detailed general access instructions for this Financial Institution

supportsAccountDiscoveryboolean required

Indicates whether the Financial Institution supports automatic discovery of accounts at the Financial Institution.

supportsOAuthboolean required

Indicates whether the Financial Institution supports OAuth authentication.

supportsTestCredentialboolean required

Indicates whether the Financial Institution supports testing access to the Financial Institution with only credential (and not account) data

requiresInSessionActivationboolean required

Indicates whether the Financial Institution whether the Financial Institution may potentially prompt for In-Session Activation Codes during Test Credential or Test Account operations

requiresSQAboolean required

Indicates whether the Financial Institution may require security questions and answer input from the user in order to access the site

requiresSecondPWboolean required

Indicates whether the Financial Institution requires the second PIN term

setupInstructionsstring

The financial institution instructions for setting up accounts at the FI for aggregation

knownConnectionIssuestring

Known connectivity issue for the FI or third party

configuredOAuthboolean

Indicates whether the OAuth Credential has been configured for the Financial Institution.

logostring

The name used for logo at the respective Financial Institution

iconstring

The name used for icon at the respective Financial Institution

knownConnectionIssueLongTermstring

Known connectivity issue long term for the FI or third party

licensedboolean

Indicates whether the Financial Institution is licensed for the user's firm.

Example response

{
  "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