Skip to content

Latest commit

 

History

History
84 lines (62 loc) · 6.09 KB

InstitutionsApi.md

File metadata and controls

84 lines (62 loc) · 6.09 KB
Raw

yodlee.InstitutionsApi

All URIs are relative to http://localhost

Method HTTP request Description
get_institutions GET /institutions Get institutions

get_institutions

InstitutionResponse get_institutions(datasetfilter=datasetfilter, name=name, priority=priority, provider_id=provider_id, skip=skip, top=top)

Get institutions

Yodlee classifies providers into credential-based aggregation and Open Banking (OB) providers. The get institutions service helps in identifying credential and related OB sites in a financial institution. The service searches for an institution regardless of the authentication types associated with the providers. Using the get institutions service, retrieve institutions enabled for the customer, search an institution by its name or routing number, and retrieve the popular institutions for a region. Searching for an institution using a routing number applies only to the USA and Canada regions.
The valid values for the priority parameter are:
1. all: Returns all the institutions enabled for the customer (the default value for the priority parameter).
2. search: Returns institutions matching the name provided by the user. The name parameter is mandatory if the priority parameter is set as search.
3. popular: Returns institutions that are popular among the customer's users.
Only the datasets, attributes, and containers that are enabled for the customer will be returned in the response.
Input for the dataset$filter should adhere to the following expression:<dataset.name>[<attribute.name>.container[ OR ] OR <attribute.name>.container[]]
OR <dataset.name>[<attribute.name> OR <attribute.name>]
dataset$filter value examples:
ACCT_PROFILE[FULL_ACCT_NUMBER.container[bank OR investment OR creditCard]]
ACCT_PROFILE[FULL_ACCT_NUMBER.container[bank]]
BASIC_AGG_DATA[ACCOUNT_DETAILS.container[bank OR investment] OR HOLDINGS.container[bank]] OR ACCT_PROFILE[FULL_ACCT_NUMBER.container[bank]]
BASIC_AGG_DATA
BASIC_AGG_DATA OR ACCT_PROFILE
BASIC_AGG_DATA [ ACCOUNT_DETAILS OR HOLDINGS ]
BASIC_AGG_DATA [ ACCOUNT_DETAILS] OR DOCUMENT
BASIC_AGG_DATA [ BASIC_ACCOUNT_INFO OR ACCOUNT_DETAILS ]

The skip and top parameters are used for pagination. In the skip and top parameters, pass the number of records to be skipped and retrieved, respectively.
The response header provides the links to retrieve the next and previous set of transactions.

Note:

1. If no value is set for the priority parameter, all the institutions enabled for the customer will be returned.
2. In a product flow involving user interaction, Yodlee recommends invoking this service with filters.
Without filters, the service may perform slowly as it takes a few minutes to return data in the response.
3. The response includes comma separated provider IDs that are associated with the institution.
4. This service supports the localization feature and accepts locale as a header parameter.

Example

from __future__ import print_function
import time
import yodlee
from yodlee.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = yodlee.Configuration(
    host = "http://localhost"
)


# Enter a context with an instance of the API client
with yodlee.ApiClient() as api_client:
    # Create an instance of the API class
    api_instance = yodlee.InstitutionsApi(api_client)
    datasetfilter = 'datasetfilter_example' # str | Expression to filter the providers by dataset(s) or dataset attribute(s). The default value will be the dataset or dataset attributes configured as default for the customer. (optional)
name = 'name_example' # str | Name in minimum 1 character or routing number. (optional)
priority = 'priority_example' # str | Search priority (optional)
provider_id = 56 # int | providerId (optional)
skip = 56 # int | skip (Min 0) - This is not applicable along with 'name' parameter. (optional)
top = 56 # int | top (Max 500) - This is not applicable along with 'name' parameter. (optional)

    try:
        # Get institutions
        api_response = api_instance.get_institutions(datasetfilter=datasetfilter, name=name, priority=priority, provider_id=provider_id, skip=skip, top=top)
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling InstitutionsApi->get_institutions: %s\n" % e)

Parameters

Name Type Description Notes
datasetfilter str Expression to filter the providers by dataset(s) or dataset attribute(s). The default value will be the dataset or dataset attributes configured as default for the customer. [optional]
name str Name in minimum 1 character or routing number. [optional]
priority str Search priority [optional]
provider_id int providerId [optional]
skip int skip (Min 0) - This is not applicable along with 'name' parameter. [optional]
top int top (Max 500) - This is not applicable along with 'name' parameter. [optional]

Return type

InstitutionResponse

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json;charset=UTF-8

HTTP response details

Status code Description Response headers
200 OK -
400 Y800 : Invalid value for priority<br>Y800 : Invalid value for skip<br>Y804 : Permitted values of top between 1 - 500<br>Y821 : Dataset not supported<br> -
401 Unauthorized -
404 Not Found -

[Back to top] [Back to API list] [Back to Model list] [Back to README]