Widget parameter and function reference

A reference page for all the parameters and functions used by the widget.

Parameters

Click on the link in the type column to go directly to the documentation for the given parameter.

Parameter

Type

Description

access_token

Startup

A server-side generated token required to start the widget.

locale

Startup

The language of the text in the widget.

institution_types

Startup

The institution types to display in the widget.

country_codes

Startup

The countries to display in the widget.

access_mode

Startup

The type of link to create using the widget.

external_id

Startup

An additional identifier to apply to the link.

resources

Startup

Display institutions based on the Belvo resources that they support.

show_close_dialog

Startup

Allow you to disable the exit dialog.

show_abandon_survey

Startup

Allow you to disable the exit survey.

company_icon

Branding

Your company icon to display in the widget.

company_logo

Branding

Your company logo to display in the widget.

company_name

Branding

Your company name to display in the widget.

company_benefit_header

Branding

Title header for the company_benefit_content.

company_benefit_content

Branding

Custom informative text highlighting the benefit of connecting an account.

opportunity_loss

Branding

Custom text to display when the user closes the widget before connecting their account.

social_proof

Branding

Boolean to display the "+1m users have securely connected their accounts using Belvo" message in the account connect screen.

Functions

Click on the link in the type column to go directly to the documentation for the given function.

Function

Type

Description

successCallbackFunction

Callback

Callback function used to handle successful link creation.

onEventCallbackFunction

Callback

Callback function used to handle send widget events.

onExitCallbackFunction

Callback

Callback function used to send information when a user exits the widget.


Did this page help you?