Get Institutions

GET /institution/v2/institutions?search=&start=[index]&limit=[count]

Use this call to search all Financial Institutions (FI) the Finicity has connections with and supports.

Return all financial institutions that contain the search text in the institution’s name, urlHomeApp, or urlLogonApp fields.

To get a list of all FI’s, leave the search parameter out of the call.  If the search query is left blank, the API will return an error.

If the value of moreAvailable in the response is true, you can retrieve the next page of results by increasing the value of the start parameter in your next request:

  …&start=6&limit=5

JSON Implementation

Request Details:

Parameter Type Description
Finicity-App-Key HTTP Header Finicity-App-Key from Developer Portal
Finicity-App-Token HTTP Header Token returned from Partner Authentication
Accept HTTP Header application/json
search query Text to match, or omit the search parameter.  Must be URL-encoded (see Handling Spaces in Queries)
start query Starting index for this page of results. This defaults to 1.
limit query Maximum number of entries for this page of results. This defaults to 25.

Success: HTTP 200 (OK)

Example Requests:

GET https://api.finicity.com/institutions/v2/institutions
GET https://api.finicity.com/institutions/v2/institutions?search=new+york&start=1&limit=3

Using Curl:

curl https://api.finicity.com/institutions/v2/institutions?search=new+york&start=1&limit=3
-v
-X GET
-H "Finicity-App-Key:APP_KEY"
-H "Finicity-App-Token:ACCESS_TOKEN"
-H "Accept:application/json"

Response Details:

Field Name Description
found Total number of records matching search criteria
displaying Number of records in this response
moreAvailable True if this response does not contain the last record in the result set
createdDate Date this list was generated
institutions Parent element for the institution information
– id The institution ID
– name The name of the institution
accountTypeDescription One of the values Banking, Investments, Credit Cards/Accounts, Workplace Retirement, Mortgages and Loans, Insurance
– urlHomeApp The URL of the institution’s primary home page
– urlLogonApp The URL of the institution’s login page
– oauthEnabled Indicates if the Financial Institution uses OAuth for authentication
– phone The institution’s primary phone number
– currency The institution’s primary currency
– email The institution’s primary contact email
– specialText Any special text found on the institution’s website
– address Parent element for the address of the institution’s headquarters
        – addressLine1, 2 Address information for the institution’s headquarters
        – city The city of the institution’s headquarters
        – state Two-letter code for the state of the institution’s headquarters
        – postalCode The institution ID
        – country The country of the institution’s headquarters

Example Response:

{
  "found": 28,
  "displaying": 3,
  "moreAvailable": true,
  "createdDate": 1470966593,
  "institutions": [
  {
    "id": 101065,
    "name": "New York College Savings Program 529",
    "accountTypeDescription": "Banking",
    "urlHomeApp": "http://www.ny529advisor.com/""",
    "urlLogonApp": "https://ny529advisor.org/nyatpl/auth/loginFormAction.do""",
    "urlProductApp": "",
    "specialText": "Please enter your New York College Savings Program User name and Password.",
    "address": {
      "addressLine1": "P.O. Box 55498",
      "addressLine2": "Boston, MA 02205",
      "city": "Boston",
      "state": "MA",
      "postalCode": "02205",
      "country": "USA"
    },
    "phone": "1-800-774-2108",
    "email": "ny.529advisor@jpmorgan.com",
    "currency": "USD"
  },
  {
    "id": 8584,
    "name": "New York Community Bank Credit Card",
    "accountTypeDescription": "Credit Cards/Accounts",
    "urlHomeApp": "http://www.qcsb.com/index.asp?divID=1""",
    "urlLogonApp": "https://global1.onlinebank.com/cgi-forte/forteisapi.dll?BankTag=1382nycb&ServiceName=WebTeller&TemplateName=Login.htm""",
    "urlProductApp": "",
    "specialText": "Please enter your New York Community Bank Credit Card User ID and Password required for login",
    "address": {
      "addressLine1": "1125 Atlantic Avenue",
      "addressLine2": "",
      "city": "Atlantic City",
      "state": "NJ",
      "postalCode": "08401",
      "country": "USA"
    },
    "phone": "1-609-348-1183",
    "email": "http://www.qcsb.com/southjersey/welcome.shtml""",
    "currency": "USD"
  },
  {
    "id": 1668,
    "name": "New York Giants MBNA CC",
    "accountTypeDescription": "Credit Cards/Accounts",
    "urlHomeApp": "https://www.bankofamerica.com/""",
    "urlLogonApp": "https://secure.bankofamerica.com/login/sign-in/signOnV2Screen.go""",
    "urlProductApp": "",
    "specialText": "Please enter your MBNA Credit Card Online ID and Online Passcode required for login. ",
    "address": {
      "addressLine1": "",
      "addressLine2": "",
      "city": "Wilmington",
      "state": "DE",
      "postalCode": "19884",
      "country": "USA"
    },
    "phone": "1-800-653-2465",
    "email": "",
    "currency": "USD"
  }
  ]
}

XML Implementation

Request Details:

