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 below; omit institutionId to let the user search for their bank in the widget.

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

Example of returning JSON: { "status": "OK", "widgetUrl": "https://connect.finicity.com?analytics=google%3AUA-123456789-1&customerId=53829905&partnerId=2445582741601&redirectUri=https%3A%2F%2Fce5d9f86.ngrok.io%2Fapi%2Fpublic%2Fredirect-handler&signature=4837879cbdab90530c5191bec7209719cbb25657d38b6d6e862f809d44aaf661&timestamp=1589996840006&ttl=1590004040006&type=aggregation&webhook=https%3A%2F%2Fce5d9f86.ngrok.io%2Fapi%2Fpublic%2Fwebhook-handler&webhookContentType=application%2Fjson" }

** Include the below script on your page ** <script src="https://connect.finicity.com/assets/sdk/finicity-connect.min.js">

** Make this call to trigger the widget ** window['finicityConnect']['connectIFrame']('ADD THE CONTENT OF widgetUrl HERE', { success: () => { console.log('success'); }, cancel : () => { console.log('cancel'); }, error : () => { console.log('error'); }, loaded : () => { console.log('loaded'); } });

The response is of type string.