Yodlee API

Note:

Update the various environments (Stage, Developer Sandbox, Production) are rolled out in different upgrade windows. Please consult with Solution Engineer (for stage), Client/Support (for production) to get exact date-time of upgrade.

New Features and Enhancements Summary

The following are the enhancements made to the Yodlee services as part of the September release.

  1. Enhancements have been made so that the quick start customers could access all the Yodlee APIs.

    Note:

    1. Quick Start customers will have access only to limited set of sites that are enabled for them.
    2. Following features are not offered to the quick start customers:
      1. Suggested
      2. Dynamic Popular Sites
      3. Search
  2. New account types have been introduced in the system. Please refer the appendix for the newly introduced account types. Get accounts and get account details service will provide the relevant account type in the accountType field depending on the nature of the account.
  3. Account masking functionality has been introduced. With this support, account numbers will be masked and returned in the get account details and get accounts services.
  4. Two new additonalStatus values have been introduced in the providerAccount services:
additionalStatus Scenario
PARTIAL_DATA_RETRIEVED One/few of the accounts encountered failures and remaining data retrieved successfully. 
PARTIAL_DATA_RETRIEVED_REM_SCHED Transactions have been retrieved partially and the remaining scheduled.

Existing APIs Enhancement Details

Endpoint Enhancement Details
 

GET /{cobrandName}/v1/providerAccounts/{providerAccountId}

GET /{cobrandName}/v1/providerAccounts

  

The services have been enhanced to provide the createdDate and lastUpdated fields.

 

GET /{cobrandName}/v1/accounts

GET /{cobrandName}/v1/accounts/{accountId}

The services have been enhanced to provide the createdDate and lastUpdated fields.

GET /{cobrandName}/v1/providers

 The additionalDataSet entity has been introduced 

Points to Note:

  • With the new implementation, customers can rely on status “PARTIAL_SUCCESS” and additionalStatus “PARTIAL_DATA_RETRIEVED_REM_SCHED” to identify whether the progressive refresh has been scheduled for an account.
  • The endpoint for providerAccount services has been changed from “provider/providerAccount” to “providerAccount”. This change was made in the aspect of better REST practices and changes were done in such a way that the changes does not impact the existing implementation.
  • The additionalDataset in providers API response represents the attributes that are not retrieved by default. The same cannot be requested or retrieved for accounts with this release. APIs to request the same will be released in forthcoming releases.

Appendix

New Account Types

  1. REGISTERED_RETIREMENT_SAVINGS_PLAN
  2. SPOUSAL_RETIREMENT_SAVINGS_PLAN
  3. DEFERRED_PROFIT_SHARING_PLAN
  4. NON_REGISTERED_SAVINGS_PLAN
  5. REGISTERED_EDUCATION_SAVINGS_PLAN
  6. GROUP_RETIREMENT_SAVINGS_PLAN
  7. LOCKED_IN_RETIREMENT_SAVINGS_PLAN
  8. RESTRICTED_LOCKED_IN_SAVINGS_PLAN
  9. LOCKED_IN_RETIREMENT_ACCOUNT
  10. REGISTERED_PENSION_PLAN
  11. TAXFREE_SAVINGS_ACCOUNT
  12. LIFE_INCOME_FUND
  13. REGISTERED_RETIREMENT_INCOME_FUND
  14. SPOUSAL_RETIREMENT_INCOME_FUND
  15. LOCKED_IN_REGISTERED_INVESTMENT_FUND
  16. PRESCRIBED_REGISTERED_RETIREMENT_INCOME_FUND
  17. PRESCRIBED_REGISTERED_RETIREMENT_INCOME_FUND
  18. GUARANTEED_INVESTMENT_CERTIFICATES
  19. REGISTERED_DISABILITY_SAVINGS_PLAN
  20. REGISTERED_DISABILITY_SAVINGS_PLAN
  21. SUPER_ANNUATION
  22. RECURRING_DEPOSIT
  23. HOME_LOAN