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.

ParameterTypeDescription
access_tokenStartupA server-side generated token required to start the widget.
localeStartupThe language of the text in the widget.
institution_typesStartupThe institution types to display in the widget.
country_codesStartupThe countries to display in the widget.
access_modeStartupThe type of link to create using the widget.
external_idStartupAn additional identifier to apply to the link.
resourcesStartupDisplay institutions based on the Belvo resources that they support.
show_close_dialogStartupAllow you to disable the exit dialog.
show_abandon_surveyStartupAllow you to disable the exit survey.
company_iconBrandingYour company icon to display in the widget.
company_logoBrandingYour company logo to display in the widget.
company_nameBrandingYour company name to display in the widget.
company_benefit_headerBrandingTitle header for the company_benefit_content.
company_benefit_contentBrandingCustom informative text highlighting the benefit of connecting an account.
opportunity_lossBrandingCustom text to display when the user closes the widget before connecting their account.
social_proofBrandingBoolean 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.

FunctionTypeDescription
successCallbackFunctionCallbackCallback function used to handle successful link creation.
onEventCallbackFunctionCallbackCallback function used to handle send widget events.
onExitCallbackFunctionCallbackCallback function used to send information when a user exits the widget.