Yodlee Configs API

Configs API

Operations 5

GET /configs/notifications/events Get Subscribed Notification Events #
GET /configs/publicKey Get Public Key #
POST /configs/notifications/events/{eventName} Subscribe For Notification Event #
DELETE /configs/notifications/events/{eventName} Delete Notification Subscription #
PUT /configs/notifications/events/{eventName} Update Notification Subscription #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/yodlee-configs-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

yodlee-configs-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  license:
    name: Yodlee Developer License
    url: https://developer.yodlee.com/terms/condition#_Services_1
  contact:
    email: developer@yodlee.com
  description: 'This file describes the Yodlee Platform APIs using the swagger notation. You can use this swagger file to generate client side SDKs to the Yodlee Platform APIs for many different programming languages. Yodlee API v1.1 - Overview</a>.<br><br>You will have to set the header before making the API call. The following headers apply to all the APIs:<ul><li>Authorization: This header holds the access token</li> <li> Api-Version: 1.1</li></ul><b>Note</b>: If there are any API-specific headers, they are mentioned explicitly in the respective API''s description.'
  termsOfService: https://developer.yodlee.com/terms/condition
  title: Yodlee Core APIs Account Token Configs API
  version: 1.1.0
servers:
- url: /
tags:
- name: Configs
  description: Configs API
paths:
  /configs/notifications/events:
    get:
      summary: Get Subscribed Notification Events
      deprecated: false
      description: The get events service provides the list of events for which consumers subscribed to receive notifications. <br>
      operationId: getSubscribedNotificationEvents
      responses:
        200:
          description: OK
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ConfigsNotificationResponse'
        401:
          description: Unauthorized
        404:
          description: Not Found
      parameters:
      - in: query
        allowEmptyValue: false
        name: eventName
        description: Name of the webhook subscription event
        required: false
        schema:
          type: string
          enum:
          - REFRESH
          - DATA_UPDATES
          - AUTO_REFRESH_UPDATES
          - LATEST_BALANCE_UPDATES
          - CREDIT_MATRIX_REPORT_UPDATES
      tags:
      - Configs
  /configs/publicKey:
    get:
      summary: Get Public Key
      deprecated: false
      description: The get public key service provides the public key that should be used to encrypt user credentials while invoking POST /providerAccounts and PUT /providerAccounts endpoints.<br>This service will only work if the PKI (public key infrastructure) feature is enabled for the customer.<br><br><b>Note:</b><li> The key in the response is a string in PEM format.</li><li>This endpoint is not available in the Sandbox environment and it is useful only if the PKI feature is enabled.</li>
      operationId: getPublicEncryptionKey
      responses:
        200:
          description: OK
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ConfigsPublicKeyResponse'
        401:
          description: Unauthorized
        404:
          description: Not Found
      tags:
      - Configs
  /configs/notifications/events/{eventName}:
    post:
      summary: Subscribe For Notification Event
      deprecated: false
      description: The subscribe events service is used to subscribe to an event for receiving notifications.<br>The callback URL, where the notification will be posted should be provided to this service.<br>If the callback URL is invalid or inaccessible, the subscription will be unsuccessful, and an error will be thrown.<br>Customers can subscribe to REFRESH,DATA_UPDATES,AUTO_REFRESH_UPDATES,LATEST_BALANCE_UPDATES and CREDIT_MATRIX_REPORT_UPDATES event.<br><br><b>Notes:</b><li>This service is not available in developer sandbox/test environment and will be made available for testing in your dedicated environment, once the contract is signed.<li>The content type has to be passed as application/json for the body parameter.</li>
      operationId: createSubscriptionNotificationEvent
      responses:
        201:
          description: OK
        400:
          description: 'Y803 : eventName required<br>Y803 : callbackUrl required<br>Y800 : Invalid value for callbackUrl<br>Y901 : Service not supported<br>'
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/YodleeError'
        401:
          description: Unauthorized
        404:
          description: Not Found
      parameters:
      - in: path
        name: eventName
        description: Name of the webhook subscription event
        required: true
        schema:
          type: string
          enum:
          - REFRESH
          - DATA_UPDATES
          - AUTO_REFRESH_UPDATES
          - LATEST_BALANCE_UPDATES
          - CREDIT_MATRIX_REPORT_UPDATES
      tags:
      - Configs
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateConfigsNotificationEventRequest'
        description: eventRequest
        required: true
    delete:
      summary: Delete Notification Subscription
      deprecated: false
      description: The delete events service is used to unsubscribe from an events service.<br>
      operationId: deleteSubscribedNotificationEvent
      responses:
        400:
          description: 'Y803 : eventName required'
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/YodleeError'
        401:
          description: Unauthorized
        204:
          description: OK
        404:
          description: Not Found
      parameters:
      - in: path
        name: eventName
        description: Name of the webhook subscription event
        required: true
        schema:
          type: string
          enum:
          - REFRESH
          - DATA_UPDATES
          - AUTO_REFRESH_UPDATES
          - LATEST_BALANCE_UPDATES
          - CREDIT_MATRIX_REPORT_UPDATES
      tags:
      - Configs
    put:
      summary: Update Notification Subscription
      deprecated: false
      description: The update events service is used to update the callback URL.<br>If the callback URL is invalid or inaccessible, the subscription will be unsuccessful, and an error will be thrown.<br><br><b>Note:</b> <li>The content type has to be passed as application/json for the body parameter. <br>
      operationId: updateSubscribedNotificationEvent
      responses:
        400:
          description: 'Y803 : eventName required<br>Y803 : callbackUrl required<br>Y800 : Invalid value for callbackUrl'
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/YodleeError'
        401:
          description: Unauthorized
        204:
          description: OK
        404:
          description: Not Found
      parameters:
      - in: path
        name: eventName
        description: Name of the webhook subscription event
        required: true
        schema:
          type: string
          enum:
          - REFRESH
          - DATA_UPDATES
          - AUTO_REFRESH_UPDATES
          - LATEST_BALANCE_UPDATES
          - CREDIT_MATRIX_REPORT_UPDATES
      tags:
      - Configs
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateConfigsNotificationEventRequest'
        description: eventRequest
        required: true
