Provider Accounts Resource

Entity: providerAccount

Attribute Name	Type	Description	Endpoints
id	long	Unique identifier for the provider account resource. This is created during account addition.	GET providerAccounts POST providerAccounts PUT providerAccounts/{providerAccountId} GET providerAccounts/{providerAccountId} GET dataExtracts/userData
providerId	long	Unique identifier for the provider resource. This denotes the provider for which the provider account id is generated by the user.	GET providerAccounts PUT providerAccounts/{providerAccountId} GET providerAccounts/{providerAccountId} GET dataExtracts/userData
aggregationSource	string	The source through which the providerAccount is added in the system. Valid Values: Provider Account Aggregation Source	GET providerAccounts POST providerAccounts PUT providerAccounts/{providerAccountId} GET providerAccounts/{providerAccountId} GET dataExtracts/userData
isManual	boolean	Indicates whether the account is a manual or aggregated provider account.	GET providerAccounts POST providerAccounts PUT providerAccounts/{providerAccountId} GET providerAccounts/{providerAccountId} GET dataExtracts/userData
createdDate	dateTime	Indicates the date and time when the provider account is created in the system.	GET providerAccounts POST providerAccounts PUT providerAccounts/{providerAccountId} GET providerAccounts/{providerAccountId} GET dataExtracts/userData
loginForm	entity[]	This entity gets returned in the response for only MFA-based provider accounts during the add/update account polling process. This indicates that the MFA information is expected from the user to complete the process. This represents the structure of the MFA form that is displayed to the user on the provider site.	GET providerAccounts POST providerAccounts PUT providerAccounts/{providerAccountId} GET providerAccounts/{providerAccountId}
requestId	string	Unique ID generated to indicate the request.	POST providerAccounts PUT providerAccounts/{providerAccountId} GET providerAccounts/{providerAccountId}
status	string	The status of the last update attempted for the account. Valid Values: Provider Account Status	GET providerAccounts POST providerAccounts PUT providerAccounts/{providerAccountId} GET providerAccounts/{providerAccountId} GET dataExtracts/userData
dataset	entity[]	Logical grouping of dataset attributes into datasets such as Basic Aggregation Data, Account Profile and Document.	GET providerAccounts POST providerAccounts PUT providerAccounts/{providerAccountId} GET providerAccounts/{providerAccountId} GET dataExtracts/userData
profile	entity[]	Available for the PII related data like address, name, phoneNumber, identifier, and email.	GET providerAccounts/profile
preferences	entity	The preference set for the provider account.	GET providerAccounts?include=preferences GET providerAccounts/{providerAccountId} include=preferences
isDeleted	boolean	Indicates if the provider account is deleted from the system.	GET dataExtracts/userData
consentId	long	A unique identifier of the user's consent to share the account data with an application provider. Additional Details: This field applies only to the Open Banking-supported data providers.	GET providerAccounts GET providerAccounts/{providerAccountId}
oauthMigrationStatus	string	Indicates the migration status of the account from the credential-based provider to the Open Banking provider. Valid Values: Migration Status	GET providerAccounts GET providerAccounts/{providerAccountId} GET dataExtracts/userData PUT providerAccounts/{providerAccountId}
destinationProviderAccountId	long	The provider account ID that is retained after the Open Banking data migration when two or more source provider account IDs are merged into one. Additional Details: This field applies only to the Open Banking feature.	GET dataExtracts/userData
sourceProviderAccountIds	entity	The two or more source provider account IDs that get merged into one provider account ID after the Open Banking data migration. Additional Details: This field applies only to the Open Banking feature.	GET dataExtracts/userData
authType	string	The authentication type is enabled on the provider site. Valid Values: Provider Authentication Type	GET providerAccounts GET providerAccounts/{providerAccountId}
lastUpdated	string	Indicate when the providerAccount was last updated successfully.	GET providerAccounts GET providerAccounts/{providerAccountId}
isRealTimeMFA	boolean	Attribute that specifies if the user has to input (credentials/MFA) for refreshing an account.	GET providerAccounts GET providerAccounts/{providerAccountId}

Entity: dataset

Attribute Name	Type	Description	Endpoints
name	string	The name of the dataset requested from the provider site. Valid Values: Dataset Name	GET providerAccounts POST providerAccounts PUT providerAccounts/{providerAccountId} GET providerAccounts/{providerAccountId} GET dataExtracts/userData
additionalStatus	string	The status of the last update attempted for the dataset. Valid Values: Dataset Additional Statuses	GET providerAccounts POST providerAccounts PUT providerAccounts/{providerAccountId} GET providerAccounts/{providerAccountId} GET dataExtracts/userData
updateEligibility	string	Indicate whether the dataset is eligible for update or not. Valid Values: Update Eligibility Status	GET providerAccounts POST providerAccounts PUT providerAccounts/{providerAccountId} GET providerAccounts/{providerAccountId} GET dataExtracts/userData
lastUpdated	dateTime	Indicates the time when the dataset is last updated successfully for the given provider account	GET providerAccounts POST providerAccounts PUT providerAccounts/{providerAccountId} GET providerAccounts/{providerAccountId} GET dataExtracts/userData
lastUpdateAttempt	dateTime	Indicates the time when the dataset is last attempted for the given provider account.	GET providerAccounts POST providerAccounts PUT providerAccounts/{providerAccountId} GET providerAccounts/{providerAccountId} GET dataExtracts/userData
nextUpdateScheduled	dateTime	Indicates when the next attempt to update the dataset is scheduled.	GET providerAccounts POST providerAccounts PUT providerAccounts/{providerAccountId} GET providerAccounts/{providerAccountId} GET dataExtracts/userData
additionalStatusErrorCode	string	The status error code of the last update attempted for the dataset.	GET providerAccounts POST providerAccounts PUT providerAccounts/{providerAccountId} GET providerAccounts/{providerAccountId} GET dataExtracts/userData

