yodlee.AccountsApi

All URIs are relative to http://localhost

Method	HTTP request	Description
create_manual_account	POST /accounts	Add Manual Account
delete_account	DELETE /accounts/{accountId}	Delete Account
evaluate_address	POST /accounts/evaluateAddress	Evaluate Address
get_account	GET /accounts/{accountId}	Get Account Details
get_all_accounts	GET /accounts	Get Accounts
get_associated_accounts	GET /accounts/associatedAccounts/{providerAccountId}	Associated Accounts
get_historical_balances	GET /accounts/historicalBalances	Get Historical Balances
get_latest_balances	GET /accounts/latestBalances	Get Latest Balances
migrate_accounts	PUT /accounts/migrateAccounts/{providerAccountId}	Migrate Accounts
update_account	PUT /accounts/{accountId}	Update Account

create_manual_account

CreatedAccountResponse create_manual_account(account_param)

Add Manual Account

The add account service is used to add manual accounts.
The response of add account service includes the account name , account number and Yodlee generated account id.
All manual accounts added will be included as part of networth calculation by default.
Add manual account support is available for bank, card, investment, insurance and loan container only.

Note:

A real estate account addition is only supported for SYSTEM and MANUAL valuation type.

Example

from __future__ import print_function
import time
import yodlee
from yodlee.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = yodlee.Configuration(
    host = "http://localhost"
)


# Enter a context with an instance of the API client
with yodlee.ApiClient() as api_client:
    # Create an instance of the API class
    api_instance = yodlee.AccountsApi(api_client)
    account_param = yodlee.CreateAccountRequest() # CreateAccountRequest | accountParam

    try:
        # Add Manual Account
        api_response = api_instance.create_manual_account(account_param)
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling AccountsApi->create_manual_account: %s\n" % e)

Parameters

Name	Type	Description	Notes
account_param	CreateAccountRequest	accountParam

Return type

CreatedAccountResponse

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json;charset=UTF-8

HTTP response details

Status code	Description	Response headers
200	OK	-
400	Y800 : Invalid value for accountParam<br>Y811 : Real Estate Property value already exists<br>Y862 : The provided address is invalid, or the valuation is not available<br>Y869 : Multiple matches found. Provide the complete address or call the POST /accounts/evaluateAddress API to retrieve the list of matched addresses<br>	-
401	Unauthorized	-
404	Not Found	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

delete_account

delete_account(account_id)

Delete Account

The delete account service allows an account to be deleted.
This service does not return a response. The HTTP response code is 204 (Success with no content).

Example

from __future__ import print_function
import time
import yodlee
from yodlee.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = yodlee.Configuration(
    host = "http://localhost"
)


# Enter a context with an instance of the API client
with yodlee.ApiClient() as api_client:
    # Create an instance of the API class
    api_instance = yodlee.AccountsApi(api_client)
    account_id = 56 # int | accountId

    try:
        # Delete Account
        api_instance.delete_account(account_id)
    except ApiException as e:
        print("Exception when calling AccountsApi->delete_account: %s\n" % e)

Parameters

Name	Type	Description	Notes
account_id	int	accountId

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json;charset=UTF-8

HTTP response details

Status code	Description	Response headers
400	Y800 : Invalid value for accountId<br>Y806 : Invalid input<br>Y807 : Resource not found<br>Y868 : No action is allowed, as the data is being migrated to the Open Banking provider<br>	-
401	Unauthorized	-
204	OK	-
404	Not Found	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

evaluate_address

EvaluateAddressResponse evaluate_address(address_param)

Evaluate Address

Use this service to validate the address before adding the real estate account.
If the address is valid, the service will return the complete address information.
The response will contain multiple addresses if the user-provided input matches with multiple entries in the vendor database.
In the case of multiple matches, the user can select the appropriate address from the list and then invoke the add account service with the complete address.

Note:

Yodlee recommends to use this service before adding the real estate account to avoid failures.

Example

from __future__ import print_function
import time
import yodlee
from yodlee.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = yodlee.Configuration(
    host = "http://localhost"
)


# Enter a context with an instance of the API client
with yodlee.ApiClient() as api_client:
    # Create an instance of the API class
    api_instance = yodlee.AccountsApi(api_client)
    address_param = yodlee.EvaluateAddressRequest() # EvaluateAddressRequest | addressParam

    try:
        # Evaluate Address
        api_response = api_instance.evaluate_address(address_param)
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling AccountsApi->evaluate_address: %s\n" % e)

Parameters

Name	Type	Description	Notes
address_param	EvaluateAddressRequest	addressParam

Return type

EvaluateAddressResponse

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json;charset=UTF-8

HTTP response details

