Get Providers

Endpoint: GET /providers

The get provider service is used to get all the providers that are enabled, search a provider service by name or routing number and get popular sites of a region.Searching for a provider using a routing number is applicable only to the USA and Canada regions.The valid values for priority are:1. cobrand: Returns providers enabled for the cobrand (Default priority)2. popular: Returns providers popular among users of the customerOnly 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_DATABASIC_AGG_DATA OR ACCT_PROFILEBASIC_AGG_DATA [ ACCOUNT_DETAILS OR HOLDINGS ]BASIC_AGG_DATA [ ACCOUNT_DETAILS] OR DOCUMENTBASIC_AGG_DATA [ BASIC_ACCOUNT_INFO OR ACCOUNT_DETAILS ]The fullAcountNumberFields is specified to filter the providers that have paymentAccountNumber or unmaskedAccountNumber support in the FULL_ACCT_NUMBER dataset attribute.Examples for usage of fullAccountNumberFieldsdataset$filter=ACCT_PROFILE[ FULL_ACCT_NUMBER.container [ bank ]] & fullAccountNumberFields=paymentAccountNumberdataset$filter=ACCT_PROFILE[ FULL_ACCT_NUMBER.container [ bank ]] & fullAccountNumberFields=unmaskedAccountNumberdataset$filter=ACCT_PROFILE[ FULL_ACCT_NUMBER.container [ bank ]] & fullAccountNumberFields=unmaskedAccountNumber,paymentAccountNumberThe 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. In a product flow involving user interaction, Yodlee recommends invoking this service with filters.
2. Without filters, the service may perform slowly as it takes a few minutes to return data in the response.
3. The AuthParameter appears in the response only in case of token-based aggregation sites.
4. The pagination feature only applies when the priority parameter is set as cobrand. If no values are provided in the skip and top parameters, the API will only return the first 500 records.
5. This service supports the localization feature and accepts locale as a header parameter.
6. The capability has been deprecated in query parameter and response.

Parameters

For the Request

Example Request

curl -X GET /providers \\
	-H 'Content-Type: application/json' \\
	-H "Authorization: Bearer {access_token}"

Example Response

{
  "provider": [
    {
      "languageISOCode": "string",
      "forgetPasswordUrl": "string",
      "favicon": "string",
      "accountType": [
        "CURRENT"
      ],
      "countryISOCode": "string",
      "isAddedByUser": "string",
      "PRIORITY": "POPULAR",
      "associatedProviderIds": [
        0
      ],
      "loginHelp": "string",
      "primaryLanguageISOCode": "string",
      "help": "string",
      "baseUrl": "string",
      "capability": [
        {
          "container": [
            "bank"
          ],
          "name": "string"
        }
      ],
      "isConsentRequired": true,
      "loginUrl": "string",
      "isAutoRefreshEnabled": true,
      "name": "string",
      "logo": "string",
      "id": 0,
      "lastModified": "string",
      "authParameter": [
        "authorizationCode"
      ],
      "authType": "OAUTH",
      "dataset": [
        {
          "name": "BASIC_AGG_DATA",
          "attribute": [
            {
              "container": [
                "bank"
              ],
              "fromDate": "string",
              "toFinYear": "string",
              "fromFinYear": "string",
              "containerAttributes": {
                "BANK": {
                  "fullAccountNumberFields": [
                    null
                  ],
                  "numberOfTransactionDays": 0
                },
                "LOAN": {
                  "fullAccountNumberFields": [
                    null
                  ],
                  "numberOfTransactionDays": 0
                },
                "CREDITCARD": {
                  "fullAccountNumberFields": [
                    null
                  ],
                  "numberOfTransactionDays": 0
                },
                "INVESTMENT": {
                  "fullAccountNumberFields": [
                    null
                  ],
                  "numberOfTransactionDays": 0
                },
                "INSURANCE": {
                  "fullAccountNumberFields": [
                    null
                  ],
                  "numberOfTransactionDays": 0
                }
              },
              "toDate": "string",
              "name": "BASIC_ACCOUNT_INFO"
            }
          ]
        }
      ],
      "status": "Supported"
    }
  ]
}

Get Providers Count