Parameter Type Description
Finicity-App-Key HTTP Header Finicity-App-Key from Developer Portal
Finicity-App-Token HTTP Header Token returned from Partner Authentication
Accept HTTP Header application/json
search query Text to match, or omit the search parameter.  Must be URL-encoded (see Handling Spaces in Queries)
start query Starting index for this page of results. This defaults to 1.
limit query Maximum number of entries for this page of results. This defaults to 25.

Success: HTTP 200 (OK)

Example Request:

GET https://api.finicity.com/institutions/v2/institutions

GET https://api.finicity.com/institutions/v2/institutions?search=new+york&start=1&limit=3

Using Curl:

curl https://api.finicity.com/institutions/v2/institutions?search=new+york&start=1&limit=3
-v
-X GET
-H "Finicity-App-Key:APP_KEY"
-H "Finicity-App-Token:ACCESS_TOKEN"
-H "Accept:application/xml"

Response Details:

Field Name Description
found Total number of records matching search criteria
displaying Number of records in this response
moreAvailable True if this response does not contain the last record in the result set
createdDate Date this list was generated
institutions Parent element for the institution information
– id The institution ID
– name The name of the institution
accountTypeDescription One of the values Banking, Investments, Credit Cards/Accounts, Workplace Retirement, Mortgages and Loans, Insurance
– urlHomeApp The URL of the institution’s primary home page
– urlLogonApp The URL of the institution’s login page
– oauthEnabled Indicates if the Financial Institution uses OAuth for authentication
– phone The institution’s primary phone number
– currency The institution’s primary currency
– email The institution’s primary contact email
– specialText Any special text found on the institution’s website
– address Parent element for the address of the institution’s headquarters
        – addressLine1, 2 Address information for the institution’s headquarters
        – city The city of the institution’s headquarters
        – state Two-letter code for the state of the institution’s headquarters
        – postalCode The institution ID
        – country The country of the institution’s headquarters

Example Response: 

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<root>
    <found>12</found>
    <displaying>3</displaying>
    <moreAvailable>true</moreAvailable>
    <createdDate>1564774911</createdDate>
    <institutions>
        <id>1176</id>
        <name>First New York FCU</name>
        <accountTypeDescription>Banking</accountTypeDescription>
        <phone>518-435-0051</phone>
        <urlHomeApp>http://www.firstnewyork.org/</urlHomeApp>;
        <urlLogonApp>https://www.firstnewyork.org/tob/live/usp-core/app/login/consumer</urlLogonApp>;
        <oauthEnabled>false</oauthEnabled>
        <urlForgotPassword></urlForgotPassword>
        <urlOnlineRegistration></urlOnlineRegistration>
        <class>banking</class>
        <specialText>Please enter your First New York FCU Member Number and Password  required for login.</specialText>
        <address>
            <city>Albany</city>
            <state>NY</state>
            <country>USA</country>
            <postalCode>12206</postalCode>
            <addressLine1>818 Central Avenue</addressLine1>
            <addressLine2></addressLine2>
        </address>
        <currency>USD</currency>
        <email>member.services@firstnewyork.org</email>
    </institutions>
    <institutions>
        <id>7994</id>
        <name>New York and Company Credit Card</name>
        <accountTypeDescription>Credit Cards/Accounts</accountTypeDescription>
        <phone>1-800-889-0494</phone>
        <urlHomeApp>https://c.comenity.net/newyorkandcompany/</urlHomeApp>;
        <urlLogonApp>https://c.comenity.net/newyorkandcompany/</urlLogonApp>;
        <oauthEnabled>false</oauthEnabled>
        <urlForgotPassword></urlForgotPassword>
        <urlOnlineRegistration></urlOnlineRegistration>
        <class>creditCards</class>
        <specialText>Please enter your New York and Company Credit Card Username and Password required for login.</specialText>
        <address>
            <city>San Antonio</city>
            <state>TX</state>
            <country>USA</country>
            <postalCode>78265-9728</postalCode>
            <addressLine1>PO Box 659728</addressLine1>
            <addressLine2></addressLine2>
        </address>
        <currency>USD</currency>
        <email></email>
    </institutions>
    <institutions>
        <id>8584</id>
        <name>New York Community Bank</name>
        <accountTypeDescription>Credit Cards/Accounts</accountTypeDescription>
        <phone>1-609-348-1183</phone>
        <urlHomeApp>https://www.mynycb.com/Pages/home.aspx</urlHomeApp>;
        <urlLogonApp>https://www.mynycb.com/Pages/home.aspx</urlLogonApp>;
        <oauthEnabled>false</oauthEnabled>
        <urlForgotPassword></urlForgotPassword>
        <urlOnlineRegistration></urlOnlineRegistration>
        <class>creditCards</class>
        <specialText>Please enter your New York Community Bank User ID and Password required for login</specialText>
        <address>
            <city>Atlantic City</city>
            <state>NJ</state>
            <country>USA</country>
            <postalCode>08401</postalCode>
            <addressLine1>1125 Atlantic Avenue</addressLine1>
            <addressLine2></addressLine2>
        </address>
        <currency>USD</currency>
        <email>http://www.qcsb.com/southjersey/welcome.shtml</email>;
    </institutions>
</root>