Yodlee

Get Yodlee Users

TODO

SecuritybearerAuth
Request
header Parameters
access_token
required
string

Access token for authorization

Responses
200

User information retrieved successfully

401

Unauthorized

get/v1/yodlee/user
Response samples
application/json
{
  • "user": {
    }
}

Register a Yodlee User

TODO

SecuritybearerAuth
Request
header Parameters
access_token
required
string

Access token for authorization

Request Body schema: application/json
required
object
Responses
200

User registered successfully

400

Bad request

post/v1/yodlee/user/register
Request samples
application/json
{
  • "user": {
    }
}
Response samples
application/json
{
  • "user": {
    }
}

Unregister a user

SecuritybearerAuth
Request
header Parameters
access_token
required
string

Access token for authorization

Responses
204

User unregistered successfully

delete/v1/yodlee/user/unregister

Get provider accounts

SecuritybearerAuth
Request
query Parameters
includes
string

Includes additional data in the response

providerIds
string

Filter the response by provider IDs

header Parameters
access_token
required
string

Access token for authorization

Responses
200

List of provider accounts

get/v1/yodlee/providerAccounts
Response samples
application/json
{
  • "providerAccount": [
    ]
}

Get Providers

SecuritybearerAuth
Request
query Parameters
capability
string

CHALLENGE_DEPOSIT_VERIFICATION - capability search is deprecated

institutionId
integer <int64>

Institution Id for Single site selection

name
string

Name in minimum 1 character or routing number.

priority
string

Search priority

providerId
string

Max 5 Comma seperated Provider Ids

skip
integer <int32>

skip (Min 0) - This is not applicable along with 'name' parameter.

top
integer <int32>

top (Max 500) - This is not applicable along with 'name' parameter.

Responses
200

OK

400


Y800 : Invalid value for priority
Y800 : Invalid value for providerName
Y801 : Invalid length for a site search. The search string must have atleast 1 character
Y800 : Invalid value for skip
Y804 : Permitted values of top between 1 - 500
Y821 : Dataset not supported
Y820 : The additionalDataSet is not supported for Get provider API

401

Unauthorized

404

Not Found

get/v1/yodlee/providers
Response samples
application/json;charset=UTF-8
{
  • "languageISOCode": "string",
  • "forgetPasswordUrl": "string",
  • "favicon": "string",
  • "accountType": [
    ],
  • "countryISOCode": "string",
  • "isAddedByUser": "string",
  • "PRIORITY": "POPULAR",
  • "associatedProviderIds": [
    ],
  • "loginHelp": "string",
  • "primaryLanguageISOCode": "string",
  • "help": "string",
  • "baseUrl": "string",
  • "capability": [
    ],
  • "isConsentRequired": true,
  • "loginUrl": "string",
  • "isAutoRefreshEnabled": true,
  • "name": "string",
  • "logo": "string",
  • "id": 0,
  • "lastModified": "string",
  • "authParameter": [
    ],
  • "authType": "OAUTH",
  • "status": "Supported"
}

Get Provider Details

The get provider detail service is used to get detailed information including the login form for a provider.

SecuritybearerAuth
Request
path Parameters
providerId
required
integer <int64>

providerId

Responses
200

OK

get/v1/yodlee/providers/{providerId}
Response samples
application/json;charset=UTF-8
[
  • {
    }
]

Create a new account

SecuritybearerAuth
Request
header Parameters
access_token
required
string

Access token for authorization

Request Body schema: application/json
required
object
Responses
200

Account created successfully

post/v1/yodlee/accounts
Request samples
application/json
{
  • "account": {
    }
}
Response samples
application/json
{
  • "account": [
    ]
}

Retrieve accounts information

SecuritybearerAuth
Request
header Parameters
access_token
required
string

Access token for authorization

Request Body schema: application/json
required
object
Responses
200

List of accounts retrieved successfully

