Provider Resource

Entity: provider

Attribute Name	Type	Description	Endpoints
id	long	Unique identifier for the provider site. (e.g., FI sites, biller sites, lender sites, etc.).	GET providers/{providerId} GET providers
name	string	The name of a provider site.	GET providers/{providerId} GET providers
loginURL	string	The login URL of the provider's site.	GET providers/{providerId} GET providers
baseURL	string	The base URL of the provider's site.	GET providers/{providerId} GET providers
favicon	string	Favicon link of the provider.	GET providers/{providerId} GET providers
logo	string	The logo link of the provider institution. The link will return the logo in SVG format. If SVG format is not available, the logo is returned in PNG format.	GET providers/{providerId} GET providers
status	string	Determines if the provider is supported for the cobrand, provide site is in the beta stage, etc. Valid Values: Provider Status	GET providers/{providerId} GET providers
help	string	Help text to guide the user to choose the correct provider site.	GET providers/{providerId} GET providers
loginForm	entity[]	This entity represents the structure of a login or MFA form that is displayed to the user in the provider site. For performance reasons, this field is returned only when a single provider is requested in the request.	GET providers/{providerId}
lastModified	dateTime	Determines when the provider information was updated by Yodlee. If the customer caches the data, the cache is recommended to be refreshed based on this field.	GET providers/{providerId} GET providers
loginHelp	string	Help content to guide the user during the account addition process.	GET providers/{providerId} GET providers
primaryLanguageISOCode	string	The primary language of the site.	GET providers/{providerId} GET providers
authType	string	The authentication type is enabled on the provider site. Valid Values: Provider Authentication Type	GET providers/{providerId} GET providers
languageISOCode	string	The language in which the provider details are provided. For example, the Site supports two languages, English and French. English being the primary language, the provider response will be provided in French depending on the user locale. The language follows the two-letter ISO code.	GET providers/{providerId} GET providers
isAutoRefreshEnabled	boolean	Indicates if a provider site is auto-refreshed.	GET providers/{providerId} GET providers
isProviderOwned	boolean	The provider site is owned by the customer who has invoked the get provider service.	GET providers/{providerId} GET providers
capability	entity[]	The capabilities that are offered for a provider site. Additional Details: The capability entity is deprecated.	GET providers/{providerId} GET providers
isAddedByUser	string	The site has been added by the user at least once. This attribute appears in the response only for SEARCH and POPULAR priority. The valid values are true and false.	GET providers/{providerId} GET providers
Priority	string	Indicates the priority for which the service is invoked. Valid Values: Provider Priority	GET providers/{providerId} GET providers
countryISOCode	string	The country to which the provider belongs. Additional Details: This field does not apply to a globally available site, i.e., users from all locales can search the site.	GET providers/{providerId} GET providers
dataset	entity[]	Logical grouping of dataset attributes into datasets such as Basic Aggregation Data, Account Profile, and Document.	GET providers/{providerId} GET providers
forgetPasswordUrl	string	The forget password URL of the provider site.	GET providers
isConsentRequired	boolean	Indicates if the site requires the user to provide consent to share account data with an application provider. Additional Details: This field is relevant to the Open Banking supported data providers, a feature that is currently available only in the UK region.	GET providers/{providerId} GET providers
authParameter	string[]	The authentication parameters used to authenticate with the site. Additional Details: This field is only applicable to the Open Banking supported data providers, a feature that is currently available only in the UK region.	GET providers/{providerId} GET providers
accountType	string[]	The types of accounts supported by the site. Additional Details: This field is relevant to the Open Banking supported data providers, a feature that is currently available only in the UK region.	GET providers/{providerId} GET providers
associatedProviderIds	string[]	The screen-scraping providers that are associated to with the Open Banking provider ID. Additional Details: The associatedProviderIds field applies only to the Open Banking-supported data providers, i.e. when the financial institutions merge their subsidiaries and provide data as a single Open Banking provider.	GET providers/{providerId} GET providers
uptimeMetrics	entity	The site failure status/message and the threshold percentage.	GET providers/{providerId} GET providers
isTanSupported	boolean	Indicates if a site supports TAN (Tokenized Account Number).	GET providers/{providerId} GET providers

Entity: loginForm

