Welcome to Fimento's Bank Data Insights API documentation, a resource that facilitates access to bank data insights and enables the initiation of data collection processes. This API serves as a tool for developers and businesses seeking to integrate financial information seamlessly. Access to the API requires credentials, which are provided exclusively by our sales team. Throughout this documentation, you'll find detailed information on the API's functionalities and authentication procedures. Dive in to discover how the Bank Data Insights API can contribute to your projects by providing essential banking data access and processing capabilities.

There are three main flows surrounding the usage of the API:

• Collecting the consent and the bank data from the end user
• Collecting the insights from this bank data for automated credit decision
• Visualising the insights from this bank data for manual investigation as part of a credit decision

This API is using a Bearer authentication. All endpoints except from the login endpoint requires a valid authentication token to be present in the authorization header as a Bearer token.

The login endpoint can be used to retrieve a new authentication token using a username and password. They should be provided by the Fimento team as part of the onboarding process to our services. An authentication token is valid for a limited time. It should be cached on the API client side during its validity period to avoid unnecessary calls to the login endpoint. The login endpoint returns the validity time of the token as a convenience to set a time to live (TTL) for caching the auth token.

To explore the demo/testing environment, use the demo API user on the production server and follow the usual endpoints. Demo credentials will be provided by Fimento upon request. Within the production environment, two sets of credentials are available: one for demo/testing purposes, using only test data from our bank data provider, and another for authentic scenarios, incorporating real bank data.

For testing the demo flow with your demo API user, employ our test SSNs designed for both "bad" and "good" customer scenarios. Use the specified SSN when initiating a new process.

We set the overall flow status on the process itself (consentFlowStatus) and more bank/user specific flow status in the customer bank process (customerBankConsent[].status). The order of the statuses should be set in the order they are presented in the tables below. In addition, that the Customer Bank Consent statuses is set "between" the consentLinkOpened and customerApprovedConsent in the consentFlowStatus field. I.e. after the consentLinkOpened status is set in the consentFlowStatus field, the next status that should be set is the bankAddedNotCompletedAuthFlow in the customerBankConsent[].status field and then the subsequent Customer Bank Consent status.

The customerApprovedConsent and customerDeniedConsent can be set anytime after the fetchingTransactionsStarted is set.

The status has the following structure.

const status = {
  code: 'string',
  desc: 'string',
  timestamp: '2024-01-12T17:04:56.239+00:00',
  isError: boolean, // on authError only
  errorMessage: 'string', // on authError only
};

Consent flow statuses

Is set in the consentFlowStatus field on the process.

* Can be set anytime after the fetchingTransactionsStarted is set

Customer Bank Consent status

is set in customerBankConsent.status array

*** In addition to the statuses we set a string value to the consent field when the user has revoked or approved the consent to share the data.

null - initial value, neither revoked or approved,
"revoked" - revoked consent
"approved" - approved consent

Use these endpoints to retrieve the credit insights data generated after the the data collection process.