Skip to main content
Skip table of contents

Getting Started - Authorization


finAPI follows the OAuth 2.0 Standard for authorizing applications and users within them. OAuth uses the terminology of clients and users. A client represents an application that calls finAPI services. A service call might be in the context of a user of the client (e.g.: getting a user's bank connections), or outside any user context (e.g.: editing your client's configuration, or creating a new user for your client). In any case, every service call must be authorized by an access_token. The documentation below describes how to set up the client's users, or for the client itself.

To make authorization processes and user management easier finAPI offers 2 ways to use the services.


All authorized API endpoints are restricted to a set of scopes, that represent a (set of) finAPI products. Some endpoints may expect (additionally) dedicated administrative scopes. To get access granted, one of the scopes assigned to the caller’s access_token must match the expected scopes.

Product scopes are bound to your mandator definition and are assigned by the finAPI support team based on the ordered finAPI products.

The customer may create a dedicated administrative user with the reserved name client_admin, that will get access to endpoints that require the FINAPI_CLIENT_ADMIN scope.

The API Reference chapter describes how to find the required scopes for an endpoint.

Authorization and User Management Scenarios

A finAPI customer may want to use a single finAPI Data Intelligence solution or combine/use several of them for his product flow. Moreover, such a flow may require the use of finAPI’s multi-blanking service, finAPI Access, too.

Regardless of that, use cases can be divided into two basic scenarios.

One-Time User usage

For solutions, which don’t require recurring users like creating once a Report, GiroIdent, KreditCheck or other one-time services for a user, this guide explains how to get started.


Self-Usermanagement and Multi-Service usage

If you want to use multiple finAPI services and the OpenBanking platform for recurring users, this guide explains how to get started.


JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.