Provider Resource - v1.0

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 logo in the 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. GET providers/{providerId}
GET providers
containerNames string The containerNames attribute name is a dynamic value that is rendered depending on the containers supported for the site and enabled for the customer. GET providers/{providerId}
GET providers
mfaType string Determines the type of multifactor authentication required to log in to the provider site.
Note: This attribute is applicable only for MFA based providers.
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 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}
oAuthSite  string/ boolean Determines if the provider supports OAuth based aggregation. Such sites can only be refreshed with permissions and tokens provided by the provider. GET providers/{providerId}
GET providers
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 enabled in the provider site. GET providers/{providerId}
GET providers
languageISOCode  string The language in which the provider details are provided. Example, 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 Indicates that the provider site is owned by the customer who has invoked the get provider service. GET providers/{providerId}
GET providers
numberOfTransactionDays  integer Indicates the total number of days for which transactions can be fetched from a particular provider site. GET providers/{providerId}
GET providers
containerAttributes entity Attributes that are supported for a site at container level. E.g. Card container supporting 90 days of transaction and bank container supporting 180 days of transactions in a provider site.  GET providers/{providerId}
GET providers
capability entity[] The capabilities that are offered for a provider site. GET providers/{providerId}
GET providers
additionalDataSet entity[] Availability of additional data attributes like routing number, full account number, etc, in provider site apart from basic information like accounts, transaction, etc. GET providers/{providerId}
GET providers
isAddedByUser boolean Indicates that the site has been added by the user atleast once. GET providers/{providerId}
GET providers
PRIORITY String Indicates the priority for which the service is invoked. GET providers/{providerId}
GET providers
countryISOCode String Country to which the provider belongs to. GET providers/{providerId}
GET providers
forgetPasswordUrl String The forget password URL of the provider site. GET providers


Entity: capability

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.

 

Attribute Name Type Description Endpoints
name  string The name of the additional dataset supported in the provider site. GET providers/{providerId}
GET providers
attribute entity[] The attributes that belong to the dataset. 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. GET providers/{providerId}
GET providers


Entity: containerAttributes

Attribute Name Type Description Endpoints
containerNames entity The containerName is a dynamic value that is rendered depending on the containers supported for the site. GET providers/{providerId}
GET providers


Entity: containerNames

Attribute Name Type Description Endpoints
numberOfTransactionDays integer The number of days for which the transactions are available in the provider site. 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. GET providerAccounts/{providerAccountId}
GET provider/{providerId}
help  string The help that 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 demanded from the user.This is the title displayed in the provider site.This field is applicable for 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 is applicable for mfa form types only.  GET providerAccounts/{providerAccountId}
mfaTimeout long The time out before which the user is expected to provide mfa information. This field is applicable for mfa form types only. This would be an useful information that could be displayed to the users.  GET providerAccounts/{providerAccountId}


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 the fields that are related.  GET providerAccounts/{providerAccountId}
GET providers/{providerId}
label string The label text 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. 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 string 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 send 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. 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 an optional field or a mandatory field. GET providerAccounts/{providerAccountId}
GET providers/{providerId}
type string This indicates the display type of the field. E.g. text box, image, etc. 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 has to be displayed before the field value. GET providerAccounts/{providerAccountId}
GET providers/{providerId}
suffix string The suffix string that has to be displayed next to the field value. GET providerAccounts/{providerAccountId}
GET providers/{providerId}
validation entity [] The validation to be performed on a field. 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

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


Enums: Provider Status

Status Description
Supported Indicates that the provider site is enabled for the customer.
Beta Indicates that the provider site is in the beta state.


Enums: Login Form Types

Form Type Description
login  The primary login form displayed in the provider site.
questionAndAnswer The form requesting answers for the secret questions from the user during login.
token The form requesting additional token information from the user during login.
image The loginform that displays CAPTCHA for an user to enter the text during login.


Enums: Provider Authentication Type

AuthType 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: Provider MFA Type

MFA Type Description
Image based multifactor authentication Image based authentication e.g. CAPTCHA.
Multiple levels of strong authentication Combination of token, image or security question & answers.
Question and answer type multi factor authentication Security question and answer based authentication.
Token Id based multi factor authentication OTP or device generating token for authentication.


Enums: Additional Dataset Attributes

Name Description
FULL_ACCT_NUMBER Indicates that the site supports retrieving full account number.
BANK_TRANSFER_CODE Indicates that the site supports retrieving routing number.
HOLDER_NAME Indicates that the site supports retrieving holder name.


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
bill both


Enums: Field Type

Type Description
text Field to be displayed as text box and the value has to be accepted in a clear text when the user enters the value.
password Field to be displayed as text box and the value has to be accepted in a masked form when the user enters the value.
option Field values to be displayed in a drop down.
checkbox Field values to be displayed as check boxes.
radio Field values to be displayed as radio buttons.
image Field values to be displayed as 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.