Get Institution

GET /institution/v2/institutions/{institutionId}

Get details for the specified institution

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
institutionId path Finicity’s ID of the institution to retrieve

Success: HTTP 200 (OK)

Example Request:

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

Using Curl:

curl
"https://api.finicity.com/institution/v2/institutions/11863"""
-v
-X GET
-H "Finicity-App-Key:APP_KEY"
-H "Finicity-App-Token:ACCESS_TOKEN"
-H "Accept:application/json"

Response Details

Field Name Description
id Finicity’s 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
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 The postal code of the institution’s headquarters
– postalCode The postal code of the institution’s headquarters
– country The country of the institution’s headquarters

Example Response:

{
  "id": 11863,
  "name": "Clearfield Bank & Trust Co",
  "accountTypeDescription": "Banking",
  "urlHomeApp": "https://www.clearfieldbankandtrust.com/""",
  "urlLogonApp": "https://www.netteller.com/clearfieldbankandtrust/login.cfm""",
  "urlProductApp": "",
  "specialText": "Please enter your Clearfield Bank & Trust Co ONLINE24 Internet Banking ID and ONLINE24 Internet Banking Password required for login.",
  "address": {
    "addressLine1": "11 N. Second Street",
    "addressLine2": "PO Box 171",
    "city": "Clearfield",
    "state": "PA",
    "postalCode": "16830",
    "country": "USA"
  },
  "email": "support@cbtfinancial.com",
  "phone": "814-765-7551",
  "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/xml
institutionId path Finicity’s ID of the institution to retrieve

Success: HTTP 200 (OK)

Example Request:

https://api.finicity.com/institution/v2/institutions/11863

Using Curl:

curl
"https://api.finicity.com/institution/v2/institutions/11863"""
-v
-X GET
-H "Finicity-App-Key:APP_KEY"
-H "Finicity-App-Token:ACCESS_TOKEN"
-H "Accept:application/xml"

Response Details

Field Name Description
id Finicity’s 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
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 The postal code of the institution’s headquarters
– postalCode The postal code of the institution’s headquarters
– country The country of the institution’s headquarters

Example Response:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<root>
    <institution>
        <id>101732</id>
        <name>FinBank</name>
        <accountTypeDescription>TestFI</accountTypeDescription>
        <phone></phone>
        <urlHomeApp>https://finbank.prod.fini.city/CCBankImageMFA/login.jsp</urlHomeApp>;
        <urlLogonApp>https://finbank.prod.fini.city/CCBankImageMFA/login.jsp</urlLogonApp>;
        <oauthEnabled>false</oauthEnabled>
        <urlForgotPassword>https://developer.finicity.com/admin/account/password/new</urlForgotPassword>;
        <urlOnlineRegistration>https://www.finicity.com/signup/</urlOnlineRegistration>;
        <class>testfi</class>
        <specialText>Please enter your FinBank Username and Password required for login.</specialText>
        <address>
            <city>Utah</city>
            <state></state>
            <country>USA</country>
            <postalCode></postalCode>
            <addressLine1></addressLine1>
            <addressLine2></addressLine2>
        </address>
        <currency>USD</currency>
        <email>finbank.ds5@finicity.com</email>
        <branding/>
    </institution>
</root>