Yodlee Core APIs

Get Transactions The Transaction service is used to get a list of transactions for a user.By default, this service returns the last 30 days of transactions from today's date.The keyword parameter performs a contains search on the original, consumer, and simple description attributes, replace the special characters #, &, and + with percent-encoding values %23, %26, and %2B respectively. Eg: for -Debit# , pass the input as -Debit%23.Values for categoryId parameter can be fetched from get transaction category list service. The categoryId is used to filter transactions based on system-defined category as well as user-defined category.User-defined categoryIds should be provided in the filter with the prefix ''U''. E.g. U10002The skip and top parameters are used for pagination. In the skip and top parameters pass the number of records to be skipped and retrieved, respectively. The response header provides the links to retrieve the next and previous set of transactions.Double quotes in the merchant name will be prefixed by backslashes (\) in the response, e.g. Toys "R" Us. sourceId is a unique ID that the provider site has assigned to the transaction. The source ID is only available for the pre-populated accounts. Pre-populated accounts are the accounts that the FI customers shares with Yodlee, so that the user does not have to add or aggregate those accounts.Note TDE is made available for bank and card accounts and for the US market only.The address field in the response is available only when the TDE key is turned on.The pagination feature is available by default. If no values are passed in the skip and top parameters, the API will only return the first 500 transactions.This service supports the localization feature and accepts locale as a header parameter.

Get Transactions Count The count service provides the total number of transactions for a specific user depending on the input parameters passed.If you are implementing pagination for transactions, call this endpoint before calling GET /transactions to know the number of transactions that are returned for the input parameters passed.The functionality of the input parameters remains the same as that of the GET /transactions endpoint.

Get User Details The get user details service is used to get the user profile information and the application preferences set at the time of user registration.

Get Verification Status The get verification status service is used to retrieve the verification status of all accounts for which the MS or CDV process has been initiated.For the MS process, the account details object returns the aggregated information of the verified accounts. For the CDV process, the account details object returns the user provided account information.

Verify Accounts Using Transactions The verify account service is used to verify the account's ownership by matching the transaction details with the accounts aggregated for the user.If a match is identified, the service returns details of all the accounts along with the matched transaction's details.If no transaction match is found, an empty response will be returned.A maximum of 5 transactionCriteria can be passed in a request.The baseType, date, and amount parameters should mandatorily be passed.The optional dateVariance parameter cannot be more than 7 days. For example, +7, -4, or +/-2.Pass the container or accountId parameters for better performance.This service supports the localization feature and accepts locale as a header parameter.

Initiaite Matching Service and Challenge Deposit The post verification service is used to initiate the matching service (MS) and the challenge deposit account verification (CDV) process to verify account ownership.The MS and CDV process can verify ownership of only bank accounts (i.e., checking and savings).The MS verification can be initiated only for an already aggregated account or a providerAccount.The prerequisite for the MS verification process is to request the ACCT_PROFILE dataset with the HOLDER_NAME attribute.In the MS verification process, a string-match of the account holder name with the registered user name is performed instantaneously. You can contact the Yodlee CustomerCare to configure the full name or only the last name match.Once the CDV process is initiated Yodlee will post the microtransaction (i.e., credit and debit) in the user's account. The CDV process takes 2 to 3 days to complete as it requires the user to provide the microtransaction details.The CDV process is currently supported only in the United States.The verificationId in the response can be used to track the verification request.Notes:This endpoint cannot be used to test the CDV functionality in the developer sandbox or test environment. You will need a money transmitter license to implement the CDV functionality and also require the Yodlee Professional Services team's assistance to set up a dedicated environment.

Register User The register user service is used to register a user in Yodlee.The loginName cannot include spaces and must be between 3 and 150 characters.locale passed must be one of the supported locales for the customer. Currency provided in the input will be respected in the derived services and the amount fields in the response will be provided in the preferred currency.userParam is accepted as a body parameter. Note: The content type has to be passed as application/json for the body parameter.

Run Transaction Categorization Rule The run transaction categorization rule service is used to run a rule on transactions, to categorize the transactions.The HTTP response code is 204 (Success with no content).

Saml Login The SAML login service is used to authenticate system users with a SAML response.A new user will be created with the input provided if that user isn't already in the system.For existing users, the system will make updates based on changes or new information.When authentication is successful, a user session token is returned.Note: The content type has to be passed as application/x-www-form-urlencoded. issuer, source and samlResponse should be passed as body parameters.

Delete User The delete user service is used to delete or unregister a user from Yodlee. Once deleted, the information related to the users cannot be retrieved. The HTTP response code is 204 (Success without content)

Update Account The update account service is used to update manual and aggregated accounts.The HTTP response code is 204 (Success without content).Update manual account support is available for bank, card, investment, insurance, loan, otherAssets, otherLiabilities and realEstate containers only.Note: A real estate account update is only supported for SYSTEM and MANUAL valuation type. Attribute isEbillEnrolled is deprecated as it is applicable for bill accounts only.

Update Preferences This endpoint is used to update preferences like data extracts and auto refreshes without triggering refresh for the providerAccount.Setting isDataExtractsEnabled to false will not trigger data extracts notification and dataExtracts/events will not reflect any data change that is happening for the providerAccount.Modified data will not be provided in the dataExtracts/userData endpoint.Setting isAutoRefreshEnabled to false will not trigger auto refreshes for the provider account.

Update Subscription Refer PUT /configs/notifications/events/{eventName}.The update events service is used to update the callback URL.If the callback URL is invalid or inaccessible, the subscription will be unsuccessful, and an error will be thrown.Note: The content type has to be passed as application/json for the body parameter.

Update Notification Subscription The update events service is used to update the callback URL.If the callback URL is invalid or inaccessible, the subscription will be unsuccessful, and an error will be thrown.Note: The content type has to be passed as application/json for the body parameter.

Update Transaction The update transaction service is used to update the category,consumer description, memo for a transaction.The HTTP response code is 204 (Success without content).

Update Transaction Categorization Rule The update transaction categorization rule service is used to update a categorization rule for both system-defined category as well as user-defined category.ruleParam JSON input should be as explained in the create transaction categorization rule service.The HTTP response code is 204 (Success without content).

Update Category The update transaction categories service is used to update the transaction category namefor a high level category, a system-defined category and a user-defined category.The renamed category can be set back to the original name by passing an empty string for categoryName.The categoryName can accept minimum of 1, maximum of 50 alphanumeric or special characters.The HTTP response code is 204 (Success without content).

Update User Details The update user details service is used to update user details like name, address, currency preference, etc.Currency provided in the input will be respected in the derived services and the amount fields in the response will be provided in the preferred currency.The HTTP response code is 204 (Success without content).

User Logout Deprecated: This endpoint is deprecated for API Key-based authentication. The user logout service allows the user to log out of the application.The service does not return a response body. The HTTP response code is 204 (Success with no content).

Verify Challenge Deposit The put verification service is used to complete the challenge deposit verification (CDV) process.This service is used only by the customer of CDV flow.In the CDV process, the user-provided microtransaction details (i.e., credit and debit) is matched against the microtransactions posted by Yodlee. For a successful verification of the account's ownership both the microtransaction details should match.The CDV process is currently supported only in the United States.Notes:This endpoint cannot be used to test the CDV functionality in the developer sandbox or test environment. You will need a money transmitter license to implement the CDV functionality and also require the Yodlee Professional Services team's assistance to set up a dedicated environment.