Skip to main content
POST
Returns the add account widget's URL

Headers

Auth-Token
string
required

Authentication token provided during the authentication process

Body

application/json
username
string
redirectUri
string
institutionId
string
source
enum<string>

Bank-data provider: FINICITY (default) or MX. Omit for Finicity. Applies to both /api/v2/account/add and /api/v2/account/add/lite. Use /api/v2/institutions/provider-options to find which providers cover a given bank.

Available options:
DEFAULT,
FINICITY,
FDE,
MX

Response

Returns the add account URL widget to be invoked by the client

Set the optional source field to MX to connect a bank via MX (for banks Finicity does not support); omit it (or use FINICITY) for the default Finicity flow. When source=MX, widgetUrl is an MX Connect URL (moneydesktop.com) loaded with the MX Connect widget instead of the Finicity SDK; omit institutionId to let the user search for their bank in the widget.

Call /api/v2/institutions/provider-options first if you do not already know which provider covers the bank.

When the call succeed, returning code 200, grab the content of widgetUrl and make a call to this url

The response is of type string.