Attribute Name	Type	Description	Endpoints
id	long	The identifier of the login form.	GET providerAccounts/{providerAccountId} GET provider/{ProviderId}
forgetPasswordURL	string	The forget password URL of the provider site.	GET providerAccounts/{providerAccountId} GET provider/{ProviderId}
formType	string	The type of the forms on which the user information is required. Valid Values: Login Form Types	GET providerAccounts/{providerAccountId} GET provider/{ProviderId}
help	string	The help can be displayed to the customer in the login form.	GET providerAccounts/{providerAccountId} GET provider/{ProviderId}
row	entity[]	This indicates one row in the form. The row will have one label. But it may have single or multiple fields.	GET providerAccounts/{providerAccountId} GET provider/{ProviderId}
mfaInfoTitle	string	The title for the MFA information is demanded from the user. This is the title displayed on the provider site. This field applies to MFA form types only.	GET providerAccounts/{providerAccountId}
mfaInfoText	string	The text displayed in the provider site while requesting the MFA information from the user. This field applies to MFA form types only.	GET providerAccounts/{providerAccountId}
mfaTimeout	long	The time out before which the user is expected to provide MFA information. This field applies to MFA form types only. This would be useful information that could be displayed to the users.	GET providerAccounts/{providerAccountId}

Entity: dataset

Attribute Name	Type	Description	Endpoints
name	string	The name of the dataset supported by the provider. Valid Values: Dataset Name	GET providers/{providerId} GET providers
attribute	entity[]	The name of the dataset attribute supported by the provider.	GET providers/{providerId} GET providers

Entity: capability (Deprecated)

Attribute Name	Type	Description	Endpoints
name	string	The name of the capability supported through the provider site.	GET providers/{providerId} GET providers
container	string[]	The containers that are supported for the capability.	GET providers/{providerId} GET providers

Entity: attribute

Attribute Name	Type	Description	Endpoints
name	string	Attributes that are supported for a dataset.	GET providers/{providerId} GET providers
container	string[]	Containers for which the attributes are supported. Valid Values: Container	GET providers/{providerId} GET providers
containerAttributes	entity[]	Includes the container attributes supported for individual containers.	GET providers/{providerId} GET providers

Entity: containerAttributes

Attribute Name	Type	Description	Endpoints
INSURANCE	entity[]	Contains the properties related to `INSURANCE` container.	GET providers/{providerId} GET providers
BANK	entity[]	Contains the properties related to `BANK` container.	GET providers/{providerId} GET providers
LOAN	entity[]	Contains the properties related to `LOAN` container.	GET providers/{providerId} GET providers
INVESTMENT	entity[]	Contains the properties related to `INVESTMENT` container.	GET providers/{providerId} GET providers
CREDITCARD	entity[]	Contains the properties related to `CREDITCARD` container.	GET providers/{providerId} GET providers

Entity: INSURANCE/BANK/LOAN/INVESTMENT/CREDITCARD

Attribute Name	Type	Description	Endpoints
numberOfTransactionDays	integer	The number of transaction days supported for a container.	GET providers/{providerId} GET providers
fullAccountNumberFields	string[]	The full account number fields are supported. Valid Values: Full Account Number Fields	GET providers/{providerId} GET providers

Entity: row

Attribute Name	Type	Description	Endpoints
id	long	Unique identifier of the row.	GET providerAccounts/{providerAccountId} GET providers/{providerId}
form	string	Form denotes the set of fields that are related.	GET providerAccounts/{providerAccountId} GET providers/{providerId}
label	string	The label text is displayed for a row in the form.	GET providerAccounts/{providerAccountId} GET providers/{providerId}
fieldRowChoice	string	Fields that belong to a particular choice are clubbed using this field. Recommendations: All the field row choices label to be grouped and displayed as options to the customer. On choosing a particular choice field, we recommend displaying the fields relevant to them. The first field choice could be selected by default.	GET providerAccounts/{providerAccountId} GET providers/{providerId}
field	entity []	Details of fields that belong to the row.	GET providerAccounts/{providerAccountId} GET providers/{providerId}

Entity: field

Attribute Name	Type	Description	Endpoints
id	long	An identifier for the field.	GET providerAccounts/{providerAccountId} GET providers/{providerId}
name	string	Name for the field.	GET providerAccounts/{providerAccountId} GET providers/{providerId}
value	string	Value expected from the user for the field. This will be blank and is expected to be filled and sent back while submitting the login or MFA information.	GET providerAccounts/{providerAccountId} GET providers/{providerId}
option	entity []	Provides the different values that are available for the user to choose from. This field is applicable for dropdown or radio field types.	GET providerAccounts/{providerAccountId} GET providers/{providerId}
valueEditable	boolean	Indicates whether the field is editable or not.	GET providerAccounts/{providerAccountId} GET providers/{providerId}
isOptional	boolean	Indicates if a field is optional or mandatory.	GET providerAccounts/{providerAccountId} GET providers/{providerId}
type	string	This indicates the display type of the field. E.g., text box, image, etc. Valid Values: Field Types	GET providerAccounts/{providerAccountId} GET providers/{providerId}
maxLength	integer	The maximum length of the login form field.	GET providerAccounts/{providerAccountId} GET providers/{providerId}
prefix	string	The prefix string that must be displayed before the field value.	GET providerAccounts/{providerAccountId} GET providers/{providerId}
suffix	string	The suffix string that must be displayed next to the field value.	GET providerAccounts/{providerAccountId} GET providers/{providerId}
validation	entity []	The validation to be performed on a field. Additional Details: The validation entity is deprecated due to the low data population rate.	GET providerAccounts/{providerAccountId} GET providers/{providerId}

