{ "opencollection": "1.0.0", "info": { "name": "Yodlee Core APIs Account Token Accounts API", "version": "1.1.0" }, "items": [ { "info": { "name": "Accounts", "type": "folder" }, "items": [ { "info": { "name": "Associated Accounts", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/accounts/associatedAccounts/:providerAccountId", "params": [ { "name": "providerAccountId", "value": "", "type": "path", "description": "providerAccountId" } ] }, "docs": "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" }, { "info": { "name": "Get Accounts", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/accounts", "params": [ { "name": "accountId", "value": "", "type": "query", "description": "Comma separated accountIds." }, { "name": "container", "value": "", "type": "query", "description": "bank/creditCard/investment/insurance/loan/reward/realEstate/otherAssets/otherLiabilities" }, { "name": "convertToCurrency", "value": "", "type": "query", "description": "On-demand currency conversion parameter" }, { "name": "include", "value": "", "type": "query", "description": "profile, holder, fullAccountNumber, fullAccountNumberList, paymentProfile, autoRefresh
Note:
  • fullAccountNumber is deprecated and is replaced with fullAccountNumberList in include parameter and response.

  • profile is deprecated, and to retrieve the profile information, call the GET /verification/holderProfile API instead.
    • " }, { "name": "providerAccountId", "value": "", "type": "query", "description": "Comma separated providerAccountIds." }, { "name": "requestId", "value": "", "type": "query", "description": "The unique identifier that returns contextual data" }, { "name": "status", "value": "", "type": "query", "description": "ACTIVE,INACTIVE,TO_BE_CLOSED,CLOSED" } ] }, "docs": "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.
    Pagination is made available to the advisors to retrieve account data of all users assigned to them. The skip and top parameters are used for pagination. In the skip and top parameters pass the number of re" }, { "info": { "name": "Add Manual Account", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/accounts" }, "docs": "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:" }, { "info": { "name": "Migrate Accounts", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/accounts/migrateAccounts/:providerAccountId", "params": [ { "name": "providerAccountId", "value": "", "type": "path", "description": "providerAccountId" } ] }, "docs": "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 cho" }, { "info": { "name": "Evaluate Address", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/accounts/evaluateAddress" }, "docs": "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: