Skip to main content

Configuration

Provider options

Each option in the selection screen corresponds to one entry in your masOptions array. By default, each option shows the provider's standard name and icon. When a template is applied, the option can display a custom label, description and icon, for example to distinguish "MitID Business" from standard MitID, or to describe what a specific authentication method requires of the user.

Language

The MAS UI is available in 18 languages. You can pre-select the language using the uiLanguage parameter when creating the transaction. If the end-user changes the language in the UI, their choice takes precedence and is persisted for that session.

Supported values for uiLanguage: cs, da, de, el, en, es, et, fi, fr, hu, is, it, lt, lv, nl, no, pl, pt, sv.

Order of appearance

The order in which options are presented to the end-user in the MAS UI follows the order of items in the masOptions array. Arrange the array in the desired sequence and the UI will reflect it.

Single-option behaviour

By default, skipSingleOption is true: if only one option is provided in masOptions, the MAS selection screen is skipped and the end-user goes straight into that provider's flow.

Set skipSingleOption to false to always show the MAS UI, even with a single option. This is useful when combined with a template to create a landing page that informs the user about the process before they proceed, for example telling them that authentication is for the purpose of viewing a document (auth-to-view).

Templates

Templates let you set alternative copy and instructions for a specific provider option or for the MAS UI itself. This makes it possible to support provider variations such as BankID Extra Control or MitID Business, with appropriate context shown to the end-user.

All templates are translated into the 18 languages supported by eID Hub.

Provider templates

To apply a template to a specific provider option, include a templateID in the metadata parameter of that option's entry in masOptions. Provider templates add descriptive text beneath the option in the selection UI, helping users understand which method to choose.

The full list of available template IDs is in the reference map in the API documentation.

MAS UI templates

To apply a template to the MAS UI itself, include a templateID in the globalMetadataReference parameter on the transaction. Currently one UI template is available, designed for eSign auth-to-view flows.

The MainToViewTemplate replaces the default heading with copy suited for document viewing flows:

"Select one of the available options to confirm your identity and view the document(s). After selecting an option, follow the on-screen instructions to continue."

Pair it with skipSingleOption: false to create a single-option landing page for auth-to-view processes.

info

If none of the available templates fit your use case, you can submit a request to Scrive Support. Include a description of the use case, the providers it applies to, and the copy you need. Requests are evaluated based on how broadly useful the template would be across the customer base — we do not implement templates for single-customer use cases. Approval is not guaranteed.