Entity: profile

Attribute Name	Type	Description	Endpoints
address	address[]	Address of the provider account holder. This will be the address available on the provider's profile page.	GET providerAccounts/profile
name	name[]	Name of the provider account holder.	GET providerAccounts/profile
phoneNumber	phoneNumber[]	phone number of the provider account holder.	GET providerAccounts/profile
identifier	identifier[]	Identifiers of the provider account holder.	GET providerAccounts/profile
email	email[]	Email Id of the provider account holder.	GET providerAccounts/profile
gender	string	Gender of the provider account holder.	GET providerAccounts/profile

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 Value: Login Form Types	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. It will have one label, and 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 is applicable 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 is applicable 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 is applicable to MFA form types only. This would be useful information that could be displayed to the users.	GET providerAccounts/{providerAccountId}
isValueProvided	boolean	This indicates that the answer to the security question already exists in the Yodlee system. Persuading the user to provide the answer to the security question again during the edit-credential flow can be avoided.	GET providerAccounts?include=questions GET providerAccounts/{providerAccountId}? include=questions

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. 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	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 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. Additional Details: The validation entity is deprecated due to the low data population rate.	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: 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: preferences

Attribute Name	Type	Description	Endpoints
isDataExtractsEnabled	boolean	Indicates if the updates to the provider account should be part of the data extracts event notification or the data extract data retrieval service.	GET providerAccounts?include=preferences GET providerAccounts/{providerAccountId}? include=preferences
isAutoRefreshEnabled	boolean	Indicates if auto-refreshes have to be triggered for the provider account.	GET providerAccounts?include=preferences GET providerAccounts/{providerAccountId}? include=preferences
linkedProviderAccountId	long	The open banking providerAccount with which the user’s credential-based providerAccount is linked. Additional Details: This field is relevant to the Open Banking supported data providers.	GET providerAccounts GET providerAccounts/{providerAccountId}

Enums: Provider Account Status

Status	Description
LOGIN_IN_PROGRESS	Log in to the provider site is in progress.
USER_INPUT_REQUIRED	Additional authentication information is needed from the user.
IN_PROGRESS	Login is successful, and data aggregation is in progress.
PARTIAL_SUCCESS	Data is partially retrieved.
SUCCESS	Data is retrieved successfully.
FAILED	Data retrieval has failed.

Enums: Provider Account Aggregation Source

Aggregation Source	Description
SYSTEM	The system creates the provider account while prepopulating accounts.
USER	The provider account is created by the user.

Enums: Dataset Name

Name	Description
BASIC_AGG_DATA	Indicates basic aggregation data like accounts, transactions, etc.
ADVANCE_AGG_DATA	Indicates advanced aggregation data like interest details, payment details, and coverage.
ACCT_PROFILE	Indicates account profile data like full account number, routing number, etc.
DOCUMENT	Indicates document data like bank statements, tax documents, etc.

Enums: Update Eligibility Status

Status	Description
ALLOW_UPDATE	The status indicates that the account is eligible for the next update and applies to both MFA and non-MFA accounts. For MFA-based accounts, the user may have to provide the MFA details during account refresh.
ALLOW_UPDATE_WITH_CREDENTIALS	The status indicates updating or refreshing the account by directing the user to edit the provided credentials.
DISALLOW_UPDATE	The status indicates the account is not eligible for the update or refresh process due to a site issue or a technical error.

Enums: Dataset Additional Statuses

