This page refers to Yodlee API v1.0. The latest API version's 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
| Attribute Name | Type | Description | Endpoints |
|---|---|---|---|
| id | string | Routing number of the account. This attribute is provided only in case of CDV verification. | PUT providerAccounts/verification GET providerAccounts/verification/{providerAccountId} |
| type | string | Indicates that the id provided was routing number. This attribute is provided in the response only in case of CDV verification. | PUT providerAccounts/verification GET providerAccounts/verification/{providerAccountId} |
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
| 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} |
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} |
Enums: Provider Account Status
| Status | Additional Status | Additional Info | Scenario |
|---|---|---|---|
| IN_PROGRESS | LOGIN_IN_PROGRESS | Provider login is in progress. | |
| IN_PROGRESS | USER_INPUT_REQUIRED | Provider site requires MFA-based authentication and needs user input for login. | |
| IN_PROGRESS | LOGIN_SUCCESS | Provider login is successful. | |
| IN_PROGRESS | ACCOUNT_SUMMARY_RETRIEVED | Account summary info may not have the complete info of accounts that are available in the provider site. This depends on the sites behaviour. Account summary info may not be available at all times. | |
| NON_UPDATABLE | UPDATED_RECENTLY | All accounts under the provider account were recently updated. Try again after 15 minutes. | |
| NON_UPDATABLE | REFRESH_IN_PROGRESS | Refresh is in progress for the provider account. Refresh cannot be triggered when a refresh is in progress. | |
| FAILED | NEVER_INITIATED | The add or update provider account was not triggered due to techincal reasons. This is a rare occurrence and usually resolves quickly. | |
| FAILED | LOGIN_FAILED | Provider login failed. | |
| FAILED | REQUEST_TIME_OUT | The process timed out. | |
| FAILED | DATA_RETRIEVAL_FAILED | All accounts under the provider account failed with same or different errors, though login was successful. | |
| FAILED | No additional status or information will be provided when there are errors other than the ones listed above. | ||
| PARTIAL_SUCCESS | PARTIAL_DATA_RETRIEVED | DATA_RETRIEVAL_FAILED_PARTIALLY | One/few accounts data gathered and one/few accounts failed. |
| PARTIAL_SUCCESS | PARTIAL_DATA_RETRIEVED_REM_SCHED | DATA_RETRIEVAL_FAILED_PARTIALLY | One/few accounts data gathered One/few accounts failed One account data partially gathered and remaining scheduled. |
| PARTIAL_SUCCESS | PARTIAL_DATA_RETRIEVED_REM_SCHED | One/few accounts data gathered One account data partially gathered and remaining scheduled. | |
| SUCCESS | All accounts under the provider was added or updated successfully. |
Enums: Refresh Status Code and Message
| statusCode | statusMessage | Description | Additional Information |
|---|---|---|---|
| 0 | SUCCESS | Account has been successfully added/updated. | Not an Error |
| 395 | OAUTH_SITE_NOT_SUPPORTED | The site does not seem to be supported. | Technical Error |
| 401 | NO_CONNECTION | Request Timed Out. | Technical Error |
| 402 | STATUS_LOGIN_FAILED | Username and/or password were reported to be incorrect. | UAR Error |
| 403 | INTERNAL_ERROR | We faced a technical problem while updating your account. This kind of error is usually resolved in a few days. | Technical Error |
| 404 | LOST_REQUEST | We faced a technical problem while updating your account. | Technical Error |
| 405 | ABORT_REQUEST | User has aborted the request. | User Error |
| 406 | STATUS_PASSWORD_EXPIRED | The password or the authentication information were reported as expired. | UAR Error |
| 407 | STATUS_ACCOUNT_LOCKED | The account has been locked in the provider site. | UAR Error |
| 408 | DATA_EXPECTED | No accounts found in the provider site. | Technical Error |
| 409 | STATUS_SITE_UNAVAILABLE | Account could not be updated because the end site is experiencing technical difficulties. | Site Error |
| 411 | STATUS_SITE_OUT_OF_BUSINESS | The provider site no longer provides online services to its customers. | Site Error |
| 412 | STATUS_SITE_APPLICATION_ERROR | The provider site is experiencing technical difficulties. | Site Error |
| 413 | REQUIRED_FIELD_UNAVAILABLE | We faced a technical problem while updating your account. This kind of error is usually resolved in a few days. | Technical Error |
| 414 | STATUS_NO_ACCT_FOUND | No accounts found in the provider site. | UAR Error |
| 415 | STATUS_SITE_TERMINATED_SESSION | Experiencing technical difficulties in the provider site. | Site Error |
| 416 | STATUS_SITE_SESSION_ALREADY_ESTABLISHED | Session was already established in the provider site. | Site Error |
| 417 | STATUS_DATA_MODEL_NO_SUPPORT | Account type was not supported by Yodlee. | UAR Error |
| 418 | STATUS_HTTP_DNS_ERROR_EXCEPTION | The provider site is experiencing technical difficulties. | Site Error |
| 419 | LOGIN_NOT_COMPLETED | We couldn't update the account because of unexpected variations at the site. This kind of problem is usually resolved in a few days. | Technical Error |
| 420 | STATUS_SITE_MERGED_ERROR | The provider site has been merged with another site. | UAR Error |
| 421 | STATUS_UNSUPPORTED_LANGUAGE_ERROR | The language setting for the provider site is not English. Please request the user to visit the site and change the language setting to English. | UAR Error |
| 422 | STATUS_ACCOUNT_CANCELED | Accounts found were closed. | UAR Error |
| 423 | STATUS_ACCT_INFO_UNAVAILABLE | No accounts found in the provider site. | Site Error |
| 424 | STATUS_SITE_DOWN_FOR_MAINTENANCE | The provider site was down for maintenance. | Site Error |
| 425 | STATUS_CERTIFICATE_ERROR | The provider site is experiencing technical difficulties. | Site Error |
| 426 | STATUS_SITE_BLOCKING | The provider site is experiencing technical difficulties. | Site Error |
| 427 | STATUS_SPLASH_PAGE_EXCEPTION | We could not update the account as the site requiring the user to view a new promotion. Please request the user to log in to the site and click through to his/her account overview page to update the details. | UAR Error |
| 428 | STATUS_TERMS_AND_CONDITIONS_EXCEPTION | We could not update the account due to the site requiring the user to accept new Terms & Conditions. Please request the user to log in to the site, read and accept the T&C. | UAR Error |
| 429 | STATUS_UPDATE_INFORMATION_EXCEPTION | We could not update the account due to the site requiring user to verify his/her personal information. Please request the user to log in to the site and update the fields required. | UAR Error |
| 430 | STATUS_SITE_NOT_SUPPORTED | Site is no longer supported for data updates. | UAR Error |
| 431 | HTTP_FILE_NOT_FOUND_ERROR | We faced a browser error while retrieving data. | Site Error |
| 432 | HTTP_INTERNAL_SERVER_ERROR | We faced a browser error while retrieving data. | Site Error |
| 475 | UNIQUEID_FROM_DATA_SOURCE_ERROR | We faced issues while setting the unique identifer for an account. Example: Two accounts seem to have the same unique identifier. | Technical Error |
| 476 | ACCOUNT_REQUIRED_FIELDS_NOT_SET | The required fields does not seem to be set due to technical issues. | Technical Error |
| 477 | BILL_REQUIRED_FIELDS_NOT_SET | The required fields does not seem to be set due to technical issues. | Technical Error |
| 478 | STATUS_DUPLICATE_BILL | We faced duplicate bill issues while retrieving bills for an account. | Site Error |
| 491 | REWARDS_PROGRAM_REQUIRED_FIELDS_NOT_SET | The required fields does not seem to be set due to technical issues. | Technical Error |
| 492 | REWARDS_ACTIVITY_REQUIRED_FIELDS_NOT_SET | The required fields does not seem to be set due to technical issues. | Technical Error |
| 494 | INVESTMENT_TRANSACTION_REQUIRED_FIELDS_NOT_SET | The required fields does not seem to be set due to technical issues. | Technical Error |
| 495 | LOAN_TRANSACTION_REQUIRED_FIELDS_NOT_SET | The required fields does not seem to be set due to technical issues. | Technical Error |
| 496 | CARD_TRANSACTION_REQUIRED_FIELDS_NOT_SET | The required fields does not seem to be set due to technical issues. | Technical Error |
| 497 | BANK_TRANSACTION_REQUIRED_FIELDS_NOT_SET | The required fields does not seem to be set due to technical issues. | Technical Error |
| 498 | HOLDING_REQUIRED_FIELDS_NOT_SET | The required fields does not seem to be set due to technical issues. | Technical Error |
| 499 | HELD_ACCOUNT'S_CREDENTIALS_USED | The user has provided their online application credentials to the linking provider site. | Site Error |
| 504 | MULTIPLE_ERROR | Multiple errors have occurred and the data retrieval process at the provider site failed. | Combinations of Technical/Site/UAR errors |
| 505 | STATUS_SITE_CURRENTLY_NOT_SUPPORTED | Yodlee does not support the security system used by this site. | Site Error |
| 506 | NEW_LOGIN_INFO_REQUIRED_FOR_SITE | To log in to this site, user need to provide additional information. Request the user to perform update accounts. | UAR Error |
| 507 | BETA_SITE_WORK_IN_PROGRESS | We have just started providing data updates for this site, and it may take a few days to be successful as we get started. | Technical Error |
| 508 | INSTANT_REQUEST_TIMEDOUT | Add/update account request timed out due to technical reasons. | Technical Error |
| 509 | TOKEN_ID_INVALID | The MFA token provided is no longer valid at the site. | User Input Error |
| 509 | TOKEN_ID_INVALID | The MFA token provided is no longer valid at the site. | User Input Error |
| 512 | NO_PAYEES_ARE_FOUND_ON_SOURCE | Payees does not seem to be available in the provider site. | User Error |
| 513 | PAYEES_COULD_NOT_BE_RETRIEVED | We faced issues while retrieving payees. | Technical Error |
| 514 | SOME_PAYEE_DETAILS_COULD_NOT_BE_RETRIEVED | We faced issues while retrieving one or more payee details. | Technical Error |
| 515 | NO_PAYMENT_ACCOUNT_FOUND | The payment account does not seem to be available in the provider site. | User Error |
| 517 | GENERAL_EXCEPTION_WHILE_GATHERING_MFA_DATA | We faced a technical problem while updating your account.This kind of error is usually resolved in a few days. | Technical Error |
| 518 | NEW_MFA_INFO_REQUIRED_FOR_AGENTS | Account was not updated as the required additional authentication information was unavailable.(MFA error) | UAR Error |
| 519 | MFA_INFO_NOT_PROVIDED_TO_YODLEE_BY_USER_FOR_AGENTS | Account was not updated as the authentication information like security question and answer was unavailable or incomplete. (MFA error) | UAR Error |
| 520 | MFA_INFO_MISMATCH_FOR_AGENTS | Provider site indicates that the additional authentication information provided is incorrect. (MFA error) | UAR Error |
| 521 | ENROLL_IN_MFA_AT_SITE | New security authentication system has been introduced in the provider site.(MFA error) | UAR Error |
| 522 | MFA_INFO_NOT_PROVIDED_IN_REAL_TIME_BY_USER_VIA_APP | Request Timed Out as the required security information was unavailable or was not provided within the expected time. (MFA error) | UAR Error |
| 523 | INVALID_MFA_INFO_IN_REAL_TIME_BY_USER_VIA_APP | The authentication information user provided is incorrect. (MFA error) | UAR Error |
| 524 | USER_PROVIDED_REAL_TIME_MFA_DATA_EXPIRED | The authentication information provided has expired. (MFA error) | UAR Error |
| 525 | MFA_INFO_NOT_PROVIDED_IN_REAL_TIME_BY_GATHERER | We faced a technical problem while updating your account. This kind of error is usually resolved in a few days. | Technical Error |
| 526 | INVALID_MFA_INFO_OR_CREDENTIALS | We could not update the account as the username/password or additional security credentials are incorrect. (MFA error) | UAR Error |
| 552 | CREDENTIALS_SUSPENDED | Credentials provided by the user seems to be suspended. | User Error |
| 553 | REQUEST_TIMED_OUT_DUE_TO_USER | User has not provided the information in the required time period. | User Error |
| 554 | NO_RESPONSE_FROM_SITE | We have not received a response from site. | Site Error |
| 556 | OAUTH_SITE_UNAVAILABLE | Outh site does not seem to be available for updates. | Site Error |
| 557 | INVALID_OAUTH_REQUEST | The OAUTH request generated is invalid. | Technical Error |
| 558 | SITE_UNAVAILABLE_INFORMED_BY_SITE | Site does not seem to be available for updates and informed by site. | Site Error |
| 559 | INSUFFICIENT_PRIVILEGE | Users does not have sufficient privilege. | User Error |
| 560 | INVALID_OAUTH_TOKEN | The oauth token provided is invalid. | Technical Error |
| 561 | GENERIC_OAUTH_ERROR | We faced technical issues while aggregating the data from OAUTH based site. | Technical Error |
| 562 | OAUTH_CONSENT_EXPIRED | The oauth token has expired. | User Error |
| 563 | OAUTH_CONSENT_REVOKED | The oauth token has been revoked. | User Error |
| 564 | OAUTH_CONSENT_UNAVAILABLE | The oauth consent is not available. | User Error |
| 565 | CERT_UNAVAILABLE_ERROR | The certificate is not available. | Technical Error |
| 566 | CERT_DOWNLOAD_ERROR | The certificate cannot be downloaded. | Technical Error |
| 567 | OAUTH_MIGRATION_FAILED | The oauth migration has failed. | Technical Error |
| 570 | DOCUMENT_NOT_AVAILABLE | Document not available for download. | User Error |
| 571 | DOCUMENT_DOWNLOAD_FAILED | The document download process has failed due to site issues. | Site Error |
| 572 | DOCUMENT_SIZE_EXCEEDS_THE_LIMIT | The document that we are trying to download exceeded the size limit. | Technical Error |
| 573 | DOCUMENT_DOWNLOAD_REQUIRES_ADDTNL_AUTHENTICATION | Document download needs additional authentication. | User Error |
| 574 | EBILL_ENROLLMENT_REQUIRED_FOR_BILL_DOWNLOAD | User has not enrolled for the ebill. | User Error |
| 575 | DOCUMENT_DOWNLOADED_NOT_SUPPORTED | No support available for document download. | User Error |
| 576 | DOCUMENT_UPLOAD_TO_SERVER_FAILED | The downloaded document failed while uploading to our server. | Technical Error |
| 578 | DOCUMENT_TYPE_NOT_SUPPORTED | The type of the document does not seem to be supported. | Technical Error |
| 579 | DOCUMENT_PROCESSING_FAILED | We faced technical error while processing the document. | Technical Error |
| 601 | DBFILER_SUMMARY_SAVE_ERROR | We faced a technical problem while updating your account. | Technical Error |
| 604 | STATUS_REQUEST_GENERATION_ERROR_LOGIN_FAILURE | We faced technical issues while generating the request for data retrieval. | Technical Error |
| 709 | STATUS_FIELD_NOT_AVAILABLE | This error is thrown when there is a mismatch in the meta-fields. | Technical Error |
| 801 | ADD_IN_PROGRESS | Account addition is in progress. | Not an Error |
| 802 | UPDATE_IN_PROGRESS | Account update is in progress. | Not an Error |
| 803 | REFFRESH_NOT_DONE_AS_MIGRATION_IN_PROGRESS | The account cannot be refreshed as the OAuth migration is in progress. | Technical Error |
| 811 | PARTIAL_SUCCESS | Data was successfully aggregated for at least one, but not all, accounts. | Partial Success |
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
| Type | Description |
|---|---|
| text | The field values can be accepted in a 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. |
| option | The field values should be displayed in a drop down. |
| checkbox | The field values should be displayed in a check box. |
| radio | The field values should be displayed as radio options. |
| image | The field values should be displayed as image |
Enums: Login Form Types
| FormType | 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: Aggregated Account Type
| Applicable Containers | AccountType |
| bank | CHECKING |
| SAVINGS | |
| CD | |
| PPF | |
| RECURRING_DEPOSIT | |
| FSA | |
| MONEY_MARKET | |
| IRA | |
| PREPAID | |
| OTHER | |
| creditCard | CREDIT |
| STORE | |
| CHARGE | |
| OTHER | |
| investment (SN 1.0) | BROKERAGE_MARGIN |
| HSA | |
| IRA | |
| BROKERAGE_CASH | |
| 401K | |
| 403B | |
| TRUST | |
| ANNUITY | |
| SIMPLE | |
| CUSTODIAL | |
| BROKERAGE_CASH_OPTION | |
| BROKERAGE_MARGIN_OPTION | |
| INDIVIDUAL | |
| CORPORATE | |
| JTTIC | |
| JTWROS | |
| COMMUNITY_PROPERTY | |
| JOINT_BY_ENTIRETY | |
| CONSERVATORSHIP | |
| ROTH | |
| ROTH_CONVERSION | |
| ROLLOVER | |
| EDUCATIONAL | |
| 529_PLAN | |
| 457_DEFERRED_COMPENSATION | |
| 401A | |
| PSP | |
| MPP | |
| STOCK_BASKET | |
| LIVING_TRUST | |
| REVOCABLE_TRUST | |
| IRREVOCABLE_TRUST | |
| CHARITABLE_REMAINDER | |
| CHARITABLE_LEAD | |
| CHARITABLE_GIFT_ACCOUNT | |
| SEP | |
| UTMA | |
| UGMA | |
| ESOPP | |
| ADMINISTRATOR | |
| EXECUTOR | |
| PARTNERSHIP | |
| SOLE_PROPRIETORSHIP | |
| CHURCH | |
| INVESTMENT_CLUB | |
| RESTRICTED_STOCK_AWARD | |
| CMA | |
| EMPLOYEE_STOCK_PURCHASE_PLAN | |
| PERFORMANCE_PLAN | |
| BROKERAGE_LINK_ACCOUNT | |
| MONEY_MARKET | |
| SUPER_ANNUATION | |
| REGISTERED_RETIREMENT_SAVINGS_PLAN | |
| SPOUSAL_RETIREMENT_SAVINGS_PLAN | |
| DEFERRED_PROFIT_SHARING_PLAN | |
| NON_REGISTERED_SAVINGS_PLAN | |
| REGISTERED_EDUCATION_SAVINGS_PLAN | |
| GROUP_RETIREMENT_SAVINGS_PLAN | |
| LOCKED_IN_RETIREMENT_SAVINGS_PLAN | |
| RESTRICTED_LOCKED_IN_SAVINGS_PLAN | |
| LOCKED_IN_RETIREMENT_ACCOUNT | |
| REGISTERED_PENSION_PLAN | |
| TAX_FREE_SAVINGS_ACCOUNT | |
| LIFE_INCOME_FUND | |
| REGISTERED_RETIREMENT_INCOME_FUND | |
| SPOUSAL_RETIREMENT_INCOME_FUND | |
| LOCKED_IN_REGISTERED_INVESTMENT_FUND | |
| PRESCRIBED_REGISTERED_RETIREMENT_INCOME_FUND | |
| GUARANTEED_INVESTMENT_CERTIFICATES | |
| REGISTERED_DISABILITY_SAVINGS_PLAN | |
| OTHER | |
| investment (SN 2.0) | BROKERAGE_CASH |
| BROKERAGE_MARGIN | |
| INDIVIDUAL_RETIREMENT_ACCOUNT_IRA | |
| EMPLOYEE_RETIREMENT_ACCOUNT_401K | |
| EMPLOYEE_RETIREMENT_SAVINGS_PLAN_403B | |
| TRUST | |
| ANNUITY | |
| SIMPLE_IRA | |
| CUSTODIAL_ACCOUNT | |
| BROKERAGE_CASH_OPTION | |
| BROKERAGE_MARGIN_OPTION | |
| INDIVIDUAL | |
| CORPORATE_INVESTMENT_ACCOUNT | |
| JOINT_TENANTS_TENANCY_IN_COMMON_JTIC | |
| JOINT_TENANTS_WITH_RIGHTS_OF_SURVIVORSHIP_JTWROS | |
| JOINT_TENANTS_COMMUNITY_PROPERTY | |
| JOINT_TENANTS_TENANTS_BY_ENTIRETY | |
| CONSERVATOR | |
| ROTH_IRA | |
| ROTH_CONVERSION | |
| ROLLOVER_IRA | |
| EDUCATIONAL | |
| EDUCATIONAL_SAVINGS_PLAN_529 | |
| DEFERRED_COMPENSATION_PLAN_457 | |
| MONEY_PURCHASE_RETIREMENT_PLAN_401A | |
| PROFIT_SHARING_PLAN | |
| MONEY_PURCHASE_PLAN | |
| STOCK_BASKET_ACCOUNT | |
| LIVING_TRUST | |
| REVOCABLE_TRUST | |
| IRREVOCABLE_TRUST | |
| CHARITABLE_REMAINDER_TRUST | |
| CHARITABLE_LEAD_TRUST | |
| CHARITABLE_GIFT_ACCOUNT | |
| SEP_IRA | |
| UNIFORM_TRANSFER_TO_MINORS_ACT_UTMA | |
| UNIFORM_GIFT_TO_MINORS_ACT_UGMA | |
| EMPLOYEE_STOCK_OWNERSHIP_PLAN_ESOP | |
| ADMINISTRATOR | |
| EXECUTOR | |
| PARTNERSHIP | |
| PROPRIETORSHIP | |
| CHURCH_ACCOUNT | |
| INVESTMENT_CLUB | |
| RESTRICTED_STOCK_AWARD | |
| CASH_MANAGEMENT_ACCOUNT | |
| EMPLOYEE_STOCK_PURCHASE_PLAN_ESPP | |
| PERFORMANCE_PLAN | |
| BROKERAGE_LINK_ACCOUNT | |
| MONEY_MARKET_ACCOUNT | |
| SUPERANNUATION | |
| REGISTERED_RETIREMENT_SAVINGS_PLAN_RRSP | |
| SPOUSAL_RETIREMENT_SAVINGS_PLAN_SRSP | |
| DEFERRED_PROFIT_SHARING_PLAN_DPSP | |
| NON_REGISTERED_SAVINGS_PLAN_NRSP | |
| REGISTERED_EDUCATION_SAVINGS_PLAN_RESP | |
| GROUP_RETIREMENT_SAVINGS_PLAN_GRSP | |
| LOCKED_IN_RETIREMENT_SAVINGS_PLAN_LRSP | |
| RESTRICTED_LOCKED_IN_SAVINGS_PLAN_RLSP | |
| LOCKED_IN_RETIREMENT_ACCOUNT_LIRA | |
| REGISTERED_PENSION_PLAN_RPP | |
| TAX_FREE_SAVINGS_ACCOUNT_TFSA | |
| LIFE_INCOME_FUND_LIF | |
| REGISTERED_RETIREMENT_INCOME_FUND_RIF | |
| SPOUSAL_RETIREMENT_INCOME_FUND_SRIF | |
| LOCKED_IN_REGISTERED_INVESTMENT_FUND_LRIF | |
| PRESCRIBED_REGISTERED_RETIREMENT_INCOME_FUND_PRIF | |
| GUARANTEED_INVESTMENT_CERTIFICATES_GIC | |
| REGISTERED_DISABILITY_SAVINGS_PLAN_RDSP | |
| DEFINED_CONTRIBUTION_PLAN | |
| DEFINED_BENEFIT_PLAN | |
| EMPLOYEE_STOCK_OPTION_PLAN | |
| NONQUALIFIED_DEFERRED_COMPENSATION_PLAN_409A | |
| KEOGH_PLAN | |
| EMPLOYEE_RETIREMENT_ACCOUNT_ROTH_401K | |
| DEFERRED_CONTINGENT_CAPITAL_PLAN_DCCP | |
| EMPLOYEE_BENEFIT_PLAN | |
| EMPLOYEE_SAVINGS_PLAN | |
| HEALTH_SAVINGS_ACCOUNT_HSA | |
| COVERDELL_EDUCATION_SAVINGS_ACCOUNT_ESA | |
| TESTAMENTARY_TRUST | |
| ESTATE | |
| GRANTOR_RETAINED_ANNUITY_TRUST_GRAT | |
| ADVISORY_ACCOUNT | |
| NON_PROFIT_ORGANIZATION_501C | |
| HEALTH_REIMBURSEMENT_ARRANGEMENT_HRA | |
| INDIVIDUAL_SAVINGS_ACCOUNT_ISA | |
| CASH_ISA | |
| STOCKS_AND_SHARES_ISA | |
| INNOVATIVE_FINANCE_ISA | |
| JUNIOR_ISA | |
| EMPLOYEES_PROVIDENT_FUND_ORGANIZATION_EPFO | |
| PUBLIC_PROVIDENT_FUND_PPF | |
| EMPLOYEES_PENSION_SCHEME_EPS | |
| NATIONAL_PENSION_SYSTEM_NPS | |
| INDEXED_ANNUITY | |
| ANNUITIZED_ANNUITY | |
| VARIABLE_ANNUITY | |
| ROTH_403B | |
| SPOUSAL_IRA | |
| SPOUSAL_ROTH_IRA | |
| SARSEP_IRA | |
| SUBSTANTIALLY_EQUAL_PERIODIC_PAYMENTS_SEPP | |
| OFFSHORE_TRUST | |
| IRREVOCABLE_LIFE_INSURANCE_TRUST | |
| INTERNATIONAL_TRUST | |
| LIFE_INTEREST_TRUST | |
| EMPLOYEE_BENEFIT_TRUST | |
| PRECIOUS_METAL_ACCOUNT | |
| INVESTMENT_LOAN_ACCOUNT | |
| GRANTOR_RETAINED_INCOME_TRUST | |
| PENSION_PLAN | |
| OTHER | |
| bill | TELEPHONE |
| UTILITY | |
| CABLE | |
| WIRELESS | |
| BILLS | |
| loan | MORTGAGE |
| INSTALLMENT_LOAN | |
| PERSONAL_LOAN | |
| HOME_EQUITY_LINE_OF_CREDIT | |
| LINE_OF_CREDIT | |
| AUTO_LOAN | |
| STUDENT_LOAN | |
| HOME_LOAN | |
| OTHER | |
| insurance | AUTO_INSURANCE |
| HEALTH_INSURANCE | |
| HOME_INSURANCE | |
| LIFE_INSURANCE | |
| ANNUITY | |
| TRAVEL_INSURANCE | |
| INSURANCE | |
| realEstate | REAL_ESTATE |
| reward | REWARD_POINTS |
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 |