Status code	Description	Response headers
200	OK	-
400	Y806 : Invalid input<br>Y800 : Invalid value for zip<br>Y812 : Required field/value - address missing in the request<br>Y812 : Required field/value - street missing in the request<br>Y812 : Required field/value - state & city / zip missing in the request	-
401	Unauthorized	-
404	Not Found	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_account

AccountResponse get_account(account_id, include=include)

Get Account Details

The get account details service provides detailed information of an account.

Note:

fullAccountNumber is deprecated and is replaced with fullAccountNumberList in include parameter and response.

Example

from __future__ import print_function
import time
import yodlee
from yodlee.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = yodlee.Configuration(
    host = "http://localhost"
)


# Enter a context with an instance of the API client
with yodlee.ApiClient() as api_client:
    # Create an instance of the API class
    api_instance = yodlee.AccountsApi(api_client)
    account_id = 56 # int | accountId
include = 'include_example' # str | profile, holder, fullAccountNumber, fullAccountNumberList, paymentProfile, autoRefresh<br><b>Note:</b>fullAccountNumber is deprecated and is replaced with fullAccountNumberList in include parameter and response. (optional)

    try:
        # Get Account Details
        api_response = api_instance.get_account(account_id, include=include)
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling AccountsApi->get_account: %s\n" % e)

Parameters

Name	Type	Description	Notes
account_id	int	accountId
include	str	profile, holder, fullAccountNumber, fullAccountNumberList, paymentProfile, autoRefresh<br><b>Note:</b>fullAccountNumber is deprecated and is replaced with fullAccountNumberList in include parameter and response.	[optional]

Return type

AccountResponse

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json;charset=UTF-8

HTTP response details

Status code	Description	Response headers
200	OK	-
401	Unauthorized	-
404	Not Found	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_all_accounts

AccountResponse get_all_accounts(account_id=account_id, container=container, include=include, provider_account_id=provider_account_id, request_id=request_id, status=status)

Get Accounts

The get accounts service provides information about accounts added by the user.
By default, this service returns information for active and to be closed accounts.
If requestId is provided, the accounts that are updated in the context of the requestId will be provided in the response.

Note:

fullAccountNumber is deprecated and is replaced with fullAccountNumberList in include parameter and response.
fullAccountNumberList, PII (Personal Identifiable Information) and holder details are not available by default, as it is a premium feature that needs security approval. This will not be available for testing in Sandbox environment.

Example

from __future__ import print_function
import time
import yodlee
from yodlee.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = yodlee.Configuration(
    host = "http://localhost"
)


# Enter a context with an instance of the API client
with yodlee.ApiClient() as api_client:
    # Create an instance of the API class
    api_instance = yodlee.AccountsApi(api_client)
    account_id = 'account_id_example' # str | Comma separated accountIds. (optional)
container = 'container_example' # str | bank/creditCard/investment/insurance/loan/reward/realEstate/otherAssets/otherLiabilities (optional)
include = 'include_example' # str | profile, holder, fullAccountNumber, fullAccountNumberList, paymentProfile, autoRefresh<br><b>Note:</b><br><li>fullAccountNumber is deprecated and is replaced with fullAccountNumberList in include parameter and response.</li><br><li>profile is deprecated, and to retrieve the profile information, call the GET /verification/holderProfile API instead.</li> (optional)
provider_account_id = 'provider_account_id_example' # str | Comma separated providerAccountIds. (optional)
request_id = 'request_id_example' # str | The unique identifier that returns contextual data (optional)
status = 'status_example' # str | ACTIVE,INACTIVE,TO_BE_CLOSED,CLOSED (optional)

    try:
        # Get Accounts
        api_response = api_instance.get_all_accounts(account_id=account_id, container=container, include=include, provider_account_id=provider_account_id, request_id=request_id, status=status)
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling AccountsApi->get_all_accounts: %s\n" % e)

Parameters

Name	Type	Description	Notes
account_id	str	Comma separated accountIds.	[optional]
container	str	bank/creditCard/investment/insurance/loan/reward/realEstate/otherAssets/otherLiabilities	[optional]
include	str	profile, holder, fullAccountNumber, fullAccountNumberList, paymentProfile, autoRefresh<br><b>Note:</b><br><li>fullAccountNumber is deprecated and is replaced with fullAccountNumberList in include parameter and response.</li><br><li>profile is deprecated, and to retrieve the profile information, call the GET /verification/holderProfile API instead.</li>	[optional]
provider_account_id	str	Comma separated providerAccountIds.	[optional]
request_id	str	The unique identifier that returns contextual data	[optional]
status	str	ACTIVE,INACTIVE,TO_BE_CLOSED,CLOSED	[optional]

Return type

AccountResponse

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json;charset=UTF-8

