In order to access use Everifin services via API two account types BankConnect API the following prerequisites are required:
Client service account - the service account generated by Everifin and dedicated to specific client; It is required to access identity provider’s authentication API
Everifin Multibanking user account - user account in Everifin representing particular bank account(s) owner; It can be physical person or representative of some business entity (it can be your customer or you in case you need to access your own bank accounts); This user will connect bank account(s) to Everifin system; Consequently, the Everifin services related to these bank accounts can be accessed via API by using this user’s access token (obtained after successful login).
Connection of the Everifin Multibanking user account to your system - more details are present in the further text below.
Client Service Account
| Info |
|---|
To configure service account, the client needs to provide redirect URLs (at least the domains) that will be used during developing, testing and production phase. |
...
Everifin Multibanking user account registration - The person/company needs to create a user account in Everifin Multibanking web application. Please, instruct your customer to go to web app URL https://app.everifin.com to do so (you may provide clickable link or button in you SW). The user registration process is described in detail here: Everifin User Registration
Bank Account(s) connection - The person/company needs to connect the bank account(s) in Everifin Multibanking web application. This process is described in detail here: Connecting Bank Account
Connecting Everifin Multibanking user account to your system - The connection between the two systems is arranged by Oauth authorization code flow initiated by your system against our identity provider (Authentication ). The details of the connection process are described further below (https://everifin.atlassian.net/wiki/spaces/EFMBAPI/pages/edit-v2/2515730433#Connecting-Everifin-user-account-to-your-system ). Result of this step is session between your system and Everifin represented by pair of tokens (access and refresh token). Valid access token needs to be provided in every API request.
After these steps are completed, your system is able to use API and Everifin BankConnect API (e.g. get bank account data of your customer).
Identity provider host-name
The following table provides the values value for identity provider host-name in testing and production environments.
IdP Host-name wildcard | Testing environment | Production environmentIdP hostname |
|---|---|---|
|
|
Connecting Everifin user account to your system
...