get/v1/yodlee/accounts
Request samples
application/json
{
  • "user": {
    }
}
Response samples
application/json
{
  • "account": [
    ]
}

Get Yodlee Account by ID

TODO

SecuritybearerAuth
Request
header Parameters
access_token
required
string

Access token for authorization

Responses
200

List of accounts retrieved successfully

get/v1/yodlee/accounts/{accountId}
Response samples
application/json
{
  • "account": [
    ]
}

Get Historical Balances

The historical balances service is used to retrieve the historical balances for an account or a user. Historical balances are daily (D), weekly (W), and monthly (M). The interval input should be passed as D, W, and M to retrieve the desired historical balances. The default interval is daily (D). When no account id is provided, historical balances of the accounts that are active, to be closed, and closed are provided in the response. If the fromDate and toDate are not passed, the last 90 days of data will be provided. The fromDate and toDate should be passed in the YYYY-MM-DD format. The date field in the response denotes the date for which the balance is requested. includeCF needs to be sent as true if the customer wants to return carried forward balances for a date when the data is not available. asofDate field in the response denotes the date as of which the balance was updated for that account. When there is no balance available for a requested date and if includeCF is sent as true, the previous date for which the balance is available is provided in the response. When there is no previous balance available, no data will be sent. By default, pagination is available for the historicalBalances entity in this API. The 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. The API will only retrieve a maximum 500 records by default when values for skip and top parameters are not provided.

SecuritybearerAuth
Request
query Parameters
accountId
string

The unique identifier of the account

fromDate
string <date>

The start date for retrieving historical balances

toDate
string <date>

The end date for retrieving historical balances

interval
string

The interval for historical balances (D for daily, W for weekly, M for monthly)

includeCF
boolean

A boolean to include cash flow in the response

skip
integer

The number of records to skip for pagination

top
integer

The number of records to return for pagination

header Parameters
access_token
required
string

Access token for user authorization

Responses
200

Historical balances retrieved successfully

get/v1/yodlee/accounts/historicalBalances
Response samples
application/json
{
  • "account": [
    ]
}

Get Yodlee Transactions

TODO

SecuritybearerAuth
Request
query Parameters
accountId
string

Comma separated accountIds

baseType
string

DEBIT/CREDIT

categoryId
string

Comma separated categoryIds

categoryType
string

Transaction Category Type(UNCATEGORIZE, INCOME, TRANSFER, EXPENSE or DEFERRED_COMPENSATION)

container
string

bank/creditCard/investment/insurance/loan

detailCategoryId
string

Comma separated detailCategoryIds

fromDate
string <date>

Transaction from date(YYYY-MM-DD)

highLevelCategoryId
string

Comma separated highLevelCategoryIds

keyword
string

Transaction search text

skip
integer >= 0

skip (Min 0)

toDate
string <date>

Transaction end date(YYYY-MM-DD)

top
integer <= 500

top (Max 500)

type
string

Transaction Type(SELL,SWEEP, etc.)

header Parameters
access_token
required
string

Like Yodlee, LinkMoney API enables placing the access_token in either the body or the header of requests. The access_token should be user-specific to retrieve information for a single individual.

Responses
200

Historical balances retrieved successfully

get/v1/yodlee/transactions
Response samples
application/json
{
  • "transaction": [
    ]
}

Update a specific transaction

Updates the details of a specific transaction using its transaction ID.

SecuritybearerAuth
Request
path Parameters
transactionId
required
string

The unique identifier for a transaction.

header Parameters
access_token
required
string

Access token for authorization

Content-Type
required
string
Default: application/json

Must be application/json

Authorization
required
string

Bearer token for authorization

Request Body schema: application/json
optional
object
Responses
204

Transaction updated successfully, no content returned.

put/v1/yodlee/transactions/{transactionId}
Request samples
application/json
{
  • "transaction": {
    }
}

Get the count of transactions

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.

