Optional clientclientReference will be considered only when you authenticate with
mandatorId.
The clientReference setting can be used to customize the widget's
process. Not all widgets use this setting, so please refer to the widget's
documentation for more details.
Optional clientclientReferenceKey will be considered only when you authenticate with
mandatorId.
The clientReferenceKey allows you to label the widget instance with a
keyword, so you can monitor the success of the widgets with the given
reference key.
For instance, if you are running various campaigns to advertise a new product, you could provide campaign identifiers in the reference key. Then, the user usage data can be retrieved from the Process Controller API.
Optional demoSpecifies the URL of a PDF file containing the results. Under typical circumstances, when reaching the final view displaying the results, users have the option to download the results in PDF format from the Process Controller API. If this property is configured, the application will directly open the specified URL in a new tab, bypassing the need to query the API.
Optional errorWhere the browser goes when the widget fails, in place of showing the error view and in place of the error redirect URL in your finAPI configuration.
The same rules as for redirectUrl apply, checked against the error
redirect URL pattern of your finAPI configuration.
Selects the use case the widget runs. This property is mandatory, the widget shows a validation error when it is not provided.
Optional ibanIf you provide the iban, the account import will begin with the
predefined IBAN, and the user will not be able to select any other
account.
Optional importServer URL from which the Web Form's JS bundle is fetched during the account import. This property is intended for testing and development only, for example when the account import has to run against a non-production Web Form. The server must belong to one of the finAPI domains. If no value is provided, the Web Form determines the server on its own, defaulting to its live environment.
Optional jsServer URL where the static resources are hosted.
Static resources are assets required to run the widget but are not included in the widget bundle itself, for example images or fonts.
https://js-static-resources-finapi-general-live.finapi.io
Optional languageIt allows you to set the language for the widget. Each widget may have its own list of supported languages. If a language that is not supported is selected, the widget will not start and instead show a validation error. Therefore, it is important to verify beforehand if all intended languages are supported.
If a language is specified, the widget will not display the language selector in the header.
Optional mandatorWidget's authentication can be done by providing either a processToken
or a mandatorId. If both are provided, the processToken will take
precedence.
After registering, you will be provided with a UUID known as the 'mandatorId'. Once you provide the 'mandatorId', the widget will automatically generate a 'processToken' for the predefined Client associated with your Mandator.
Optional processWidget's authentication can be done by providing either a processToken
or a mandatorId. If both are provided, the processToken will take
precedence.
The processToken is a UUID and must be obtained from
the API before authentication by providing Client credentials.
Optional processctlServer URL of the Process Controller API.
https://di-processctl-finapi-general-live.finapi.io
Optional redirectWhere the browser goes once the user has completed the flow, in place of the redirect URL in your finAPI configuration.
The URL is used only if your finAPI configuration has a redirect URL
pattern and the URL matches that pattern as a whole. It must also be an
absolute http or https URL of at most 255 characters. Otherwise the
property is ignored, the reason is logged as a warning in the browser
console, and the widget goes on as if the property had not been set.
Optional scrollOptional enabled?: numberUpon setting this parameter to true window.history.scrollRestoration behaviour will be changed to manual in order for manual scroll to restore its position properly when navigating usign back/forward buttons.
Optional scrollYOffset?: number' Sets offset relative to widget element offset. Usually used for adding offset for the main menu.
Optional solutionsServer URL of the finAPI solutions API.
https://di-solutions-finapi-general-live.finapi.io
Optional stylestyleOverrides enables you to supply the URL of a stylesheet which will
be loaded in the widget scope using <link rel="stylesheet" href={styleOverrides} type="text/css" />. To find out which CSS classes
are available for override, please refer to the widget class
documentation.
Optional vwfsServer URL of the finAPI VWFS API.
https://di-solutions-finapi-general-live.finapi.io
Optional webThe Web Form v2 profile ID allows you to choose a profile for the Web Form. Profiles allow for customization of the appearance and behavior of the Web Form. For more details, please refer to the white-labeling documentation at https://documentation.finapi.io/webform/white-labeling. If no value is provided, the default Web Form profile will be used. If a value is specified, it must be a valid UUID.
Generated using TypeDoc
The widget is built with the finAPI WebForm design system, which is themed with a WebForm profile. Therefore the widget does not support the
themeandthemeOverridesproperties.