Skip to main content

Manage Providers

Providers represent the financial institutions and services available for users to connect. Each provider has flags that control its availability:

  • unpublished - The provider exists but is not shown to users by default. Unpublished providers are typically in development or deprecated.
  • outage - The provider is temporarily unavailable due to an issue at the institution. When outage is true, an optional outage_incident_link may provide more details.

Get the List of Providers

Retrieve available providers via the API or SDK:

API

GET /providers?group=core&format=array

Query parameters:

ParameterDescription
groupFilter by provider group. Comma-separated. Values: core (Wealthica native connectors, excluding Yodlee/Plaid and crypto), vezgo (crypto providers), yodlee, thirdparty (alias for Yodlee).
unpublishedFilter by publish status. false = only published providers (default for the Connect widget), true = only unpublished providers. Omit to return all.
classFilter by connection class: api, oauth, scraper.
formatResponse format: array (recommended) or object (keyed by provider type).
include_providersComma-separated list of provider types to force-include regardless of other filters. Useful for including specific unpublished providers.

SDK

Using wealthica-sdk-js:

const wealthica = Wealthica.init({
clientId: 'YOUR_CLIENT_ID',
secret: 'YOUR_CLIENT_SECRET',
});

// Get all published providers
const providers = await wealthica.providers.getList();

// Get a single provider by type
const provider = await wealthica.providers.getOne('questrade');

Controlling Providers in the Connect Widget

When launching the Connect widget via user.connect() or user.getConnectData(), you can control which providers are shown:

Provider Groups

By default, the Connect widget shows providers from the core group. Use providerGroups to change this:

user.connect({
providerGroups: ['core', 'thirdparty'], // show both core and third-party providers
});

Include Specific Providers

Use the providers option to show only a specific set of providers:

user.connect({
providers: ['wise', 'stockchase'], // only show these providers
});

This is useful when you want full control over which providers your users can connect. Note: the providers option is ignored if provider (singular) is also passed.

Disable Specific Providers

Use the disabledProviders option to exclude specific providers from the list:

user.connect({
disabledProviders: ['questrade', 'wealthsimple'], // hide these providers
});

This is useful when you want to show most providers but exclude a few. Unlike providers (which is an allow-list), disabledProviders is a deny-list — all providers are shown except the ones listed.

Direct to a Single Provider

Use provider to skip the provider selection screen and go directly to a specific provider's login:

user.connect({
provider: 'td', // go directly to TD login
});

Provider Response Fields

Each provider object includes:

FieldDescription
typeUnique provider identifier (e.g. questrade, coinbase)
nameDisplay name
outagetrue if the provider is currently experiencing an outage
outage_incident_linkURL with details about the outage (when applicable)
unpublishedtrue if the provider is not publicly available
instructionsLocalized connection instructions (en, fr, pt)
noteInternal note about the provider