getInstitutions

GET https://api.finicity.com/financialdatafeed/v1/institutions

This call returns a list of institutions supported for data acquisition.

Please refer to Authentication Header Attributes for request header attributes and the Response Codes for details about possible success/error status codes.

Response Attributes

The following attributes are returned in the response from the service.

Attribute Data Type Description Frequent?
institutionId Long Finicity identifier for a financial institution. Yes
institutionName String Name of the financial institution. Yes
homeUrl String The home URL for the financial institution.  
phoneNumber String Phone number of the financial institution.  
virtual Boolean Ignore (always true)  

Sample Responses

Sample Response JSON body:

{"Institutions": {
    "institution": [
        {
            "institutionId": 100000,
            "institutionName": "CCBank",
            "homeUrl": "http://www.example.com",
            "phoneNumber": "123-456-7890",
            "virtual": false
        },
        {
            "institutionId": 100001,
            "institutionName": "CCBank1",
            "homeUrl": "http://www.example.com",
            "phoneNumber": "123-456-7891",
            "virtual": false
        },
        {
            "institutionId": 100002,
            "institutionName": "CCBank2",
            "homeUrl": "http://www.example.com",
            "phoneNumber": "123-456-7892",
            "virtual": false
        },
        {
            "institutionId": 100003,
            "institutionName": "CCBank3",
            "homeUrl": "http://www.example.com",
            "phoneNumber": "123-456-7890",
            "virtual": false
        },
        {
            "institutionId": 100004,
            "institutionName": "CCBank4",
            "homeUrl": "http://www.example.com",
            "phoneNumber": "123-456-7894",
            "virtual": false
        },
        {
            "institutionId": 100005,
            "institutionName": "CCBank5",
            "homeUrl": "http://www.example.com",
            "phoneNumber": "123-456-7895",
            "virtual": false
        },
        {
            "institutionId": 200001,
            "institutionName": "OFX Automation",
            "virtual": false
        },
        {
            "institutionId": 200002,
            "institutionName": "CCOFXBank",
            "virtual": false
        },
        {
            "institutionId": 200004,
            "institutionName": "CCBank",
            "virtual": false
        },
        {
            "institutionId": 777999,
            "institutionName": "Customer Central OFX Bank",
            "virtual": false
        }
    ]
}}

Sample Response XML body:

<Institutions xmlns="http://schema.intuit.com/platform/fdatafeed/account/v1" 
    xmlns:ns2="http://schema.intuit.com/platform/fdatafeed/v1">
    <institution>
        <institutionId>100000</institutionId>
        <institutionName>CCBank</institutionName>
        <homeUrl>http://www.example.com</homeUrl>
        <phoneNumber>123-456-7890</phoneNumber>
        <virtual>false</virtual>
    </institution>
    <institution>
        <institutionId>100001</institutionId>
        <institutionName>CCBank1</institutionName>
        <homeUrl>http://www.example.com</homeUrl>
        <phoneNumber>123-456-7891</phoneNumber>
        <virtual>false</virtual>
    </institution>
    <institution>
        <institutionId>100002</institutionId>
        <institutionName>CCBank2</institutionName>
        <homeUrl>http://www.example.com</homeUrl>
        <phoneNumber>123-456-7892</phoneNumber>
        <virtual>false</virtual>
    </institution>
    <institution>
        <institutionId>100003</institutionId>
        <institutionName>CCBank3</institutionName>
        <homeUrl>http://www.example.com</homeUrl>
        <phoneNumber>123-456-7890</phoneNumber>
        <virtual>false</virtual>
    </institution>
    <institution>
        <institutionId>100004</institutionId>
        <institutionName>CCBank4</institutionName>
        <homeUrl>http://www.example.com</homeUrl>
        <phoneNumber>123-456-7894</phoneNumber>
        <virtual>false</virtual>
    </institution>
    <institution>
        <institutionId>100005</institutionId>
        <institutionName>CCBank5</institutionName>
        <homeUrl>http://www.example.com</homeUrl>
        <phoneNumber>123-456-7895</phoneNumber>
        <virtual>false</virtual>
    </institution>
    <institution>
        <institutionId>200001</institutionId>
        <institutionName>OFX Automation</institutionName>
        <virtual>false</virtual>
    </institution>
    <institution>
        <institutionId>200002</institutionId>
        <institutionName>CCOFXBank</institutionName>
        <virtual>false</virtual>
    </institution>
    <institution>
        <institutionId>200004</institutionId>
        <institutionName>CCBank</institutionName>
        <virtual>false</virtual>
    </institution>
    <institution>
        <institutionId>777999</institutionId>
        <institutionName>Customer Central OFX Bank</institutionName>
        <virtual>false</virtual>
    </institution>
</Institutions>

Schema Files (TO-DO)

  • Common_1.xsd
  • Institution_1.xsd
Have more questions? Submit a request

Comments

Powered by Zendesk