Qodex.ai

#Widget access_token generation

Number of APIs: 1

ℹ️ To use this collection, fork the collection to your private workspace.

In our Widget access_token generation collection, we provide the requests that you can make in order to generate an access_token for both our standard (multi-region) and OFDA-specific widget.

For extensive explanations regarding Belvo's widget and the possible configuration parameters, make sure to check out our DevPortal:

Additionally, we include a script in the Tests tab that will auto-generate a URL link to the hosted version of our widget and display it in Qodex's console . You can change copy this URL and paste it into your browser.

Hosted%20widget%20URL%20in%20the%20Qodex%20Console

Generate access_token (multi-region)

The Generate access_token (multi-region) request will generate an access_token for our multi-region widget (applicable for Colombia and Mexico).

Generate access_token (update mode, multi-region)

The Generate access_token (update mode, multi-region) request will generate an access_token for a pre-existing multi-region link, allowing your user to update their credentials. For more information, see our Connect Widget update mode documentation .

Generate access_token (OFDA)

The Generate access_token (OFDA) request will generate an access_token for our OFDA-specific widget (applicable only for Brazil).

Configuring the hosted widget URL

To change the setup of the hosted widget URL:

  1. Go to the Tests tab of Widget access_token generation collection request.
  2. Modify the queryParams object according to your needs.

Accessing%20the%20Tests%20tab%20and%20modifying%20the%20queryParams%20object

The parameters you can alter are as follows:

Parameter Required Description Example value
access_token Yes The generated access token. jsonData.access
access_mode No Type of link to create. Can be either single or recurrent . single
external_id No Your unique additional identifier for the user. hosted-widget-example
locale No The display language of the widget. Can be es , pt , or en . pt
enable_openbanking No Enables open banking features (OFDA-only).

If you're using the multi-region version of the widget, set this to false . 		true
show_close_dialog No Whether or not to display the widget exit message. Defaults to false . false
show_abandon_survey No Whether or not to display the survey when the user abandons the process. Defaults to false . false
country_codes No Display institutions from these countries. Can be one or more of: MX , CO , and BR . MX,CO,BR
institutions No A list of institutions to display in the widget. erebor_mx_retail,erebor_co_retail
institution_types No Types of institutions to display in the widget. Can be any of: retail , business , employment . retail,business,employment
resources No Types of resources the institutions must support. For a detailed list of resources, see the fetch_resouces parameter in our

POST Register a new link

API reference documentation. 		ACCOUNTS,OWNERS,TRANSACTIONS,INCOMES

Check out our examples!

As there are many configurations you can make for the widget, we've included easy-to-use examples for common configurations of the widget.

  1. Generate access_token (OFDA) POST {{baseUrl}}/api/token/