Introduction
The Universal Connect Widget (UCW) is a self-hosted application that includes both the user interface (UI) and the server. You should configure and retrieve the widget as a URL and host via iframe.
The front-end application handles searching for institutions, gathering credentials, and connecting to the end user's accounts. The institutions are based on a cached institution list. Using your preferences, the widget routes connections to your desired aggregator for that specific institution and facilitates the connection.
UCP dashboard
Create an account for the dashboard and get updated institution lists and performance data.
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 is stored in the code. You should fork the code to cache the list. To update the list, pull the list 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.
Supported Aggregators
Availability of connections, data endpoints, and verifiable credential endpoints vary. The following list details aggregators available with UCW.
| Aggregator | Connection | Data Endpoints | VC Endpoints |
|---|---|---|---|
| Akoya | ✔ | ✘ | ✘ |
| Finicity | ✔ | ✔ | ✘ |
| MX | ✔ | ✔ | ✔ |
| Sophtron | ✔ | ✔ | ✔ |
Supported functionality by aggregator
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.