Status	Description	Next Action
LOGIN_IN_PROGRESS	Login to provider site is in progress	Not applicable as it is not a final status.
DATA_RETRIEVAL_IN_PROGRESS	Data aggregation is in progress.	Not applicable as it is not a final status.
ACCT_SUMMARY_RECEIVED	Basic account data is retrieved.	Not applicable as it is not a final status.
AVAILABLE_DATA_RETRIEVED	All the data available at the provider site is retrieved for the provided dataset.	Not applicable.
PARTIAL_DATA_RETRIEVED	Partial data is retrieved for the dataset.	Instruct the user to try again if the mandatory data is missing. If the request fails repeatedly, report the issue to the customer service team.
DATA_RETRIEVAL_FAILED	Failed to retrieve the data due to unexpected issues.	Instruct the user to try again later. If the request fails repeatedly, report the issue to the customer service team.
DATA_NOT_AVAILABLE	The requested data or document is not available at the provider site.	Instruct the user to check with the respective data provider or provider site.
ACCOUNT_LOCKED	The account is locked at the provider site. The user has exceeded the maximum number of incorrect login attempts resulting in the account getting locked.	Instruct the user to visit the provider site and take the necessary actions to unlock the account.
ADDL_AUTHENTICATION_REQUIRED	Additional MFA information is needed at the provider site or to download the document. Additional verification is required.	Instruct the user to provide the required additional MFA information or verification.
BETA_SITE_DEV_IN_PROGRESS	The site for which the data is requested is in the development or beta stage.	Instruct the user to try again later or disable the beta sites.
CREDENTIALS_UPDATE_NEEDED	Unable to log in to the provider site due to outdated credentials. The site may be prompting the user to change or verify the credentials.	Instruct the user to visit the provider site, perform the required actions, and invoke the edit account flow to update the credentials in the Yodlee system.
INCORRECT_CREDENTIALS	Unable to log in to the provider site due to incorrect credentials. The credentials that the user has provided are incorrect.	Instruct the user to provide the correct credentials by invoking the edit account flow.
PROPERTY_VALUE_NOT_AVAILABLE	The property value is not available.	Instruct the user to provide the property value.
INVALID_ADDL_INFO_PROVIDED	The user has provided incorrect MFA information, or the MFA information provided has expired.	Instruct the user to provide the correct MFA information.
REQUEST_TIME_OUT	The request has timed out due to technical reasons.	Instruct the user to try again later. If the request fails repeatedly, report the issue to the customer service team.
SITE_BLOCKING_ERROR	The Yodlee IP is blocked by the provider site.	Instruct the user to try again later. If the request fails repeatedly, report the issue to the customer service team.
UNEXPECTED_SITE_ERROR	All errors indicating issues at the provider site, such as the site being down for maintenance.	Instruct the user to try again later. If the request fails repeatedly, report the issue to the customer service team.
SITE_NOT_SUPPORTED	Indicates that the site does not support the requested data or support is not available to complete the requested action. For example, the site is not available. Document download is not supported at the site, etc.	Inform the user about the latest available status.
SITE_UNAVAILABLE	The provider site is unavailable due to issues such as the site being down for maintenance.	Instruct the user to try again later. If the request fails repeatedly, report the issue to the customer service team.
TECH_ERROR	It indicates there is a technical error.	Instruct the user to try again later. If the request fails repeatedly, report the issue to the customer service team.
USER_ACTION_NEEDED_AT_SITE	The errors that require users to take action at the provider site, for example, accept T&C, etc.	Instruct the user to visit the provider site and perform the necessary action.
SITE_SESSION_INVALIDATED	Indicates if multiple sessions or a session is terminated by the provider site.	Instruct the user to try again later.
NEW_AUTHENTICATION_REQUIRED	The site has requested OAuth authentication.	The OAUTH based authentication sites can be added or updated only using Yodlee FastLink and not Yodlee APIs. Instruct the user to add the account using FastLink.
DATASET_NOT_SUPPORTED	The requested datasets are not supported.	Either get the dataset/attribute enabled or remove the dataset/attribute from the input.
ENROLLMENT_REQUIRED_FOR_DATASET	The dataset cannot be retrieved as the user has not enrolled for it.	Instruct the user to enroll for the dataset and then request for it.
CONSENT_REQUIRED	Consent is required as the account information is migrated from the credential-based provider to the Open Banking provider site.	Invoke the edit account flow and instruct the user to provide consent to access the account information.
CONSENT_EXPIRED	The consent provided by the user to access the account information through Open Banking has expired.	Invoke the edit account flow and instruct the user to provide consent to access the account information.
CONSENT_REVOKED	The user has revoked the consent to access the account information through Open Banking.	Invoke the edit account flow and instruct the user to provide consent to access the account information.
INCORRECT_OAUTH_TOKEN	Failed to log in to the Open Banking provider site due to incorrect token.	Invoke the edit account flow and instruct the user to provide consent to access the account information.
MIGRATION_IN_PROGRESS	The account information is being migrated from the credential-based provider to the Open Banking provider site.	Not applicable, as it is not a final status.

Enums: Field Types

Type	Description
text	The field values can be accepted in clear text when the user enters the values.
password	The field values should be accepted in a masked form when the user enters the values.
options	The field values should be displayed in a dropdown.
checkbox	The field values should be displayed in a checkbox.
radio	The field values should be displayed as radio options.
image	The field values should be displayed as an image

Enums: Login Form Types

Form Type	Description
login	The primary login form is displayed on 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 displays CAPTCHA for a user to enter the text during login.

Enums: Migration Status

Migration Status	Description
TO_BE_MIGRATED	Eligible and yet to be migrated to the Open Banking provider.
IN_PROGRESS	Migration to the Open Banking provider is in progress.
COMPLETED	Successfully migrated to the Open Banking provider.
MIGRATED	Indicates that the data is migrated to the Open Banking provider. Note: This status is returned only by the GET /dataExtracts/userData API.

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 user ID, password, customer ID, etc.
MFA_CREDENTIALS	Multifactor authentication is implemented in the provider site.