HTTP response details

Status code	Description	Response headers
200	OK	-
400	Y800 : Invalid value for status<br>Y800 : Invalid value for container<br>Y800 : Invalid value for providerAccountId<br>Y824 : The maximum number of accountIds permitted is 100	-
401	Unauthorized	-
404	Not Found	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_associated_accounts

AssociatedAccountsResponse get_associated_accounts(provider_account_id)

Associated Accounts

Yodlee classifies providers into credential-based aggregation and Open Banking (OB) providers.
This service is associated with the OB aggregation flow. As part of the OB solution, financial institutions may merge their subsidiaries and provide data as a single OB provider.
Before the OB solution, this data was aggregated with different provider IDs.
This service accepts the providerAccountId and returns all accounts of the associated providerAccounts that belong to the subsidiary of the financial institution.
This data should be displayed to the user to let them select the accounts that they wish to provide consent to share account data.

Example

from __future__ import print_function
import time
import yodlee
from yodlee.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = yodlee.Configuration(
    host = "http://localhost"
)


# Enter a context with an instance of the API client
with yodlee.ApiClient() as api_client:
    # Create an instance of the API class
    api_instance = yodlee.AccountsApi(api_client)
    provider_account_id = 56 # int | providerAccountId

    try:
        # Associated Accounts
        api_response = api_instance.get_associated_accounts(provider_account_id)
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling AccountsApi->get_associated_accounts: %s\n" % e)

Parameters

Name	Type	Description	Notes
provider_account_id	int	providerAccountId

Return type

AssociatedAccountsResponse

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json;charset=UTF-8

HTTP response details

Status code	Description	Response headers
200	OK	-
400	Y800 : Invalid value for providerAccountId<br>	-
401	Unauthorized	-
404	Not Found	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_historical_balances

AccountHistoricalBalancesResponse get_historical_balances(account_id=account_id, from_date=from_date, include_cf=include_cf, interval=interval, skip=skip, to_date=to_date, top=top)

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 historical balances.
The API will only retrieve a maximum 500 records by default when values for skip and top parameters are not provided.

Example

from __future__ import print_function
import time
import yodlee
from yodlee.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = yodlee.Configuration(
    host = "http://localhost"
)


# Enter a context with an instance of the API client
with yodlee.ApiClient() as api_client:
    # Create an instance of the API class
    api_instance = yodlee.AccountsApi(api_client)
    account_id = 'account_id_example' # str | accountId (optional)
from_date = 'from_date_example' # str | from date for balance retrieval (YYYY-MM-DD) (optional)
include_cf = True # bool | Consider carry forward logic for missing balances (optional)
interval = 'interval_example' # str | D-daily, W-weekly or M-monthly (optional)
skip = 56 # int | skip (Min 0) (optional)
to_date = 'to_date_example' # str | toDate for balance retrieval (YYYY-MM-DD) (optional)
top = 56 # int | top (Max 500) (optional)

    try:
        # Get Historical Balances
        api_response = api_instance.get_historical_balances(account_id=account_id, from_date=from_date, include_cf=include_cf, interval=interval, skip=skip, to_date=to_date, top=top)
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling AccountsApi->get_historical_balances: %s\n" % e)

Parameters

Name	Type	Description	Notes
account_id	str	accountId	[optional]
from_date	str	from date for balance retrieval (YYYY-MM-DD)	[optional]
include_cf	bool	Consider carry forward logic for missing balances	[optional]
interval	str	D-daily, W-weekly or M-monthly	[optional]
skip	int	skip (Min 0)	[optional]
to_date	str	toDate for balance retrieval (YYYY-MM-DD)	[optional]
top	int	top (Max 500)	[optional]

Return type

AccountHistoricalBalancesResponse

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json;charset=UTF-8

HTTP response details

Status code	Description	Response headers
200	OK	-
400	Y800 : Invalid value for accountId<br>Y800 : Invalid value for fromDate<br>Y800 : Invalid value for toDate<br>Y809 : Invalid date range<br>Y800 : Invalid value for interval<br>Y802 : Future date not allowed	-
401	Unauthorized	-
404	Not Found	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_latest_balances

AccountBalanceResponse get_latest_balances(account_id, provider_account_id)

Get Latest Balances

The latest balances service provides the latest account balance by initiating a new balance refresh request

Example

from __future__ import print_function
import time
import yodlee
from yodlee.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = yodlee.Configuration(
    host = "http://localhost"
)


# Enter a context with an instance of the API client
with yodlee.ApiClient() as api_client:
    # Create an instance of the API class
    api_instance = yodlee.AccountsApi(api_client)
    account_id = 'account_id_example' # str | Comma separated accountIds.