Entity: option

Attribute Name	Type	Description	Endpoints
displayText	string	The text that is displayed to the user for that option in the provider site.	GET providerAccounts/{providerAccountId} GET providers/{providerId}
isSelected	boolean	The option that is selected by default in the provider site.	GET providerAccounts/{providerAccountId} GET providers/{providerId}
optionValue	string	The value that is associated with the option.	GET providerAccounts/{providerAccountId} GET providers/{providerId}

Entity: validation (Deprecated)

Attribute Name	Type	Description	Endpoints
regExp	string	The regular expression provided for a field. This helps customers validate the value entered by the users.	GET providerAccounts/{providerAccountId} GET providers/{providerId}
errorMsg	string	The error message will be thrown if the value does not match the regular expression.	GET providerAccounts/{providerAccountId} GET providers/{providerId}

Entity: uptimeMetrics

Attribute Name	Type	Description	Endpoints
thresholdPercentage	string	The value is calculated based on the number of site failures and the total successful refreshes performed.	GET providers GET providers/{providerId}
status	string	Indicates the alert status for the site. Valid Values: Site Status	GET providers GET providers/{providerId}

Enums: Provider Status

Status	Description
Supported	The provider site is enabled for the customer.
Unsupported	The provider site is not eligible for linking the new providerAccountId. However, the edit and refresh actions are allowed on the existing active providerAccountIds; this usually happens during site mergers. The unsupported provider status is also returned during the US Open Banking migration runway period when the screen-scraping site only allows refreshing accounts but not linking new accounts.
Beta	The provider site is in the beta state.

Enums: Login Form Types

Form Type	Description
login	The primary login form is displayed on the provider site.
questionAndAnswer	The form requests answers for the user's secret questions during login.
token	The form requesting additional token information from the user during login.
image	The loginform displays CAPTCHA for users to enter the text during login.

Enums: Provider Authentication Type

Authentication Type	Description
OAUTH	The site that supports open authentication.
CREDENTIALS	The authentication system of the site expects only credentials like userId, password, customer id, etc.
MFA_CREDENTIALS	Multifactor authentication is implemented in the provider site.

Enums: Container

Container	Applicable for Aggregated/Manual Accounts
bank	both
creditCard	both
investment	both
insurance	both
loan	both
otherAssets	manual
otherLiabilities	manual
realEstate	manual
reward	both

Enums: Field Types

Type	Description
text	Field to be displayed as a text box, and the value has to be accepted in clear text when the user enters the value.
password	Field to be displayed as a text box, and the value has to be accepted in a masked form when the user enters the value.
options	Field values to be displayed in a dropdown.
checkbox	Field values to be displayed as checkboxes.
radio	Field values to be displayed as radio buttons.
image	Field values to be displayed as an image.

Enums: Provider Priority

Priority	Description
POPULAR	Popular providers.
SUGGESTED	Suggested providers for the user.
COBRAND	Yodlee supported providers.
SEARCH	Providers matching the search text.

Enums: Dataset Name

Name	Description
BASIC_AGG_DATA	Indicates basic aggregation data like accounts, transactions, etc.
ACCT_PROFILE	Indicates account profile data like full account number, routing number, etc.
DOCUMENT	Indicates document data like bank statements, tax documents, etc.

Enums: Full Account Number Fields

Field	Description
paymentAccountNumber	The payment account number is used for payments in all regions. This may be looked at as an ACH account number in the US.
unmaskedAccountNumber	The unmasked account number is the same as the account number that is used to refer to an account and is not partial/masked. The unmasked account number may or may not be the same as the one used for payments. In the case of investments, the account number is used in asset transfers.

Enums: Site Status

Status	Description
ACCOUNT_LINKING_UNAVAILABLE	If the `thresholdPercentage` value is >= 100.
REFRESH_FAILURE_ATTENTION	If the `thresholdPercentage` value is >= 90 and < 100.