Initiate Bank
Initiates the bank connection flow for a tenant.
Asynchronous Operation
This endpoint initiates an Asynchronous process. The API response confirms that the bank flow has been started, while bank connectivity and financial analysis are processed in the background.
After the bank connection is completed, the system receives the user’s bank data. Based on the received bank data, financial analysis is performed in the background.
Completion or failure of the bank connectivity must be determined using iframe events and webhook notifications.
Iframe Events
-
BANK_SUCCESS
Triggered when the Bank flow is completed successfully and banking data has been submitted for analysis. -
BANK_FAILURE
Triggered when the Bank flow fails or an error occurs at any stage of the bank connection process.
Post-Analysis Webhooks
After bank analysis is completed, following webhook events will be sent:
-
FINANCIAL_ANALYSIS_SUCCESS
Indicates that banking analysis has completed successfully. -
FINANCIAL_ANALYSIS_FAILURE
Indicates that banking analysis has failed.In case of failure, detailed error information can be retrieved by calling Get Tenant API and inspecting the
financial_info_errorsfield in the tenant data.Based on the reported error, clients may retry the banking analysis by re-initiating the bank flow once the issue has been addressed.
Authorizations
HTTP Bearer Authentication. Pass the token generated via
/keys/generate-token as Authorization: Bearer <token>.
Path Parameters
Query Parameters
Supported country for Bank connection.
belgium, germany, denmark, estonia, spain, finland, france, unitedKingdom, italy, lithuania, latvia, netherlands, norway, poland, portugal, sweden