Skip to main content

Introduction

The Universal Connect Widget (UCW) is a self-hosted application that includes both the user interface (UI) and the server. The application enables you to configure the widget and retrieve the widget as a URL to be hosted via iframe.

It's designed to search and display an end user's institution based on a cached institution list. Using the preferences you configure directly in the application, the widget routes connections to your desired aggregator for that specific institution and facilitates the connection.

The front-end application handles searching for institutions, gathering credentials, and connecting to the end user's accounts.

The Widget Service handles the backend service that completes the following functions:

  • Searches an institution list
  • Hosts institutions list and caches it. The most recent institution list will be stored in the code when you first fork it. Once the list is cached, it will only be updated when you pull from the UCP repo.
  • Enables you to configure which aggregators are available.
  • Handles requests and routes them to aggregators.
  • Makes decisions about which aggregator to use.
  • Hosts routing preferences and caches them.

Who Are These Guides For?​

Follow these guides to set up the widget for authentication with your aggregators, review your institutions list, and configure your preferences. If you're planning to self-host the application as-is, these guides are for you.

If you're looking to contribute to UCW, checkout our README on our Github.

Supported Aggregators​

You may request data via data endpoints using authentication or data sent in verifiable credentials.

Verifiable credentials are currently available from:

  • MX
  • Sophtron

While data endpoints are optional, they are supported by all current aggregators:

  • MX
  • Sophtron

and upcoming aggregators:

  • Akoya
  • Finicity