provider_account_id = 'provider_account_id_example' # str | providerAccountId.

    try:
        # Get Latest Balances
        api_response = api_instance.get_latest_balances(account_id, provider_account_id)
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling AccountsApi->get_latest_balances: %s\n" % e)

Parameters

Name	Type	Description	Notes
account_id	str	Comma separated accountIds.
provider_account_id	str	providerAccountId.

Return type

AccountBalanceResponse

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json;charset=UTF-8

HTTP response details

Status code	Description	Response headers
200	OK	-
400	Y800 : Invalid value for providerAccountId<br>Y800 : Invalid value for accountId <br>Y800 : Invalid value for accountId. Only ACTIVE accountId are supported <br>Y901 : Service not supported<br>Y803 : providerAccountId required <br>Y805 : Multiple providerAccountId not supported <br>Y803 : accountId required <br>Y820 : The accountId is not supported for container other than bank, investment<br>Y824 : The maximum number of accountIds permitted is 10<br>Y800 : Invalid value for accountId. All accountIds should belong to the same providerAccountId	-
401	Unauthorized	-
404	Not Found	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

migrate_accounts

AccountMigrationResponse migrate_accounts(provider_account_id)

Migrate Accounts

This service is associated with the open banking (OB) flow.
Before invoking this service, display all the associated accounts to the user by calling the GET /associatedAccounts API.
The migrate accounts API treats the user's consent acceptance to initiate account migration. Invoking this service indicates that the user has given the consent to access the associated account information from the financial institution.
If an existing provider supports bank, card, and loan accounts, and chose only to provide bank and card through OB APIs, a new providerAccountId for OB will be created.
The bank and card account information will be moved to the new providerAccountId. The loan account will be retained in the existing provider account.
This service returns the OB providerId and the OB providerAccountId. Note that, as part of this process, there is a possibility of one or more providerAccounts getting merged.
The update or delete actions will not be allowed for the providerAccounts involved in the migration process until the user completes the authorization on the OB provider.
The oauthMigrationEligibilityStatus attribute in the GET /accounts API response indicates the accounts included in the migration process.

Example

from __future__ import print_function
import time
import yodlee
from yodlee.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = yodlee.Configuration(
    host = "http://localhost"
)


# Enter a context with an instance of the API client
with yodlee.ApiClient() as api_client:
    # Create an instance of the API class
    api_instance = yodlee.AccountsApi(api_client)
    provider_account_id = 56 # int | providerAccountId

    try:
        # Migrate Accounts
        api_response = api_instance.migrate_accounts(provider_account_id)
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling AccountsApi->migrate_accounts: %s\n" % e)

Parameters

Name	Type	Description	Notes
provider_account_id	int	providerAccountId

Return type

AccountMigrationResponse

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json;charset=UTF-8

HTTP response details

Status code	Description	Response headers
200	OK	-
400	Y800 : Invalid value for providerAccountId<br>	-
401	Unauthorized	-
404	Not Found	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

update_account

update_account(account_id, account_request)

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.

A real estate account can be linked to a loan account by passing accountId of a loan account in linkedAccountIds .

Attribute isEbillEnrolled is deprecated as it is applicable for bill accounts only.

Example

from __future__ import print_function
import time
import yodlee
from yodlee.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = yodlee.Configuration(
    host = "http://localhost"
)


# Enter a context with an instance of the API client
with yodlee.ApiClient() as api_client:
    # Create an instance of the API class
    api_instance = yodlee.AccountsApi(api_client)
    account_id = 56 # int | accountId
account_request = yodlee.UpdateAccountRequest() # UpdateAccountRequest | accountRequest

    try:
        # Update Account
        api_instance.update_account(account_id, account_request)
    except ApiException as e:
        print("Exception when calling AccountsApi->update_account: %s\n" % e)

Parameters

Name	Type	Description	Notes
account_id	int	accountId
account_request	UpdateAccountRequest	accountRequest

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json;charset=UTF-8

HTTP response details

Status code	Description	Response headers
400	Y800 : Invalid value for accountId<br>Y800 : Invalid value for updateParam<br>Y862 : The provided address is invalid, or the valuation is not available<br>Y868 : No action is allowed, as the data is being migrated to the Open Banking provider<br>Y869 : Multiple matches found. Provide the complete address or call the POST /accounts/evaluateAddress API to retrieve the list of matched addresses<br>	-
401	Unauthorized	-
204	OK	-
404	Not Found	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Files

AccountsApi.md

Latest commit

History

AccountsApi.md

File metadata and controls

yodlee.AccountsApi

create_manual_account

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

delete_account

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

evaluate_address

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_account

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_all_accounts

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_associated_accounts

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_historical_balances

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_latest_balances

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

migrate_accounts

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

update_account

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details