Startup configuration

Make sure that the experience is tailored for your users by showing them just the right information when the widget opens.

With Belvo's Connect Widget, you can configure what links to create and the information you want to show when the widget starts up. This includes the:

  • type of links to create
  • additional identifier for the link (external_id)
  • which countries to display
  • institutions to display
  • institution types to display
  • language of the widget

Define the type of link created

You can define the type of link you want the widget to create. By default, we create recurrent links. You can choose to create either recurrent or single links.

Instructions
To set which link type to create, just add either single or recurrent to the access_mode key.

...

belvoSDK.createWidget(access_token, {
  ...
    access_mode: "single",
  ...
...
https://widget.belvo.io/
    ?access_token={access_code}
    &access_mode=single
const config = {
  ...
  access_mode: "single",
  ...
}

Read more about our different types of links here: difference between single and recurrent link.

Adding an additional identifier for the link

You can add an additional identifier to be associated with the link in the Belvo database. For more information, see our Link creation article.

Instructions
To set which link type to create, just add a unique ID to the external_id key.

...

belvoSDK.createWidget(access_token, {
  ...
    external_id: "HJLSI-897809",
  ...
...
https://widget.belvo.io/
    ?access_token={access_code}
    &external_id=HJLSI-897809
const config = {
  ...
  external_id: "HJLSI-897809",
  ...
}

Define which countries to display

You can define which countries users can select institutions from. By default, the widget displays all supported countries. Supported countries are:

  • BR for 🇧🇷 Brazil
  • CO for 🇨🇴 Colombia
  • MX for 🇲🇽 Mexico

Instructions
To set which country to display, just add either BR, CO, or MX (uppercase letters only) to the country_codes key.

...

belvoSDK.createWidget(access_token, {
  ...
    country_codes: ['MX', 'CO'],
  ...
...
https://widget.belvo.io/
    ?access_token={access_code}
    &country_codes=mx,co
const config = {
  ...
  country_codes: ['MX', 'CO'],
  ...
}

📘

The order in which you add the countries in the array is reflected in the widget. For example ['MX', 'CO'] displays Mexico then Colombia, while ['CO', 'MX'] displays Colombia and then Mexico.

Select one or more institutions to display

You can choose to start up the widget already at the log in page for a specific institution or to display only select institutions. By default, the widget displays all the supported institutions.

Instructions
To set one or more institutions to display in the widget, just add it to the institutions key.

...

belvoSDK.createWidget(access_token, {
  ...
  // To display just one institution:
    institutions: ['erebor_mx_retail'],
  // To display more than on institution:
  institutions: ['erebor_mx_retail','gringotts_mx_retail'],
  ...
...
# To display just one institution:
https://widget.belvo.io/
    ?access_token={access_code}
    &institutions=erebor_mx_retail

# To display more than on institution:
https://widget.belvo.io/
    ?access_token={access_code}
    &institutions=erebor_mx_retail,gringotts_mx_retail
const config = {
  ...
  // To display just one institution:
institutions: ['erebor_mx_retail'],
  // To display more than on institution:
  institutions: ['erebor_mx_retail','gringotts_mx_retail'],
  ...
}

📘

If the combination of institutions, institution_types, and locale only results in one institution being available for the user, then the widget directly displays the log in page for that institution.

Define what institution types to display

You can choose what institution types to show in the widget. Institutions are always shown in the following order: Bank, Fiscal, Gig. By default, the widget displays all the supported institution types.

Choose one or more of the following institutions:

  • business for business banks
  • retail for retail banks
  • fiscal for fiscal institutions
  • gig for gig-economy providers

Instructions
To set which institutions to display in the widget, just add one or more to the institution_types key.

...

belvoSDK.createWidget(access_token, {
  ...
    institution_types: ['retail', 'business'],
  ...
...
https://widget.belvo.io/
    ?access_token={access_code}
    &institution_types=retail,business
const config = {
  ...
  institution_types: ['retail', 'business'],
  ...
}

Define the language for the widget

You can choose what language the widget should display. By default, the widget is shown in Spanish (ES).

Choose one of the following languages for the widget:

  • en for 🇬🇧 English
  • es for 🇪🇸Spanish
  • pt for 🇧🇷Brazilian Portuguese

Instructions
To set the language of the widget, just add either es, en, or pt (lowercase letters only) to the locale key.

...

belvoSDK.createWidget(access_token, {
  ...
    locale: 'pt',
  ...
...
https://widget.belvo.io/
    ?access_token={access_code}
    &locale=pt
const config = {
  ...
  locale: 'pt',
  ...
}

Did this page help you?