Interface GiroIdentProperties

interface GiroIdentProperties {
    clientReference?: string;
    clientReferenceKey?: string;
    companyName?: string;
    firstName: string;
    iban?: string;
    jsStaticResourcesServer?: string;
    language?: string;
    lastName: string;
    mandatorId?: string;
    processToken?: string;
    processctlServer?: string;
    processctlSolutionsServer?: string;
    scroll?: {
        enabled?: number;
        scrollYOffset?: number;
    };
    skipResults?: boolean;
    startButtonLabel?: string;
    styleOverrides?: string;
    theme?: string;
    themeOverrides?: Record<string, unknown>;
    useContainedDialogs?: boolean;
    webFormProfileId?: string;
}

Hierarchy (view full)

Properties

clientReference? clientReferenceKey? companyName? firstName iban? jsStaticResourcesServer? language? lastName mandatorId? processToken? processctlServer? processctlSolutionsServer? scroll? skipResults? startButtonLabel? styleOverrides? theme? themeOverrides? useContainedDialogs? webFormProfileId?

Properties

Optional clientReference

clientReference?: string

clientReference 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 clientReferenceKey

clientReferenceKey?: string

clientReferenceKey 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 companyName

companyName?: string

Optional company name. The company name does not contribute to the name similarity evaluation. It may stored with the check e.g. for compliance reasons.

firstName

firstName: string

User's first name.

Optional iban

iban?: string

If 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 jsStaticResourcesServer

jsStaticResourcesServer?: string

Server 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.

Default

https://js-static-resources-finapi-general-live.finapi.io

Optional language

language?: string

It 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.

lastName

lastName: string

User's last name

Optional mandatorId

mandatorId?: string

Widget'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 processToken

processToken?: string

Widget'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

processctlServer?: string

Server URL of the Process Controller API.

Default

https://di-processctl-finapi-general-live.finapi.io

Optional processctlSolutionsServer

processctlSolutionsServer?: string

Server URL of the Process Controller Solutions API.

Default

https://di-processctl-finapi-general-live.finapi.io

Optional scroll

scroll?: {
    enabled?: number;
    scrollYOffset?: number;
}

Type declaration

  • Optional enabled?: number

    Upon 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 skipResults

skipResults?: boolean

With skipResults set to true, the view displaying the evaluation result will not be shown.

Optional startButtonLabel

startButtonLabel?: string

The startButtonLabel property enables you to customize the label of the button displayed on the initial view, which initiates the evaluation process.

Optional styleOverrides

styleOverrides?: string

styleOverrides 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 theme

theme?: string

The theme property enables you to select a predefined theme to be applied to the widget.

Default

finapi

Optional themeOverrides

themeOverrides?: Record<string, unknown>

Our theme extends the default Material UI theme, which can be found at https://mui.com/material-ui/customization/default-theme/#main-content. themeOverrides can be used to customize the theme settings for specific cases. If you need help with this, please contact our customer support for assistance.

Optional useContainedDialogs

useContainedDialogs?: boolean

The widget will be embedded in a container that you provide. If useContainedDialogs is set to true, the dialogs and modal elements, along with the overlay, will be contained within the container. If it is set to false, the overlay and modals will cover the entire host page.

Default

true

Optional webFormProfileId

webFormProfileId?: string

The 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.

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc