Yodlee APIs – New Features/Enhancements
Update Eligibility Values Changed
To improve the aggregation success rates, we have updated the values of the updateEligibility
attribute for the following scenarios:
- Provider site is temporarily not available or blocked for refresh – The
updateEligibility
attribute value has been updated fromDISALLOW_UPDATE
toALLOW_UPDATE
.
This change gives the users an option to trigger the refresh later, and it applies only to scenarios where the issues at the provider site are temporary.Additional Status Update Eligibility Current Changed SITE_BLOCKING_ERROR
DISALLOW_UPDATE
ALLOW_UPDATE
- Permanent issues at the provider site – The
updateEligibility
attribute value will still beDISALLOW_UPDATE
when the additionalStatus isSITE_NOT_SUPPORTED
. - Credential update or new credential is required – The
updateEligibility
attribute value has been updated fromDISALLOW_UPDATE
toALLOW_UPDATE_WITH_CREDENTIALS
.Additional Status Update Eligibility Current Changed CREDENTIALS_UPDATE_NEEDED
DISALLOW_UPDATE
ALLOW_UPDATE_WITH_CREDENTIALS
NEW_AUTHENTICATION_REQUIRED
Client Credential, JWT, and SAML Feature Compatibility
The existing limitation is a user registered using Yodlee API v1.1 with the client credential (CC) or the JWT authentication method is not accessible using the SAML authentication. With this enhancement, the user that has registered using any of the methods such as Yodlee API v1.1 registration service using CC or JWT authentication, SAML implicit registration, or CC implicit registration will be accessible through any of the authentication methods.
JAVA SDK Enhancements and Bug Fixes
- GZIP compression support – The SDK has been enhanced to request GZIP compression for APIs where the response payloads are large. This feature will help in improving performance during the response payload transmission.
- The SDK has been enhanced for the new attribute and services that are updated for this release.
- Bug fixes:
- For the
providerAccount
entity the enum attributetype
is fixed to accept the correct valueoptions
instead ofoption
. - The SDK has been fixed to support more currencies.
- For the
MFA Enhancements
- MFA buffer time enhancement –
To reduce the MFA failures, the GET provider account details API will withhold few seconds from the actual timeout as a buffer time and return the remaining time in themfaTimeout
attribute.
For example, for an MFA site with 50 seconds as the MFA timeout, the API will return 45 seconds as themfaTimeout
value. This will assure that the request will be successfully processed, even if the user answers close to the 45th second.API URL: - Dynamic MFA timeout –
To provide a better experience, the GET provider account details API API has been enhanced to return the remaining time to accept the MFA input from the user in themfaTimeout
attribute.
For example, for an MFA site, the API call returns the MFA login form at 23:29:00, along with themfaTimeout
value of 90000. If the same API call is made at 23:29:30, the API will returnmfaTimeout
value as 60000 (as 30 seconds have elapsed).API URL:
Bug Fix
When credentials are required to perform a refresh for a provider account, refresh is triggered and it fails after some time. This behavior has been updated to restrict refresh requests for provider accounts that require credentials to refresh; the following error message will be returned:
{
"errorCode":"Y825",
"errorMessage":"Update not allowed ( Reason: USER_INPUT_REQUIRED )",
"referenceCode":"y1610979532181X9u1x"
}
Account Verification - New Features/Enhancements
New Latest Account Balance API
Asynchronous API to fetch the latest balance of a verified account has been introduced. This new API reduces the complexity of using three different APIs to fetch the latest account balance. Internally, the API initiates a new refresh, and the latest balance is returned if the refresh is completed within the configured period (default is 30 seconds) with the SUCCESS
status. The GET latest balance API will only initiate a new refresh if the time between the previous refresh and the new request is more than the configured time interval (default is 15 minutes).
Refreshes that continue beyond the configured time are returned with IN_PRORESS
status. Customers can utilize the new dedicated webhook developed for the GET latest balance API to get notified when the refresh is completed. If the refresh fails due to an error, the FAILED
status will be returned with the corresponding failed reason.
API URL: |
Webhooks for Latest Account Balance API
A new webhooks event – LATEST_BALANCE_UPDATES – has been introduced that is dedicated to the GET latest account balance API. Customers should subscribe to the new event to receive notifications when the balance refresh request is performed using the GET latest account balance API.
Notifications will only be generated and sent when a new refresh triggered by the GET latest balance API is completed. The webhooks notification lets the customer know if the refresh request is successful or has failed, and it enables the customer to fetch the updated balance using the GET latest balance API. For more details, see Latest Balance Status Notification.
Chase Provider OAuth Upgrade – Verification Impact
As part of the Chase OAuth or OB upgrade, the full account number has been replaced with a substitute account number (SAN) and a different routing number for Chase OB. The following changes are being done to accommodate the Chase OAuth upgrade:
- Legacy account verification implementation –
- Matching service – Account number matching will not be done for the Chase OB site irrespective of the customer’s configuration. This only applies to customers who have enabled account number matching.
- Data service – In the
accountNumber
attribute, SAN will be returned. It is recommended to not display SAN to the users but it can be used for ACH payments.
- FastLink 2.0 – For the Chase OB site, after verification, the account number will not be displayed in the account summary screen.
- FastLink 3.0 – After verification, the routing number will not be displayed in the account summary screen for the Chase OB site.
Transaction Data Enrichment – New Features/Enhancements
Detail Category Added
Based on the market feedback, to improve the enrichment output for retail customers, the following six new granular or detail categories have been added to the existing category enrichment:
Category ID | Detail Category Name |
---|---|
1706 | Private Airports |
1707 | Comic Book Stores |
1708 | Comedy Clubs |
1709 | Bubble Tea |
1710 | Vaporizer Shops |
1711 | Cannabis Stores |
Update Transaction API Enhancement
The update transaction API currently allows consumers to update/override only the master category enrichment based on their preference. As part of this release, this functionality has been extended to three more enrichment fields.
Consumers can provide inputs and override the following three enrichments fields with their preferences using the update transaction API supports:
isPhysical
merchantType
detailCategoryId
API URL: |
Wealth Management – New Features/Enhancements
Machine Learning Model – Account Type Enrichment
Using Machine Learning (ML) models, the account type identification process has been enhanced to have better population rates and improved data accuracy.
The enhanced ML account type data model is intended to serve as a replacement for the legacy Security Normalization (SN) 1.0 account types. The legacy SN 1.0 account types will no longer be available in the FinApp views and API responses. Mapping of these changes is provided in Account Type Mapping.
The accountType
field in the following API response and the standard FinApp views should be referenced for account types:
API URLs: |
|
Account Category
In the GET accounts API, a new accountCategory
attribute has been introduced that will add a new hierarchy in the account type enrichment process to identify broad-level grouping of account types. The new attribute accountCategory
will only be available to the Yodlee API v1.1 customers and will return the following values:
|
|
Account Type Mapping
The ML model references the latest account type list and is focused on improving accuracy and population rates:
Legacy Data Model | Latest ML Model |
---|---|
(SN 1.0 API Response Value) | (API Response Value) |
OTHER | OTHER |
BROKERAGE_CASH | BROKERAGE_CASH |
BROKERAGE_MARGIN | BROKERAGE_MARGIN |
IRA | INDIVIDUAL_RETIREMENT_ACCOUNT_IRA |
401K | EMPLOYEE_RETIREMENT_ACCOUNT_401K |
403B | EMPLOYEE_RETIREMENT_SAVINGS_PLAN_403B |
TRUST | TRUST |
ANNUITY | ANNUITY |
SIMPLE | SIMPLE_IRA |
CUSTODIAL | CUSTODIAL_ACCOUNT |
BROKERAGE_CASH_OPTION | BROKERAGE_CASH_OPTION |
BROKERAGE_MARGIN_OPTION | BROKERAGE_MARGIN_OPTION |
INDIVIDUAL | INDIVIDUAL |
CORPORATE | CORPORATE_INVESTMENT_ACCOUNT |
JTTIC | JOINT_TENANTS_TENANCY_IN_COMMON_JTIC |
JTWROS | JOINT_TENANTS_WITH_RIGHTS_OF_SURVIVORSHIP_JTWROS |
COMMUNITY_PROPERTY | JOINT_TENANTS_COMMUNITY_PROPERTY |
JOINT_BY_ENTIRETY | JOINT_TENANTS_TENANTS_BY_ENTIRETY |
CONSERVATORSHIP | CONSERVATOR |
ROTH | ROTH_IRA |
ROTH_CONVERSION | ROTH_CONVERSION |
ROLLOVER | ROLLOVER_IRA |
EDUCATIONAL | EDUCATIONAL |
529_PLAN | EDUCATIONAL_SAVINGS_PLAN_529 |
457_DEFERRED_COMPENSATION | DEFERRED_COMPENSATION_PLAN_457 |
401A | MONEY_PURCHASE_RETIREMENT_PLAN_401A |
PSP | PROFIT_SHARING_PLAN |
MPP | MONEY_PURCHASE_PLAN |
STOCK_BASKET | STOCK_BASKET_ACCOUNT |
LIVING_TRUST | LIVING_TRUST |
REVOCABLE_TRUST | REVOCABLE_TRUST |
IRREVOCABLE_TRUST | IRREVOCABLE_TRUST |
CHARITABLE_REMAINDER | CHARITABLE_REMAINDER_TRUST |
CHARITABLE_LEAD | CHARITABLE_LEAD_TRUST |
CHARITABLE_GIFT_ACCOUNT | CHARITABLE_GIFT_ACCOUNT |
SEP | SEP_IRA |
UTMA | UNIFORM_TRANSFER_TO_MINORS_ACT_UTMA |
UGMA | UNIFORM_GIFT_TO_MINORS_ACT_UGMA |
ESOPP | EMPLOYEE_STOCK_OWNERSHIP_PLAN_ESOP |
ADMINISTRATOR | ADMINISTRATOR |
EXECUTOR | EXECUTOR |
PARTNERSHIP | PARTNERSHIP |
SOLE_PROPRIETORSHIP | PROPRIETORSHIP |
CHURCH | CHURCH_ACCOUNT |
INVESTMENT_CLUB | INVESTMENT_CLUB |
RESTRICTED_STOCK_AWARD | RESTRICTED_STOCK_AWARD |
CMA | CASH_MANAGEMENT_ACCOUNT |
EMPLOYEE_STOCK_PURCHASE_PLAN | EMPLOYEE_STOCK_PURCHASE_PLAN_ESPP |
PERFORMANCE_PLAN | PERFORMANCE_PLAN |
BROKERAGE_LINK_ACCOUNT | BROKERAGE_LINK_ACCOUNT |
MONEY_MARKET | MONEY_MARKET_ACCOUNT |
SUPER_ANNUATION | SUPERANNUATION |
REGISTERED_RETIREMENT_SAVINGS_PLAN | REGISTERED_RETIREMENT_SAVINGS_PLAN_RRSP |
SPOUSAL_RETIREMENT_SAVINGS_PLAN | SPOUSAL_RETIREMENT_SAVINGS_PLAN_SRSP |
DEFERRED_PROFIT_SHARING_PLAN | DEFERRED_PROFIT_SHARING_PLAN_DPSP |
NON_REGISTERED_SAVINGS_PLAN | NON_REGISTERED_SAVINGS_PLAN_NRSP |
REGISTERED_EDUCATION_SAVINGS_PLAN | REGISTERED_EDUCATION_SAVINGS_PLAN_RESP |
GROUP_RETIREMENT_SAVINGS_PLAN | GROUP_RETIREMENT_SAVINGS_PLAN_GRSP |
LOCKED_IN_RETIREMENT_SAVINGS_PLAN | LOCKED_IN_RETIREMENT_SAVINGS_PLAN_LRSP |
RESTRICTED_LOCKED_IN_SAVINGS_PLAN | RESTRICTED_LOCKED_IN_SAVINGS_PLAN_RLSP |
LOCKED_IN_RETIREMENT_ACCOUNT | LOCKED_IN_RETIREMENT_ACCOUNT_LIRA |
REGISTERED_PENSION_PLAN | REGISTERED_PENSION_PLAN_RPP |
TAX_FREE_SAVINGS_ACCOUNT | TAX_FREE_SAVINGS_ACCOUNT_TFSA |
LIFE_INCOME_FUND | LIFE_INCOME_FUND_LIF |
REGISTERED_RETIREMENT_INCOME_FUND | REGISTERED_RETIREMENT_INCOME_FUND_RIF |
SPOUSAL_RETIREMENT_INCOME_FUND | SPOUSAL_RETIREMENT_INCOME_FUND_SRIF |
LOCKED_IN_REGISTERED_INVESTMENT_FUND | LOCKED_IN_REGISTERED_INVESTMENT_FUND_LRIF |
PRESCRIBED_REGISTERED_RETIREMENT_INCOME_FUND | PRESCRIBED_REGISTERED_RETIREMENT_INCOME_FUND_PRIF |
GUARANTEED_INVESTMENT_CERTIFICATES | GUARANTEED_INVESTMENT_CERTIFICATES_GIC |
REGISTERED_DISABILITY_SAVINGS_PLAN | 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 | |
PENSION_PLAN | |
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 |