👍

Widget Overview

If you'd like to have a general overview of how the widget works, make sure to check out our Connect Widget Overview article.

For mobile-native applications, we've created a hosted version of our widget that significantly simplifies your development and integration process. All it requires is for you to create a webview in your application and some knowledge of handling deeplink redirects.

On this page, we'll provide you with reference documentation on what information to pass when starting your webview as well as the possible events you can receive from the widget.

🚧

Widget for webviews and OFDA Brazil

When using the widget for webviews to create links with OFDA Brazil, make sure to set the following required parameters:

• set locale to pt
• set mode to webapp (The mode query parameter is only used for OFDA brazil)

Below is an example of all the query parameters:

https://widget.belvo.io/?access_token={access_code}&locale=pt&mode=webapp

Start Widget via webview

When you initiate your webview, in order to start the widget correctly, you need to pass your access_token in the URL string.

You can also pass the configuration parameters, such as the language of the widget and what institutions to display, in the call. For detailed information about these parameters, please see our widget Startup Configuration article.

https://widget.belvo.io/
	?access_token={access_code}
  	&locale=es
  	&institution_types=retail
  	&country_codes=BR
  	&access_mode=recurrent
    &external_id=HJLSI-897809
    &resources=OWNERS,INVESTMENTS_PORTFOLIOS
    &integration_type=openbanking

Widget responses

We make use of deep link redirects in order to pass information about what happens in the widget. The structure of our deep links is:

You'll need to be able to handle success, exit, and error events.

Success event

You'll receive a Success event when your end user has successfully connected their account to their institution using the widget.

your-url-here://success
	?link=cb65f82c-dc93-4d3e-8270-9a27528397f5
	&institution=banamex_mx_retail

Exit event

You'll receive an Exit event when your end user exits the widget:

• before connecting their account.
• after they have selected an institution.
• due to an error.

last_encountered_error

The last_encountered_error query string is only sent if an error occurred. See the table below for a full list of possible error codes and their messages.

meta_data

The meta_data query string is sent whenever a user exits the widget. See the table below for a list of possible values.

your-url-here://exit
	?last_encountered_error_code=login_error
  	&last_encountered_error_message=Invalid%20credentials%20provided%20to%20login%20to%20the%20institution
	&meta_data_institution_name=amex_mx_retail
	&meta_data_step=abandon-survey

Error event

You'll receive an Error event whenever an error occurs during the use of the widget.

See the table below for a list of possible error codes and their messages.

your-url-here://exit
	?error=ACCESS_TOKEN_NOT_VALID
	&error_message=The%20access%20token%20was%20not%20provided%20or%20is%20not%20valid

Warning event

You'll receive a Warning event whenever a non-terminating event occurs during the use of the widget.

See the table below for a list of possible warning codes and their messages.

your-url-here://warning
	?warning=institution_disabled
  &warning_message=The%20institution%20is%20temporarily%20unavailable.

Platform Guides

To aid your development, we've created guides on how to set up deep links and listen for events for the following platforms:

• iOS (Swift)
• Android (Kotlin)
• React Native