General
Individual elements of the form can be shown, hidden, or adjusted independently. This allows you to keep the interface minimal for embedded flows or provide a more complete experience for standalone use.
Header
The form header can be shown or hidden. Hiding the header also removes the language selector.
If you hide the header, lock the form to a specific language to ensure the desired language is used. See Language & Localization.
Cancel Button
The Cancel button allows users to exit the current flow. You can hide it when your application provides its own cancellation option.
Note: Only hide the Cancel button when the form is embedded in your own container and your application handles cancellation. When a user cancels through your application, call the Cancel a web form service (
POST /api/webForms/{id}/cancel).
Progress Bar
The progress bar indicates the user's current position in the flow. It can be shown or hidden.
Note: The progress bar is available only in web form 2.0. Web form 2.1 does not display a progress bar.
Footer & Logos
The footer includes two trust indicators: the finAPI attribution and the TÜV certification mark.
The TÜV mark can be hidden for a cleaner appearance. The finAPI attribution remains visible, but you can choose whether it is displayed as the finAPI logo or as plain "finAPI" text.
Bank Banner
During login and authentication, the form displays a banner with the selected bank's branding. You can hide the banner for a more neutral appearance.
Featured Bank Groups
The bank search can display a curated selection of bank groups for quick access. You can choose to show or hide these featured groups.
Bank Search Default Country
You can define which country is preselected when the bank search opens. Set this to the country most relevant to your users or primary market.
Bank Login Hint
Some banks provide additional information to help users identify their login credentials. You can control how this hint is displayed:
-
Expanded — the hint is visible by default.
-
Collapsed — users can expand the hint when needed.
-
Hidden — the hint is not displayed.
Terms & Conditions
The terms and conditions text supports two presentation styles:
-
BASIC — states that the connection is established via finAPI.
-
EXPLICIT — additionally identifies the services used for the connection: account information (AIS) and payment initiation (PIS).
Technical Setup
Configure UI element settings under functionality in the profile. The finAPI footer attribution is configured separately under brand.
All fields are optional. If a field is not specified, the default value listed in the corresponding table applies.
Fields
|
Field |
Values |
Default |
Description |
|---|---|---|---|
|
|
|
— |
How the finAPI attribution in the footer is rendered — |
|
|
|
|
Form header visibility |
|
|
|
|
Cancel button visibility. Web form 2.1 only. |
|
|
|
|
Progress bar visibility. Web form 2.0 only. |
|
|
|
|
TÜV certification mark visibility |
|
|
|
|
Bank branding banner (bank logo and name) visibility |
|
|
|
— |
Whether the most popular bank groups are highlighted on the bank search screen. Web form 2.1 only. |
|
|
ISO 3166-1 two-letter code |
|
Default country pre-selected in bank search. Falls back to |
|
|
|
|
Bank login hint display mode. |
|
|
|
|
Terms and conditions presentation style. Changeable only by finAPI support — see the note below. |
termsAndConditionsText can be changed only by the finAPI support team. Finalize the rest of your customization first, then email support@finapi.io with your profile.id.
Footer visibility, finAPI logo visibility and the terms & conditions checkbox itself are not part of the profile API — they follow your finAPI licence. Contact your finAPI contact person if you need them adjusted.
Example
{
"brand": {
"finapiFooterBranding": "ICON"
},
"functionality": {
"header": "RENDER",
"cancelButton": "RENDER",
"tuvLogo": "RENDER",
"bankBanner": "RENDER",
"featuredBankGroups": "RENDER",
"bankSearch": {
"defaultCountry": "DE"
},
"bankLoginHint": "EXPANDED",
"termsAndConditionsText": "EXPLICIT"
}
}