components:
  schemas:
    ConfigsPublicKey:
      type: object
      title: ConfigsPublicKey
      properties:
        alias:
          description: The key name used for encryption.<br><br><b>Endpoints</b>:<ul><li>GET configs/publicKey</li></ul>
          readOnly: true
          type: string
        key:
          description: Public key that the customer should be using to encrypt the credentials and answers before sending to the add and update providerAccounts APIs.<br><br><b>Endpoints</b>:<ul><li>GET configs/publicKey</li></ul>
          readOnly: true
          type: string
    ConfigsNotificationEvent:
      type: object
      title: ConfigsNotificationEvent
      properties:
        name:
          description: Name of the event for which the customers must subscribe to receive notifications.<br><b>Valid Value:</b> Notification Events Name<br><br><b>Endpoints</b>:<ul><li>GET configs/notifications/events</li></ul><b>Applicable Values</b><br>
          type: string
          enum:
          - REFRESH
          - DATA_UPDATES
          - AUTO_REFRESH_UPDATES
          - LATEST_BALANCE_UPDATES
          - CREDIT_MATRIX_REPORT_UPDATES
        callbackUrl:
          minLength: 1
          description: URL to which the notification should be posted.<br><br><b>Endpoints</b>:<ul><li>GET configs/notifications/events</li></ul>
          type: string
          maxLength: 2147483647
    UpdateConfigsNotificationEvent:
      type: object
      title: UpdateConfigsNotificationEvent
      properties:
        callbackUrl:
          minLength: 1
          description: URL to which the notification should be posted.<br><br><b>Endpoints</b>:<ul><li>GET configs/notifications/events</li></ul>
          type: string
          maxLength: 2147483647
    ConfigsPublicKeyResponse:
      type: object
      title: ConfigsPublicKeyResponse
      properties:
        publicKey:
          $ref: '#/components/schemas/ConfigsPublicKey'
    UpdateConfigsNotificationEventRequest:
      type: object
      title: UpdateConfigsNotificationEventRequest
      required:
      - event
      properties:
        event:
          $ref: '#/components/schemas/UpdateConfigsNotificationEvent'
    ConfigsNotificationResponse:
      type: object
      title: ConfigsNotificationResponse
      properties:
        event:
          readOnly: true
          type: array
          items:
            $ref: '#/components/schemas/ConfigsNotificationEvent'
    CreateConfigsNotificationEventRequest:
      type: object
      title: CreateConfigsNotificationEventRequest
      required:
      - event
      properties:
        event:
          $ref: '#/components/schemas/CreateConfigsNotificationEvent'
    YodleeError:
      type: object
      title: YodleeError
      properties:
        errorMessage:
          description: The descriptive message that explains the error scenario.
          readOnly: true
          type: string
        errorCode:
          description: The error code follows the format YNNN. The error codes do not change. New error codes may be added as we introduce new features and enhance functionalities.
          readOnly: true
          type: string
        referenceCode:
          description: Unique Yodlee identifier used to troubleshoot issues at Yodlee's end.
          readOnly: true
          type: string
    CreateConfigsNotificationEvent:
      type: object
      title: CreateConfigsNotificationEvent
      properties:
        callbackUrl:
          minLength: 1
          description: URL to which the notification should be posted.<br><br><b>Endpoints</b>:<ul><li>GET configs/notifications/events</li></ul>
          type: string
          maxLength: 2147483647