Get Certified Institutions

GET /institution/v2/certifiedInstitutions?search=&start=[index]&limit=[count]&type=[product type ie voa]

Search all certified institutions. Used primarily for VOA, VOI, and ACH

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 * to return all supported institutions.
start query Starting index for this page of results (ignored if returning all institutions). This will default to 1.
limit query Maximum number of entries for this page of results (ignored if returning all institutions). This will default to 25.
type query Allowed types: voa, voi, state_agg, ach, aha

Success: HTTP 200 (OK)

Example Requests:

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

Using Curl:

curl https://api.finicity.com/institution/v2/certifiedInstitutions?search=new+york&start=1&limit=3&type=voa
-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
requestedDate Date this list was requested
– name The name of the institution
– id Finicity’s institution ID
– trans_agg Boolean value of if this product type is supported or not.
– voa Boolean value of if this product type is supported or not.
– voi Boolean value of if this product type is supported or not.
– state_agg Boolean value of if this product type is supported or not.
– ach Boolean value of if this product type is supported or not.
– aha Boolean value of if this product type is supported or not.

Example Response:

{
    "found": 9042,
    "displaying": 3,
    "moreAvailable": true,
    "requestedDate": 1564775908,
    "institutions": [
        {
            "name": "Chase",
            "id": 5,
            "trans_agg": true,
            "voa": true,
            "voi": true,
            "state_agg": true,
            "ach": true,
            "aha": true
        },
        {
            "name": "Discover Card (All Account Types)",
            "id": 10,
            "trans_agg": true,
            "voa": true,
            "voi": true,
            "state_agg": true,
            "ach": true,
            "aha": false
        },
        {
            "name": "E*TRADE",
            "id": 12,
            "trans_agg": true,
            "voa": true,
            "voi": true,
            "state_agg": true,
            "ach": true,
            "aha": false
        }
    ]
}

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
search query Text to match, or * to return all supported institutions.
start query Starting index for this page of results (ignored if returning all institutions). This will default to 1.
limit query Maximum number of entries for this page of results (ignored if returning all institutions). This will default to 25.
type query Allowed types: voa, voi, state_agg, ach, aha

Success: HTTP 200 (OK)

Example Requests:

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

Using Curl:

curl https://api.finicity.com/institution/v2/certifiedInstitutions?search=new+york&start=1&limit=3&type=voa
-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
requestedDate Date this list was requested
– name The name of the institution
– id Finicity’s institution ID
– trans_agg Boolean value of if this product type is supported or not.
– voa Boolean value of if this product type is supported or not.
– voi Boolean value of if this product type is supported or not.
– state_agg Boolean value of if this product type is supported or not.
– ach Boolean value of if this product type is supported or not.
– aha Boolean value of if this product type is supported or not.

Example Response:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<root>
    <found>9042</found>
    <displaying>3</displaying>
    <moreAvailable>true</moreAvailable>
    <requestedDate>1564775959</requestedDate>
    <institutions>
        <name>Chase</name>
        <id>5</id>
        <trans_agg>true</trans_agg>
        <voa>true</voa>
        <voi>true</voi>
        <state_agg>true</state_agg>
        <ach>true</ach>
        <aha>true</aha>
    </institutions>
    <institutions>
        <name>Discover Card (All Account Types)</name>
        <id>10</id>
        <trans_agg>true</trans_agg>
        <voa>true</voa>
        <voi>true</voi>
        <state_agg>true</state_agg>
        <ach>true</ach>
        <aha>false</aha>
    </institutions>
    <institutions>
        <name>E*TRADE</name>
        <id>12</id>
        <trans_agg>true</trans_agg>
        <voa>true</voa>
        <voi>true</voi>
        <state_agg>true</state_agg>
        <ach>true</ach>
        <aha>false</aha>
    </institutions>
</root>