This page refers to Yodlee API v1.0. The latest API version's documentation is available here.
Entity: user
| Attribute Name | Type | Description | Endpoints |
|---|---|---|---|
| id | long | The unique identifier of a consumer/user in Yodlee system for whom the API services would be accessed for. | POST user/login POST user/samlRegister POST user/samlLogin POST user/register GET user |
| loginName | string | The login name of the user used for authentication.This has to be provided as an input to the POST user/login service. | POST user/login POST user/samlRegister POST user/samlLogin POST user/register GET user/credentials/token GET user |
| string | The email address of the user. | GET user | |
| name | name | First, middle and last names of the user. | POST user/login POST user/samlRegister POST user/samlLogin POST user/register GET user |
| address | address | The address of the user. | GET user |
| preferences | entity[] | Preferences of the user to be respected in the data provided through various API services. | POST user/login POST user/samlRegister POST user/samlLogin POST user/register GET user |
| session | entity | Session token of the user using which other services are invoked in the system. | POST user/login POST user/samlRegister POST user/samlLogin POST user/register |
| accessTokens | entity | Token used to access the widgets hosted by Yodlee. | GET user/accessTokens |
| token | string | Token generated to reset the password of the user. | GET user/credentials/token |
| validUntil | dateTime | The date time till which the token generated is valid. | GET user/credentials/token |
Entity: preferences
| Attribute Name | Type | Description | Endpoints |
|---|---|---|---|
| Currency | string | The currency of the user. This currency will be respected while providing the response for derived API services.
Valid Value: Currency
|
GET user POST user/login POST user/samlRegister POST user/samlLogin POST user/register |
| locale | string | The locale of the user. This locale will be considered for localization features like providing the provider information in the supported locale or providing category names in the transaction related services. | GET user POST user/login POST user/samlRegister POST user/samlLogin POST user/register |
| timeZone | string | The timezone of the user. This attribute is just a place holder and has no impact on any other API services. | GET user POST user/login POST user/samlRegister POST user/samlLogin POST user/register |
| dateFormat | string | The dateformat of the user.This attribute is just a place holder and has no impact on any other API services. | GET user POST user/login POST user/samlRegister POST user/samlLogin POST user/register |
Entity: session
| Attribute Name | Type | Description | Endpoints |
|---|---|---|---|
| userSession | string | Session provided for a valid user to access API services upon successful authentication. | POST user/login POST user/samlRegister POST user/samlLogin POST user/register |
Entity: accessTokens
| Attribute Name | Type | Description | Endpoints |
|---|---|---|---|
| appId | string | The identifier of the application for which the access token is generated. | GET user/accessTokens |
| value | string | Access token value used to invoke the widgets/apps. | GET user/accessTokens |
| url | string | Base URL using which the application is accessed. | GET user/accessTokens |
Enums: Currency
| Currency | Description |
|---|---|
| AUD | Australia Dollar |
| BRL | Brazil Real |
| CAD | Canada Dollar |
| EUR | Euro Member Countries |
| GBP | United Kingdom Pound |
| HKD | Hong Kong Dollar |
| IDR | Indonesia Rupiah |
| INR | India Rupee |
| JPY | Japan Yen |
| NZD | New Zealand Dollar |
| SGD | Singapore Dollar |
| USD | United States Dollar |
| ZAR | South Africa Rand |
| CNY | China Yuan Renminbi |
| VND | Viet Nam Dong |