Yodlee
App · 25 actions
Work with your customers' bank data in Envestnet | Yodlee: register users, read accounts, balances, transactions, holdings and statements, recategorize transactions, refresh linked banks and total spending.
Actions
| Action | What it does |
|---|---|
| Add category | Add a category of the user's own under one of Yodlee's, such as 'Team lunches' under Restaurants. |
| Add manual account | Add an account the user keeps up to date by hand, such as cash or a loan from family, so it counts in their balances and net worth. |
| Count transactions | Count a user's transactions that match, the last 30 days unless you give dates. |
| Delete account | Delete one of a user's accounts and its transactions from Yodlee. |
| Delete category | Delete a category the user made. |
| Delete user | Delete a user from Yodlee, with every account and transaction Yodlee holds for them. |
| Get account | Get one of a user's accounts, with its balance and details. |
| Get balances over time | Get each of a user's accounts' balance by day, week or month. |
| Get linked institution | Get one of a user's linked institutions, with the status of its latest refresh. |
| Get net worth | Get a user's assets, liabilities and net worth, by day, week or month. |
| Get spending and income totals | Total a user's money in and out by category type, high-level category or category over a period. |
| Get user | Get a user's profile and preferences. |
| Get verified accounts | Get the accounts a user verified through Yodlee's account verification, with their numbers and balances, once verification has finished. |
| List accounts | List a user's accounts with their balances: bank, card, investment, loan and the rest, linked or added by hand. |
| List categories | List Yodlee's transaction categories, and a user's own when you name one. |
| List holdings | List the stocks, funds, bonds and other holdings in a user's investment accounts, with quantities and values. |
| List linked institutions | List the banks and other institutions a user has linked, with how each last refreshed. |
| List statements | List a user's credit card, loan and insurance statements, with amounts and due dates: the latest of each account unless you ask for past ones. |
| List transactions | List a user's transactions, the last 30 days unless you give dates, optionally for one account, category or search. |
| Recategorize transaction | Put a transaction in another category, and optionally add a memo to it. |
| Refresh accounts | Ask Yodlee to fetch the latest data from every institution a user has linked that can refresh now. |
| Register user | Register one of your customers with Yodlee, under a login name of your choosing, so you can link their banks and read their data. |
| Search institutions | Find banks and other institutions Yodlee can link, by name or by US or Canadian routing number. |
| Update account | Rename an account, set its nickname or memo, change a manual account's balance, or count it in or out of net worth. |
| Update user | Change a user's email, name, phone number or currency. |
Add category
Add a category of the user's own under one of Yodlee's, such as 'Team lunches' under Restaurants.
Inputs
- User
login_nametextRequired - The Yodlee user's login name, the one your app registered them with (in the sandbox, one of its test users).
- Under category
parent_category_idtextRequired - The Yodlee category the new one goes under.
- Name
category_nametextRequired - The new category's name, up to 50 characters.
Outputs
categoryobject- The new category
createdtrue/false- Whether it was added
Example output
{
"category": {
"category": "Team lunches",
"classification": "PERSONAL",
"defaultCategoryName": "Restaurants",
"highLevelCategoryId": 10000017,
"highLevelCategoryName": "Food and Dining",
"id": 10000123,
"source": "USER",
"type": "EXPENSE"
},
"created": true
}Add manual account
Add an account the user keeps up to date by hand, such as cash or a loan from family, so it counts in their balances and net worth.
Inputs
- User
login_nametextRequired - The Yodlee user's login name, the one your app registered them with (in the sandbox, one of its test users).
- Account name
account_nametextRequired - A name for the account.
- Account type
account_typetextRequired - What kind of account it is.One of:
CHECKING,SAVINGS,CD(Certificate of deposit),PREPAID,CREDIT(Credit card),PERSONAL_LOAN(Personal loan),HOME_LOAN(Home loan),INSURANCE,ANNUITY,BROKERAGE_CASH(Brokerage cash). - Balance
balancenumber - The account's balance, such as 1250.50.
- Currency
currencytext - The balance's currency. Defaults to US dollars.One of:
USD(US dollar (USD)),CAD(Canadian dollar (CAD)),EUR(Euro (EUR)),GBP(British pound (GBP)),AUD(Australian dollar (AUD)),NZD(New Zealand dollar (NZD)),INR(Indian rupee (INR)),ZAR(South African rand (ZAR)),SGD(Singapore dollar (SGD)),HKD(Hong Kong dollar (HKD)), and 4 more. - Account number
account_numbertext - The account's number, if it has one.
- Nickname
nicknametext - A short name for the account.
- Memo
memotext - A note about the account.
- Count toward net worth
include_in_net_worthtrue/false - Whether the account counts toward the user's net worth.
Outputs
accountobject- The new account
Example output
{
"account": {
"accountName": "Cash",
"accountNumber": "",
"id": 12345690
}
}Count transactions
Count a user's transactions that match, the last 30 days unless you give dates.
Inputs
- User
login_nametextRequired - The Yodlee user's login name, the one your app registered them with (in the sandbox, one of its test users).
- From
from_datedate - Only transactions on or after this day. Up to two years back.
- To
to_datedate - Only transactions on or before this day.
- Account
account_idtext - Only this account's transactions.
- Account kind
containertext - Only transactions in accounts of this kind. Leave empty for all.One of:
bank,creditCard(Credit card),investment,insurance,loan. - Money in or out
base_typetext - Only money in, or only money out. Leave empty for both.One of:
DEBIT(Money out (debit)),CREDIT(Money in (credit)). - Category
category_idtext - Only transactions in this category.
- Category type
category_typetext - Only transactions whose category is of this type.One of:
EXPENSE,INCOME,TRANSFER,LOAN,UNCATEGORIZE(Uncategorized),DEFERRED_COMPENSATION(Deferred compensation). - Search
keywordtext - Only transactions whose description contains this text.
Outputs
countnumber- How many match
Example output
{
"count": 128
}Delete account
Delete one of a user's accounts and its transactions from Yodlee.
Inputs
- User
login_nametextRequired - The Yodlee user's login name, the one your app registered them with (in the sandbox, one of its test users).
- Account
account_idtextRequired - The account. Pick one, or give its id.
Outputs
account_idnumber- The account deleted
deletedtrue/false- Whether it was deleted
Example output
{
"account_id": 12345690,
"deleted": true
}Delete category
Delete a category the user made. Its transactions go back to Yodlee's category.
Inputs
- User
login_nametextRequired - The Yodlee user's login name, the one your app registered them with (in the sandbox, one of its test users).
- Category
category_idtextRequired - The id of the user's own category, such as 'Add category' gave.
Outputs
category_idnumber- The category deleted
deletedtrue/false- Whether it was deleted
Example output
{
"category_id": 10000123,
"deleted": true
}Delete user
Delete a user from Yodlee, with every account and transaction Yodlee holds for them. This can't be undone.
Inputs
- User
login_nametextRequired - The Yodlee user's login name, the one your app registered them with (in the sandbox, one of its test users).
Outputs
deletedtrue/false- Whether it was deleted
login_nametext- The user deleted
Example output
{
"deleted": true,
"login_name": "customer-1042"
}Get account
Get one of a user's accounts, with its balance and details.
Inputs
- User
login_nametextRequired - The Yodlee user's login name, the one your app registered them with (in the sandbox, one of its test users).
- Account
account_idtextRequired - The account. Pick one, or give its id.
Outputs
accountobject- The account
Example output
{
"account": {
"CONTAINER": "bank",
"accountName": "Everyday Checking",
"accountNumber": "xxxx4321",
"accountStatus": "ACTIVE",
"accountType": "CHECKING",
"amountDue": {
"amount": 1250.5,
"currency": "USD"
},
"availableBalance": {
"amount": 1250.5,
"currency": "USD"
},
"availableCredit": {
"amount": 1250.5,
"currency": "USD"
},
"balance": {
"amount": 1250.5,
"currency": "USD"
},
"createdDate": "2026-01-05T10:00:00Z",
"currentBalance": {
"amount": 1250.5,
"currency": "USD"
},
"displayedName": "Jo Bloggs",
"dueDate": "2026-12-01",
"id": 12345678,
"includeInNetWorth": true,
"isAsset": true,
"isManual": false,
"lastUpdated": "2026-11-12T08:30:00Z",
"nickname": "Bills",
"providerAccountId": 11223344,
"providerId": "16441",
"providerName": "Dag Site",
"totalCreditLine": {
"amount": 1250.5,
"currency": "USD"
}
}
}Get balances over time
Get each of a user's accounts' balance by day, week or month.
Inputs
- User
login_nametextRequired - The Yodlee user's login name, the one your app registered them with (in the sandbox, one of its test users).
- Account
account_idtext - Only this account. Leave empty for all.
- From
from_datedate - The first day.
- To
to_datedate - The last day. It can't be in the future.
- Interval
intervaltext - One figure per day, week or month. Leave empty for Yodlee's default.One of:
D(Daily),W(Weekly),M(Monthly). - Fill in missing days
include_carry_forwardtrue/false - Turn on to repeat the last known balance on days Yodlee has none.
Outputs
accountslist- Each account with its balances
countnumber- How many there are
Example output
{
"accounts": [
{
"historicalBalances": [
{
"asOfDate": "2026-11-01",
"balance": {
"amount": 1250.5,
"currency": "USD"
},
"dataSourceType": "S",
"date": "2026-11-01",
"isAsset": true
}
],
"id": 12345678
}
],
"count": 1
}Get linked institution
Get one of a user's linked institutions, with the status of its latest refresh.
Inputs
- User
login_nametextRequired - The Yodlee user's login name, the one your app registered them with (in the sandbox, one of its test users).
- Linked institution
provider_account_idtextRequired - The linked institution. Pick one, or give its id.
Outputs
provider_accountobject- The linked institution
Example output
{
"provider_account": {
"aggregationSource": "USER",
"authType": "CREDENTIALS",
"createdDate": "2026-01-05",
"dataset": [
{
"additionalStatus": "AVAILABLE_DATA_RETRIEVED",
"lastUpdateAttempt": "2026-11-12T08:30:00Z",
"lastUpdated": "2026-11-12T08:30:00Z",
"name": "BASIC_AGG_DATA",
"nextUpdateScheduled": "2026-11-13T08:30:00Z",
"updateEligibility": "ALLOW_UPDATE"
}
],
"id": 11223344,
"isManual": false,
"lastUpdated": "2026-11-12T08:30:00Z",
"providerId": 16441,
"requestId": "REQUEST-1234",
"status": "SUCCESS"
}
}Get net worth
Get a user's assets, liabilities and net worth, by day, week or month.
Inputs
- User
login_nametextRequired - The Yodlee user's login name, the one your app registered them with (in the sandbox, one of its test users).
- From
from_datedate - The first day.
- To
to_datedate - The last day. It can't be in the future.
- Interval
intervaltext - One figure per day, week or month. Leave empty for Yodlee's default.One of:
D(Daily),W(Weekly),M(Monthly). - Account
account_idtext - Only this account.
- Account kind
containertext - Only accounts of this kind.One of:
bank,creditCard(Credit card),investment,insurance,loan,realEstate(Real estate),otherAssets(Other assets),otherLiabilities(Other liabilities).
Outputs
countnumber- How many there are
net_worthlist- Net worth for each date
Example output
{
"count": 1,
"net_worth": [
{
"asset": {
"amount": 25000.0,
"currency": "USD"
},
"date": "2026-11-01",
"liability": {
"amount": 8000.0,
"currency": "USD"
},
"networth": {
"amount": 17000.0,
"currency": "USD"
}
}
]
}Get spending and income totals
Total a user's money in and out by category type, high-level category or category over a period.
Inputs
- User
login_nametextRequired - The Yodlee user's login name, the one your app registered them with (in the sandbox, one of its test users).
- Total by
group_bytextRequired - What to total by.One of:
CATEGORY_TYPE(Category type),HIGH_LEVEL_CATEGORY(High-level category),CATEGORY. - Category type
category_typetext - Which category type to total. Needed unless totalling by category type.One of:
EXPENSE,INCOME,TRANSFER,LOAN,UNCATEGORIZE(Uncategorized),DEFERRED_COMPENSATION(Deferred compensation). - From
from_datedate - The first day.
- To
to_datedate - The last day.
- Interval
intervaltext - With details, one figure per day, week, month or year. Monthly unless you choose.One of:
D(Daily),W(Weekly),M(Monthly),Y(Yearly). - Account
account_idtext - Only this account.
- Include details
include_detailstrue/false - Turn on to get the totals for each interval as well.
Outputs
countnumber- How many there are
summarieslist- The totals
Example output
{
"count": 1,
"summaries": [
{
"categorySummary": [
{
"categoryId": 22,
"categoryName": "Restaurants",
"creditTotal": {
"amount": 0.0,
"currency": "USD"
},
"debitTotal": {
"amount": 310.2,
"currency": "USD"
}
}
],
"categoryType": "EXPENSE",
"creditTotal": {
"amount": 0.0,
"currency": "USD"
},
"debitTotal": {
"amount": 2310.55,
"currency": "USD"
}
}
]
}Get user
Get a user's profile and preferences.
Inputs
- User
login_nametextRequired - The Yodlee user's login name, the one your app registered them with (in the sandbox, one of its test users).
Outputs
userobject- The user
Example output
{
"user": {
"email": "jo@example.com",
"id": 10012345,
"loginName": "customer-1042",
"name": {
"first": "Jo",
"last": "Bloggs"
},
"phoneNumber": "+1-901-967-0100",
"preferences": {
"currency": "USD",
"dateFormat": "MM/dd/yyyy",
"locale": "en_US",
"timeZone": "PST"
},
"roleType": "INDIVIDUAL"
}
}Get verified accounts
Get the accounts a user verified through Yodlee's account verification, with their numbers and balances, once verification has finished.
Inputs
- User
login_nametextRequired - The Yodlee user's login name, the one your app registered them with (in the sandbox, one of its test users).
- Linked institution
provider_account_idtextRequired - The linked institution that was verified.
- Verification result
verification_statustext - Only accounts that passed, or only those that failed. Leave empty for those that passed.One of:
SUCCESS(Verified),FAILED.
Outputs
countnumber- How many there are
failed_reasontext- Why verification failed, if it did
request_datetext- When verification ran
statetext- COMPLETED or FAILED
verified_accountslist- The verified accounts
Example output
{
"count": 1,
"failed_reason": "",
"request_date": "2026-11-12T08:30:00Z",
"state": "COMPLETED",
"verified_accounts": [
{
"CONTAINER": "bank",
"accountId": 12345678,
"accountName": "Everyday Checking",
"accountNumber": "xxxx4321",
"accountType": "CHECKING",
"balance": {
"amount": 1250.5,
"currency": "USD"
},
"failedReason": "",
"isSelected": true,
"providerAccountId": 11223344,
"providerName": "Dag Site",
"verificationStatus": "SUCCESS"
}
]
}List accounts
List a user's accounts with their balances: bank, card, investment, loan and the rest, linked or added by hand.
Inputs
- User
login_nametextRequired - The Yodlee user's login name, the one your app registered them with (in the sandbox, one of its test users).
- Account kind
containertext - Only accounts of this kind. Leave empty for all.One of:
bank,creditCard(Credit card),investment,insurance,loan,reward,realEstate(Real estate),otherAssets(Other assets),otherLiabilities(Other liabilities). - Status
statuslist - Only accounts with these statuses. Leave empty for active and to-be-closed ones.One or more of:
ACTIVE,INACTIVE,TO_BE_CLOSED(To be closed),CLOSED. - Linked institution
provider_account_idtext - Only accounts from this linked institution.
Outputs
accountslist- The accounts
countnumber- How many there are
Example output
{
"accounts": [
{
"CONTAINER": "bank",
"accountName": "Everyday Checking",
"accountNumber": "xxxx4321",
"accountStatus": "ACTIVE",
"accountType": "CHECKING",
"amountDue": {
"amount": 1250.5,
"currency": "USD"
},
"availableBalance": {
"amount": 1250.5,
"currency": "USD"
},
"availableCredit": {
"amount": 1250.5,
"currency": "USD"
},
"balance": {
"amount": 1250.5,
"currency": "USD"
},
"createdDate": "2026-01-05T10:00:00Z",
"currentBalance": {
"amount": 1250.5,
"currency": "USD"
},
"displayedName": "Jo Bloggs",
"dueDate": "2026-12-01",
"id": 12345678,
"includeInNetWorth": true,
"isAsset": true,
"isManual": false,
"lastUpdated": "2026-11-12T08:30:00Z",
"nickname": "Bills",
"providerAccountId": 11223344,
"providerId": "16441",
"providerName": "Dag Site",
"totalCreditLine": {
"amount": 1250.5,
"currency": "USD"
}
}
],
"count": 1
}List categories
List Yodlee's transaction categories, and a user's own when you name one.
Inputs
- User
login_nametext - A user's login name, to include the categories they made. Leave empty for Yodlee's own.
Outputs
categorieslist- The categories
countnumber- How many there are
Example output
{
"categories": [
{
"category": "Restaurants",
"classification": "PERSONAL",
"defaultCategoryName": "Restaurants",
"highLevelCategoryId": 10000017,
"highLevelCategoryName": "Food and Dining",
"id": 22,
"source": "SYSTEM",
"type": "EXPENSE"
}
],
"count": 1
}List holdings
List the stocks, funds, bonds and other holdings in a user's investment accounts, with quantities and values.
Inputs
- User
login_nametextRequired - The Yodlee user's login name, the one your app registered them with (in the sandbox, one of its test users).
- Account
account_idtext - Only this account's holdings.
- Linked institution
provider_account_idtext - Only holdings from this linked institution.
Outputs
countnumber- How many there are
holdingslist- The holdings
Example output
{
"count": 1,
"holdings": [
{
"accountId": 12345679,
"costBasis": {
"amount": 480.0,
"currency": "USD"
},
"cusipNumber": "17275R102",
"description": "Cisco Systems",
"holdingType": "stock",
"id": 5551234,
"isin": "US17275R1023",
"lastUpdated": "2026-11-12T08:30:00Z",
"price": {
"amount": 57.2,
"currency": "USD"
},
"providerAccountId": 11223344,
"quantity": 10,
"symbol": "CSCO",
"value": {
"amount": 572.0,
"currency": "USD"
}
}
]
}List linked institutions
List the banks and other institutions a user has linked, with how each last refreshed.
Inputs
- User
login_nametextRequired - The Yodlee user's login name, the one your app registered them with (in the sandbox, one of its test users).
Outputs
countnumber- How many there are
provider_accountslist- The linked institutions
Example output
{
"count": 1,
"provider_accounts": [
{
"aggregationSource": "USER",
"authType": "CREDENTIALS",
"createdDate": "2026-01-05",
"dataset": [
{
"additionalStatus": "AVAILABLE_DATA_RETRIEVED",
"lastUpdateAttempt": "2026-11-12T08:30:00Z",
"lastUpdated": "2026-11-12T08:30:00Z",
"name": "BASIC_AGG_DATA",
"nextUpdateScheduled": "2026-11-13T08:30:00Z",
"updateEligibility": "ALLOW_UPDATE"
}
],
"id": 11223344,
"isManual": false,
"lastUpdated": "2026-11-12T08:30:00Z",
"providerId": 16441,
"requestId": "REQUEST-1234",
"status": "SUCCESS"
}
]
}List statements
List a user's credit card, loan and insurance statements, with amounts and due dates: the latest of each account unless you ask for past ones.
Inputs
- User
login_nametextRequired - The Yodlee user's login name, the one your app registered them with (in the sandbox, one of its test users).
- Account
account_idtext - Only this account's statements.
- Account kind
containertext - Only statements for accounts of this kind.One of:
creditCard(Credit card),loan,insurance. - Due from
from_datedate - Only statements due on or after this day.
- Include past statements
include_pasttrue/false - Turn on to get every statement, not only the latest.
- Account status
statuslist - Only statements of accounts with these statuses.One or more of:
ACTIVE,TO_BE_CLOSED(To be closed),CLOSED.
Outputs
countnumber- How many there are
statementslist- The statements
Example output
{
"count": 1,
"statements": [
{
"accountId": 12345680,
"amountDue": {
"amount": 812.4,
"currency": "USD"
},
"apr": 21.99,
"billingPeriodEnd": "2026-10-28",
"billingPeriodStart": "2026-09-29",
"dueDate": "2026-11-22",
"id": 7788990,
"isLatest": true,
"lastPaymentAmount": {
"amount": 500.0,
"currency": "USD"
},
"lastPaymentDate": "2026-10-20",
"lastUpdated": "2026-11-12T08:30:00Z",
"minimumPayment": {
"amount": 35.0,
"currency": "USD"
},
"newCharges": {
"amount": 640.12,
"currency": "USD"
},
"statementDate": "2026-10-28"
}
]
}List transactions
List a user's transactions, the last 30 days unless you give dates, optionally for one account, category or search.
Inputs
- User
login_nametextRequired - The Yodlee user's login name, the one your app registered them with (in the sandbox, one of its test users).
- From
from_datedate - Only transactions on or after this day. Up to two years back.
- To
to_datedate - Only transactions on or before this day.
- Account
account_idtext - Only this account's transactions.
- Account kind
containertext - Only transactions in accounts of this kind. Leave empty for all.One of:
bank,creditCard(Credit card),investment,insurance,loan. - Money in or out
base_typetext - Only money in, or only money out. Leave empty for both.One of:
DEBIT(Money out (debit)),CREDIT(Money in (credit)). - Category
category_idtext - Only transactions in this category.
- Category type
category_typetext - Only transactions whose category is of this type.One of:
EXPENSE,INCOME,TRANSFER,LOAN,UNCATEGORIZE(Uncategorized),DEFERRED_COMPENSATION(Deferred compensation). - Search
keywordtext - Only transactions whose description contains this text.
- Limit
limitnumber - How many to get, up to 500.From 1 to 500.
- Skip
skipnumber - How many to skip first, to get the next batch.At least 0.
Outputs
countnumber- How many there are
transactionslist- The transactions
Example output
{
"count": 1,
"transactions": [
{
"CONTAINER": "bank",
"accountId": 12345678,
"amount": {
"amount": 42.17,
"currency": "USD"
},
"baseType": "DEBIT",
"category": "Restaurants",
"categoryId": 22,
"categorySource": "SYSTEM",
"categoryType": "EXPENSE",
"createdDate": "2026-11-10T06:00:00Z",
"date": "2026-11-10",
"description": {
"consumer": "Team coffee",
"original": "SQ *BLUE BOTTLE COFFEE",
"simple": "Blue Bottle Coffee"
},
"highLevelCategoryId": 10000017,
"id": 98765432,
"isManual": false,
"lastUpdated": "2026-11-10T06:00:00Z",
"memo": "",
"merchant": {
"id": "bluebottle",
"name": "Blue Bottle Coffee"
},
"postDate": "2026-11-10",
"runningBalance": {
"amount": 1250.5,
"currency": "USD"
},
"status": "POSTED",
"transactionDate": "2026-11-09",
"type": "PURCHASE"
}
]
}Recategorize transaction
Put a transaction in another category, and optionally add a memo to it.
Inputs
- User
login_nametextRequired - The Yodlee user's login name, the one your app registered them with (in the sandbox, one of its test users).
- Transaction
transaction_idtextRequired - The transaction's id, such as one 'List transactions' gave.
- Account kind
containertextRequired - The kind of account the transaction is in, as its CONTAINER says.One of:
bank,creditCard(Credit card),investment,insurance,loan. - Category
category_idtextRequired - The new category. Pick one, or give the id of one of the user's own.
- Memo
memotext - A note to add to the transaction.
Outputs
categorytext- Its new category's name
category_idnumber- Its new category's id
category_sourcetext- SYSTEM (Yodlee's category) or USER (the user's own)
transaction_idnumber- The transaction
updatedtrue/false- Whether it was changed
Example output
{
"category": "Restaurants",
"category_id": 22,
"category_source": "SYSTEM",
"transaction_id": 98765432,
"updated": true
}Refresh accounts
Ask Yodlee to fetch the latest data from every institution a user has linked that can refresh now. Yodlee asks that this run only when the user signs in to your app, not on a schedule.
Inputs
- User
login_nametextRequired - The Yodlee user's login name, the one your app registered them with (in the sandbox, one of its test users).
Outputs
countnumber- How many there are
provider_accountslist- The linked institutions being refreshed (none when none could be)
Example output
{
"count": 1,
"provider_accounts": [
{
"aggregationSource": "USER",
"authType": "CREDENTIALS",
"createdDate": "2026-01-05",
"dataset": [
{
"additionalStatus": "AVAILABLE_DATA_RETRIEVED",
"lastUpdateAttempt": "2026-11-12T08:30:00Z",
"lastUpdated": "2026-11-12T08:30:00Z",
"name": "BASIC_AGG_DATA",
"nextUpdateScheduled": "2026-11-13T08:30:00Z",
"updateEligibility": "ALLOW_UPDATE"
}
],
"id": 11223344,
"isManual": false,
"lastUpdated": "2026-11-12T08:30:00Z",
"providerId": 16441,
"requestId": "REQUEST-1234",
"status": "IN_PROGRESS"
}
]
}Register user
Register one of your customers with Yodlee, under a login name of your choosing, so you can link their banks and read their data.
Inputs
- Login name
login_nametextRequired - Your own unique name for the user, 3 to 150 characters with no spaces, such as their id in your app. You'll use it to act for them.
- Email
emailtext - The user's email address.
- First name
first_nametext - The user's first name.
- Last name
last_nametext - The user's last name.
- Phone number
phone_numbertext - The user's phone number, such as +1-901-967-0100.
- Currency
currencytext - The currency Yodlee shows the user's totals in. Leave empty for the default.One of:
USD(US dollar (USD)),CAD(Canadian dollar (CAD)),EUR(Euro (EUR)),GBP(British pound (GBP)),AUD(Australian dollar (AUD)),NZD(New Zealand dollar (NZD)),INR(Indian rupee (INR)),ZAR(South African rand (ZAR)),SGD(Singapore dollar (SGD)),HKD(Hong Kong dollar (HKD)), and 4 more.
Outputs
userobject- The user
Example output
{
"user": {
"email": "jo@example.com",
"id": 10012345,
"loginName": "customer-1042",
"name": {
"first": "Jo",
"last": "Bloggs"
},
"phoneNumber": "+1-901-967-0100",
"preferences": {
"currency": "USD",
"dateFormat": "MM/dd/yyyy",
"locale": "en_US",
"timeZone": "PST"
},
"roleType": "INDIVIDUAL"
}
}Search institutions
Find banks and other institutions Yodlee can link, by name or by US or Canadian routing number.
Inputs
- Name or routing number
nametextRequired - What to search for.
- Limit
limitnumber - The most institutions to return.From 1 to 500.
Outputs
countnumber- How many there are
providerslist- The institutions
Example output
{
"count": 1,
"providers": [
{
"authType": "CREDENTIALS",
"baseUrl": "https://example.com",
"countryISOCode": "US",
"favicon": "https://example.com/favicon.png",
"id": 16441,
"loginUrl": "https://example.com/login",
"logo": "https://example.com/logo.png",
"name": "Dag Site",
"status": "Supported"
}
]
}Update account
Rename an account, set its nickname or memo, change a manual account's balance, or count it in or out of net worth. Only the fields given change.
Inputs
- User
login_nametextRequired - The Yodlee user's login name, the one your app registered them with (in the sandbox, one of its test users).
- Account
account_idtextRequired - The account. Pick one, or give its id.
- Account name
account_nametext - A new name. Leave empty to keep it.
- Nickname
nicknametext - A new nickname. Leave empty to keep it.
- Memo
memotext - A new note. Leave empty to keep it.
- Balance
balancenumber - A new balance, for a manual account. Leave empty to keep it.
- Currency
currencytext - The new balance's currency. Defaults to US dollars.One of:
USD(US dollar (USD)),CAD(Canadian dollar (CAD)),EUR(Euro (EUR)),GBP(British pound (GBP)),AUD(Australian dollar (AUD)),NZD(New Zealand dollar (NZD)),INR(Indian rupee (INR)),ZAR(South African rand (ZAR)),SGD(Singapore dollar (SGD)),HKD(Hong Kong dollar (HKD)), and 4 more. - Count toward net worth
include_in_net_worthtrue/false - Whether the account counts toward the user's net worth.
Outputs
accountobject- The account
Example output
{
"account": {
"CONTAINER": "bank",
"accountName": "Everyday Checking",
"accountNumber": "xxxx4321",
"accountStatus": "ACTIVE",
"accountType": "CHECKING",
"amountDue": {
"amount": 1250.5,
"currency": "USD"
},
"availableBalance": {
"amount": 1250.5,
"currency": "USD"
},
"availableCredit": {
"amount": 1250.5,
"currency": "USD"
},
"balance": {
"amount": 1250.5,
"currency": "USD"
},
"createdDate": "2026-01-05T10:00:00Z",
"currentBalance": {
"amount": 1250.5,
"currency": "USD"
},
"displayedName": "Jo Bloggs",
"dueDate": "2026-12-01",
"id": 12345678,
"includeInNetWorth": true,
"isAsset": true,
"isManual": false,
"lastUpdated": "2026-11-12T08:30:00Z",
"nickname": "Bills",
"providerAccountId": 11223344,
"providerId": "16441",
"providerName": "Dag Site",
"totalCreditLine": {
"amount": 1250.5,
"currency": "USD"
}
}
}Update user
Change a user's email, name, phone number or currency. Only the fields given change.
Inputs
- User
login_nametextRequired - The Yodlee user's login name, the one your app registered them with (in the sandbox, one of its test users).
- Email
emailtext - The user's email address. Leave empty to keep it.
- First name
first_nametext - The user's first name. Leave empty to keep it.
- Last name
last_nametext - The user's last name. Leave empty to keep it.
- Phone number
phone_numbertext - The user's phone number, such as +1-901-967-0100. Leave empty to keep it.
- Currency
currencytext - The currency Yodlee shows the user's totals in. Leave empty to keep it.One of:
USD(US dollar (USD)),CAD(Canadian dollar (CAD)),EUR(Euro (EUR)),GBP(British pound (GBP)),AUD(Australian dollar (AUD)),NZD(New Zealand dollar (NZD)),INR(Indian rupee (INR)),ZAR(South African rand (ZAR)),SGD(Singapore dollar (SGD)),HKD(Hong Kong dollar (HKD)), and 4 more.
Outputs
userobject- The user
Example output
{
"user": {
"email": "jo@example.com",
"id": 10012345,
"loginName": "customer-1042",
"name": {
"first": "Jo",
"last": "Bloggs"
},
"phoneNumber": "+1-901-967-0100",
"preferences": {
"currency": "USD",
"dateFormat": "MM/dd/yyyy",
"locale": "en_US",
"timeZone": "PST"
},
"roleType": "INDIVIDUAL"
}
}