SecuritybearerAuth
Request
query Parameters
accountId
string

Comma separated accountIds.

baseType
string

DEBIT/CREDIT indicating the base type of the transaction.

categoryId
string

Comma separated categoryIds.

categoryType
string

Transaction Category Type(UNCATEGORIZE, INCOME, TRANSFER, EXPENSE or DEFERRED_COMPENSATION).

container
string

bank/creditCard/investment/insurance/loan.

detailCategoryId
string

Comma separated detailCategoryIds.

fromDate
string <date>

Transaction from date(YYYY-MM-DD).

highLevelCategoryId
string

Comma separated highLevelCategoryIds.

keyword
string

Transaction search text.

toDate
string <date>

Transaction end date(YYYY-MM-DD).

type
string

Transaction Type(SELL, SWEEP, etc.).

header Parameters
access_token
required
string

Access token for authorization

Responses
200

Successfully retrieved the count of transactions

get/v1/yodlee/transactions/count
Response samples
application/json
{
  • "transaction": {
    }
}

Get Provider Account Details

The get provider account details service is used to learn the status of adding accounts and updating accounts.

SecuritybearerAuth
Request
path Parameters
providerAccountId
required
integer <int64>

providerAccountId

query Parameters
include
string

include credentials,questions

requestId
string

The unique identifier for the request that returns contextual data

Responses
200

OK

400

Y800 : Invalid value for providerAccountId

401

Unauthorized

404

Not Found

get/v1/yodlee/providerAccounts/{providerAccountId}
Response samples
application/json;charset=UTF-8
{
  • "providerAccount": [
    ]
}

Get Holdings

SecuritybearerAuth
Request
query Parameters
accountId
string

Comma separated accountId

assetClassification.classificationType
string

e.g. Country, Sector, etc.

classificationValue
string

e.g. US

include
string

assetClassification

providerAccountId
string

providerAccountId

Responses
200

OK

400

Y800 : Invalid value for accountId

401

Unauthorized

404

Not Found

get/v1/yodlee/holdings
Response samples
application/json;charset=UTF-8
{
  • "holding": [
    ]
}

Get Security Details

The get security details service is used to get all the security information for the holdings

SecuritybearerAuth
Request
query Parameters
holdingId
string

Comma separated holdingId

Responses
200

OK

400

Y800 : Invalid value for holdingId
Y824 : The maximum number of holdingIds permitted is 100

401

Unauthorized

404

Not Found

get/v1/yodlee/holdings/securities
Response samples
application/json;charset=UTF-8
{
  • "holding": [
    ]
}

Retrieve verified accounts

Retrieves a list of accounts that have been verified.

SecuritybearerAuth
Request
query Parameters
accountId
string

Comma separated accountIds.

isSelected
string

Comma separated isSelected. Allowed values are true, false. Default is true if no value is passed.

providerAccountId
required
string

providerAccountId.

verificationStatus
string

Comma separated verificationStatus. Allowed values are SUCCESS, FAILED. Default is SUCCESS if no value is passed.

header Parameters
Content-Type
required
string
Default: application/json
Authorization
required
string

Bearer token for accessing the API.

Responses
200

A list of verified accounts.

get/v1/yodlee/verification/verifiedAccounts
Response samples
application/json
{
  • "requestId": "string",
  • "requestDate": "string",
  • "state": "string",
  • "verifiedAccount": [
    ],
  • "failedReason": "string"
}

Retrieve verification information

Retrieves verification information for accounts.

SecuritybearerAuth
Request
query Parameters
accountId
string

Comma-separated accountIds.

providerAccountId
string

ProviderAccountId.

verificationType
string

VerificationType.

header Parameters
Content-Type
required
string
Default: application/json
Authorization
required
string

Bearer token for accessing Yodlee's API.

Responses
200

A list of verification information.

get/v1/yodlee/verification
Response samples
application/json
{
  • "verification": [
    ]
}