Provider Accounts Resource
This page refers to Yodlee API v1.0. The latest API version's data model documentation is available here.
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} |
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} |
aggregationSource | string | The source through which the providerAccount is added in the system.
Valid Values: Provider Account Agg Source
|
GET providerAccounts POST providerAccounts PUT providerAccounts/{providerAccountId} GET providerAccounts/{providerAccountId} |
refreshInfo | entity | The entity that holds information of the add/update process and its staus initiated on the provider account. | GET providerAccounts POST providerAccounts PUT providerAccounts/{providerAccountId} GET providerAccounts/{providerAccountId} |
isManual | boolean | Indicates whether account is a manual or aggregated provider account. | GET providerAccounts POST providerAccounts PUT providerAccounts/{providerAccountId} GET providerAccounts/{providerAccountId} |
createdDate | date | The date on when the provider account is created in the system. | GET providerAccounts POST providerAccounts PUT providerAccounts/{providerAccountId} GET providerAccounts/{providerAccountId} |
lastUpdated | dateTime | The date on when the provider account is last updated. | GET providerAccounts POST providerAccounts PUT providerAccounts/{providerAccountId} GET providerAccounts/{providerAccountId} |
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 MFA form that is displayed to the user in the provider site. | GET providerAccounts POST providerAccounts PUT providerAccounts/{providerAccountId} GET providerAccounts/{providerAccountId} |
Entity: refreshInfo
Attribute Name | Type | Description | Endpoints |
---|---|---|---|
statusCode | integer | The status code of last update attempted for the account.
Valid Values: Refresh Status Code and Message
|
GET providerAccounts/{providerAccountId} POST providerAccounts PUT providerAccounts/{providerAccountId} |
statusMessage | string | The status message of last update attempted for the account.
Valid Values: Refresh Status Code and Message
|
GET providerAccounts/{providerAccountId} POST providerAccounts PUT providerAccounts/{providerAccountId} |
status | string | The status of last update attempted for the account.
Valid Values: Provider Account Status
|
GET providerAccounts/{providerAccountId} POST providerAccounts PUT providerAccounts/{providerAccountId} |
additionalStatus | string | The additional status information of the last update attempted for the account.
Valid Values: Provider Account Status
|
GET providerAccounts/{providerAccountId} POST providerAccounts PUT providerAccounts/{providerAccountId} |
additionalInfo | string | Information on whether the data retrieval was a partial failure or a complete failure.
Valid Values: Provider Account Status
|
GET providerAccounts/{providerAccountId} |
nextRefreshScheduled | dateTime | Next scheduled time for account update. | GET providerAccounts/{providerAccountId} |
lastRefreshed | dateTime | Time when the account was last updated/created successfully or partially. | GET providerAccounts/{providerAccountId} |
lastRefreshAttempt | dateTime | Time when last action was attempted for the account. | GET providerAccounts/ {providerAccountId} |
actionRequired | string | Information on whether an update credentials action is required for the provider account. “UPDATE_CREDENTIALS” value will be provided in the response, if the provider account needs an action to be taken by the user due to errors. | GET providerAccounts/{providerAccountId} |
message | string | INVOKE_UPDATE_PROVIDER_ACCOUNT_WITH_CREDENTIALS_PARAM will be the value that will be provided in the response to communicate customers that the PUT service to be invoked with credentials when there are credential errors. | GET providerAccounts/{providerAccountId} |
account | entity | Account information that has to be verified. | PUT providerAccounts/verification GET providerAccounts/verification/ {providerAccountId} |
Entity: account
Attribute Name | Type | Description | Endpoints |
---|---|---|---|
id | long | Unique identifier generated by Yodlee for the account that needs to be verified. | PUT providerAccounts/verification GET providerAccounts/verification/{providerAccountId} |
accountNumber | string | Account number provided by the user for verification. | PUT providerAccounts/verification GET providerAccounts/verification/{providerAccountId} |
accountName | string | Name of the account provided by the user for CDV verification. | PUT providerAccounts/verification GET providerAccounts/verification/{providerAccountId} |
accountType | string | Account type provided by the user for verification.
Valid Values: Account Type
|
PUT providerAccounts/verification GET providerAccounts/verification/{providerAccountId} |
bankTransferCode | entity | Bank transfer code of the account provided by the user for CDV verification. | PUT providerAccounts/verification GET providerAccounts/verification/{providerAccountId} |
verification | entity | Verification details of the account. | PUT providerAccounts/verification GET providerAccounts/verification/{providerAccountId} |
Entity: bankTransferCode
Entity: verification
Attribute Name | Type | Description | Endpoints |
---|---|---|---|
type | string | Type of verification to be performed.
Valid Values: Verification Type
|
PUT providerAccounts/verification GET providerAccounts/verification/{providerAccountId} |
status | string | Status of verification.
Valid Values: Verification Status
|
PUT providerAccounts/verification GET providerAccounts/verification/{providerAccountId} |
reason | string | The level of verificaiton state.
Valid Values: Verification Reasons
|
PUT providerAccounts/verification GET providerAccounts/verification/{providerAccountId} |
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 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 | long | 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 | 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. | GET providerAccounts/{providerAccountId} GET providers/{providerId} |
Entity: validation
Entity: option
Enums: Provider Account Status
Enums: Refresh Status Code and Message
Enums: Provider Account Agg Source
AggregationSource | Description |
---|---|
PRE_POPULATED | Indicates that the provider account is created by the system while prepopulating accounts. |
USER | Indicates that the provider account is created by the user. |
Enums: Verification Type
Type | Value |
---|---|
CHALLENGE_DEPOSIT | Veriifcation done by cross checking the transaction amounts posted on the accounts. |
MATCHING | Veriifcation done by matching the attributes of accounts. |
Enums: Verification Status
Status | Description |
---|---|
IN_PROGRESS | Verification in progress for accounts. |
SUCCESS | Accounts were successfully verified. |
FAILED | Account verification failed. |
Enums: Verification Reasons
Reason | Description |
---|---|
INSTRUCTION_INITIATED | Challenge deposit verification request was initiated. |
INSTRUCTION_SENT | Challenge deposit verification request was sent. |
Enums: Field Types
Enums: Login Form Types
Enums: Aggregated Account Type
Enums: Manual Account Type
Applicable Containers | AccountType |
bank | CHECKING |
SAVINGS | |
CD | |
PREPAID | |
creditCard | CREDIT |
loan | PERSONAL_LOAN |
HOME_LOAN | |
bill | BILLS |
insurance | INSURANCE |
ANNUITY | |
investment | BROKERAGE_CASH |