{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"c07784f2-b5c0-4d87-9331-443ec2b85bc9","name":"Account Aggregation Quickstart","description":"[register]: https://developer.yodlee.com/user/register\n[dashboard]: https://developer.yodlee.com/user/me/dashboard\n[testAccounts]: https://developer.yodlee.com/user/me/dashboard/sandbox#edit-environment-accounts\n\nThis Quickstart Guide will show the basics of performing data aggregation using Yodlee.\n\n[Account Aggregation](https://developer.yodlee.com/solutions/account-aggregation) can help provide a global financial picture, monitor cash flow, track expense categories, and more.\n\nAccount Aggregation simply means getting information from all of an end user's financial accounts. For instance, if a user has checking and savings through one bank, a credit card from another, and stocks in a brokerage, aggregation will allow you to access all that data consolidated through one API. This includes information like balances, transaction information, expense categories, and more.\n\nIn this guide, we'll walk through all the steps needed to achieve complete flows for account aggregation.\n\nWe'll also provide some other steps you can try out to dig deeper into the Yodlee API.\n\n# How to Use This Guide\n\n## Background\n\nThere's a few things you should know before beginning. This guide assumes you'll be working in the [Yodlee Sandbox environment](https://developer.yodlee.com/docs/yodlee-environments-cc).\n\nThe Sandbox environment is available free once you [register][register] for a developer account.\n\nSandbox comes enabled with 5 preconfigured users. It does not allow you to register new users. It is also restricted to using dummy data, for security reasons. Once you're comfortable and want to work without these restrictions, we recommend moving to the free [Launch Tier](https://developer.yodlee.com/pricing).\n\n## Key Terms\n\n**Users** - End users of your application. In other words, your customers. \n**Providers** - Data providers. The financial institutions, like banks, credit card companies, and so on. \n**Provider accounts** - This refers to the accounts your users use to access their provider information. For example, if a bank has a web portal, your user has to login to an account to use it. \n**Accounts** - This refers to your users' accounts held by a provider, like a checking or savings account. \n**FastLink** - You need to connect or \"link\" your users to the accounts they hold. \n FastLink is an embeddable Yodlee tool designed to make this easy.\n\nA quick word about accounts. Typically you'll be working with three different kinds:\n\n* **Provider accounts**. These are the accounts your user, and, through Yodlee, you use to access banking, investment, and other financial services provider information.\n* **Financial accounts**. These are the traditional accounts like checking, savings, credit card, loan accounts, and so on.\n* **Application accounts**. These are the accounts you create to track and provide services to your customers.\n \n\n## Prerequisites\n\nTo complete this guide, you'll need to\n\n* [Register][register] for a developer account.\n* Get your credentials from your [API dashboard][dashboard].\n* Pick one of the 5 [pre-registered test users][testAccounts] to work with.\n \n\n## Postman\n\nMost likely you've arrived at the [web version](https://www.postman.com/yodleedevex/workspace/envestnet-yodlee-s-workspace/documentation/2196203-c07784f2-b5c0-4d87-9331-443ec2b85bc9) of this guide first. We created it using [Postman](https://www.postman.com/), a powerful tool for working with APIs, in the form of a [Postman Collection](https://www.postman.com/collection/).\n\nYou can load this collection into the Postman stand-alone tool and follow along making real API calls. [Download](https://www.postman.com/downloads/)/open Postman first. Then, look for the \"Run in Postman\" button at the top of this page. Clicking that should allow you to load the collection directly.\n\nFrom here on we'll assume you're working in Postman itself.\n\nPostman lets you save entries you need for API calls for easy reference. This is done with a [Postman Environment](https://learning.postman.com/docs/postman/variables-and-environments/managing-environments/).\n\nPostman can automatically substitute in parameters for API calls from values kept in a Postman environment. This collection comes with an environment preconfigured with several entries. Working with the examples will be easiest if you fill in the appropriate values for these entries first.\n\nFirst, in the upper right corner to the left of the eye icon, you will see a drop down to select your environment. Ensure that \"Account Aggregation Quickstart\" is selected from the drop down. Next, click on the eye icon in the upper right area of the Postman app window to open the editor and enter the values.\n\n* **userName** - For Sandbox you can copy/paste one of the test users from your [dashboard][dashboard]. **Please Note:** Do not use the Admin Account from your Sandbox Dashboard. You must use a test user for proper authentication in the sandbox.\n* **clientId** - Copy/paste your `clientId` from your [dashboard][dashboard].\n* **secret** - Copy/paste your `secret` from your [dashboard][dashboard].\n \n\n**❗ Note: The Postman environment API URLs are set by default to the correct values for the United States. If you're a customer in another region, be sure to copy/paste the appropriate URLs from your** [**dashboard**][dashboard] **into your environment.**\n\nSee the [Postman website](https://www.postman.com/) or the [Postman card](https://developer.yodlee.com/tools#CodingTools) on the Yodlee developer portal for more details. Click on the image below for a quick visual tour of Postman.\n\n> \n> \n>

Click image to enlarge

\n\nPay attention to any Pre-request Script errors and the Test Results tab as you use this collection. There are many guards in place to catch common mistakes.\n\n# Diving in\n\nIt is important that you follow the guide in order. The first flow will walk through the process of aggregating a set of accounts for the first time.\n\nThe second flow helps you refresh the data that you created in the first flow.","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"2196203","collectionId":"c07784f2-b5c0-4d87-9331-443ec2b85bc9","publishedId":"UVyrUbjc","public":true,"publicUrl":"https://documenter-api.postman.tech/view/2196203/UVyrUbjc","privateUrl":"https://go.postman.co/documentation/2196203-c07784f2-b5c0-4d87-9331-443ec2b85bc9","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"0074BD"},"documentationLayout":"classic-single-column","customisation":null,"version":"8.10.1","publishDate":"2022-07-14T18:00:18.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{},"logos":{}},"statusCode":200},"environments":[{"name":"Account Aggregation Quickstart","id":"ad66779a-84d2-47ca-a1f1-9cc5ff7bcc30","owner":"2196203","values":[{"key":"url","value":"https://sandbox.api.yodlee.com/ysl","enabled":true},{"key":"userName","value":"From your dashboard (Sandbox only)","enabled":true},{"key":"clientId","value":"Your client ID","enabled":true},{"key":"secret","value":"Your secret","enabled":true},{"key":"token","value":"A generated token","enabled":true},{"key":"providerId","value":"16441","enabled":true},{"key":"providerAccountId","value":"","enabled":true},{"key":"accountId","value":"","enabled":true},{"key":"requestId","value":"","enabled":true},{"key":"issuerId","value":"Your issuerId (JWT auth only)","enabled":true},{"key":"privateKey","value":"Your private key (JWT auth only)","enabled":true},{"key":"dataset","value":"","enabled":true},{"key":"loginForm","value":"","enabled":true},{"key":"16441_0_Username","value":"","enabled":true},{"key":"16441_0_Password","value":"","enabled":true},{"key":"providerAccountIds","value":"","enabled":true,"type":"any"}],"published":true}],"user":{"authenticated":false,"permissions":{"publish":false}},"run":{"button":{"js":"https://run.pstmn.io/button.js","css":"https://run.pstmn.io/button.css"}},"web":"https://www.getpostman.com/","team":{"logo":"https://res.cloudinary.com/postman/image/upload/t_team_logo_pubdoc/v1/team/768118b36f06c94b0306958b980558e6915839447e859fe16906e29d683976f0","favicon":""},"isEnvFetchError":false,"languages":"[{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"HttpClient\"},{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"RestSharp\"},{\"key\":\"curl\",\"label\":\"cURL\",\"variant\":\"cURL\"},{\"key\":\"dart\",\"label\":\"Dart\",\"variant\":\"http\"},{\"key\":\"go\",\"label\":\"Go\",\"variant\":\"Native\"},{\"key\":\"http\",\"label\":\"HTTP\",\"variant\":\"HTTP\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"OkHttp\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"Unirest\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"Fetch\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"jQuery\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"XHR\"},{\"key\":\"c\",\"label\":\"C\",\"variant\":\"libcurl\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Axios\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Native\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Request\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Unirest\"},{\"key\":\"objective-c\",\"label\":\"Objective-C\",\"variant\":\"NSURLSession\"},{\"key\":\"ocaml\",\"label\":\"OCaml\",\"variant\":\"Cohttp\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"cURL\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"Guzzle\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"HTTP_Request2\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"pecl_http\"},{\"key\":\"powershell\",\"label\":\"PowerShell\",\"variant\":\"RestMethod\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"http.client\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"Requests\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"httr\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"RCurl\"},{\"key\":\"ruby\",\"label\":\"Ruby\",\"variant\":\"Net::HTTP\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"Httpie\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"wget\"},{\"key\":\"swift\",\"label\":\"Swift\",\"variant\":\"URLSession\"}]","languageSettings":[{"key":"csharp","label":"C#","variant":"HttpClient"},{"key":"csharp","label":"C#","variant":"RestSharp"},{"key":"curl","label":"cURL","variant":"cURL"},{"key":"dart","label":"Dart","variant":"http"},{"key":"go","label":"Go","variant":"Native"},{"key":"http","label":"HTTP","variant":"HTTP"},{"key":"java","label":"Java","variant":"OkHttp"},{"key":"java","label":"Java","variant":"Unirest"},{"key":"javascript","label":"JavaScript","variant":"Fetch"},{"key":"javascript","label":"JavaScript","variant":"jQuery"},{"key":"javascript","label":"JavaScript","variant":"XHR"},{"key":"c","label":"C","variant":"libcurl"},{"key":"nodejs","label":"NodeJs","variant":"Axios"},{"key":"nodejs","label":"NodeJs","variant":"Native"},{"key":"nodejs","label":"NodeJs","variant":"Request"},{"key":"nodejs","label":"NodeJs","variant":"Unirest"},{"key":"objective-c","label":"Objective-C","variant":"NSURLSession"},{"key":"ocaml","label":"OCaml","variant":"Cohttp"},{"key":"php","label":"PHP","variant":"cURL"},{"key":"php","label":"PHP","variant":"Guzzle"},{"key":"php","label":"PHP","variant":"HTTP_Request2"},{"key":"php","label":"PHP","variant":"pecl_http"},{"key":"powershell","label":"PowerShell","variant":"RestMethod"},{"key":"python","label":"Python","variant":"http.client"},{"key":"python","label":"Python","variant":"Requests"},{"key":"r","label":"R","variant":"httr"},{"key":"r","label":"R","variant":"RCurl"},{"key":"ruby","label":"Ruby","variant":"Net::HTTP"},{"key":"shell","label":"Shell","variant":"Httpie"},{"key":"shell","label":"Shell","variant":"wget"},{"key":"swift","label":"Swift","variant":"URLSession"}],"languageOptions":[{"label":"C# - HttpClient","value":"csharp - HttpClient - C#"},{"label":"C# - RestSharp","value":"csharp - RestSharp - C#"},{"label":"cURL - cURL","value":"curl - cURL - cURL"},{"label":"Dart - http","value":"dart - http - Dart"},{"label":"Go - Native","value":"go - Native - Go"},{"label":"HTTP - HTTP","value":"http - HTTP - HTTP"},{"label":"Java - OkHttp","value":"java - OkHttp - Java"},{"label":"Java - Unirest","value":"java - Unirest - Java"},{"label":"JavaScript - Fetch","value":"javascript - Fetch - JavaScript"},{"label":"JavaScript - jQuery","value":"javascript - jQuery - JavaScript"},{"label":"JavaScript - XHR","value":"javascript - XHR - JavaScript"},{"label":"C - libcurl","value":"c - libcurl - C"},{"label":"NodeJs - Axios","value":"nodejs - Axios - NodeJs"},{"label":"NodeJs - Native","value":"nodejs - Native - NodeJs"},{"label":"NodeJs - Request","value":"nodejs - Request - NodeJs"},{"label":"NodeJs - Unirest","value":"nodejs - Unirest - NodeJs"},{"label":"Objective-C - NSURLSession","value":"objective-c - NSURLSession - Objective-C"},{"label":"OCaml - Cohttp","value":"ocaml - Cohttp - OCaml"},{"label":"PHP - cURL","value":"php - cURL - PHP"},{"label":"PHP - Guzzle","value":"php - Guzzle - PHP"},{"label":"PHP - HTTP_Request2","value":"php - HTTP_Request2 - PHP"},{"label":"PHP - pecl_http","value":"php - pecl_http - PHP"},{"label":"PowerShell - RestMethod","value":"powershell - RestMethod - PowerShell"},{"label":"Python - http.client","value":"python - http.client - Python"},{"label":"Python - Requests","value":"python - Requests - Python"},{"label":"R - httr","value":"r - httr - R"},{"label":"R - RCurl","value":"r - RCurl - R"},{"label":"Ruby - Net::HTTP","value":"ruby - Net::HTTP - Ruby"},{"label":"Shell - Httpie","value":"shell - Httpie - Shell"},{"label":"Shell - wget","value":"shell - wget - Shell"},{"label":"Swift - URLSession","value":"swift - URLSession - Swift"}],"layoutOptions":[{"value":"classic-single-column","label":"Single Column"},{"value":"classic-double-column","label":"Double Column"}],"versionOptions":[],"environmentOptions":[{"value":"0","label":"No Environment"},{"label":"Account Aggregation Quickstart","value":"2196203-ad66779a-84d2-47ca-a1f1-9cc5ff7bcc30"}],"canonicalUrl":"https://documenter.gw.postman.com/view/metadata/UVyrUbjc"}