Event Listener
Flinks Connect triggers events according to authentication responses or different UI steps that are presented to the end-user.
These events can be listened by using JavaScript event listeners and can be useful tools for tracing purposes as well as controlling the user experience.
To have the Event Listener enabled in your page, you need to make sure that you have the following script in your page:
<!-- Event Listener -->
<script>
window.addEventListener('message', function(e) {
console.log(e.data);
});
</script>
Types of events and their meanings
| Event | Meaning |
|---|---|
| APP_MOUNTED | The internet connection was restored |
| APP_ONLINE | The internet connection was restored |
| APP_OFFLINE | The internet connection was lost |
| ACCOUNT_SELECTED | The user selects an account |
| COMPONENT_ACCEPT_CONSENT | The user accepts to give consent |
| COMPONENT_ACCEPT_TERMS | The user has checked the box to approve the terms and conditions linked in the URL termsUrl={https://example.com}. |
| COMPONENT_CLICK_RESET_PASSWORD | The user clicks on the Reset Password button. |
| COMPONENT_CLICK_TERMS_URL | The user clicks on the terms and conditions link. |
| COMPONENT_DENY_CONSENT | The user denies consent |
| COMPONENT_DENY_TERMS | The user unchecked the box on the left of the terms and conditions using the parameter termsUrl={https://example.com}. |
| COMPONENT_LOAD_ACCOUNT_SELECTION | When Flinks Connect loads the account selection page. Contains metadata regarding the user's accounts (totalAccounts & displayedAccounts) |
| COMPONENT_LOAD_CONSENT | The consent page is loaded using the parameter consentEnable=true |
| COMPONENT_LOAD_CREDENTIAL | The user is faced with a prompt for FI username and password. |
| COMPONENT_LOAD_CREDENTIAL_RETRY | The user clicks on retry after an authorize error |
| COMPONENT_LOAD_INSTITUTION_SELECTOR | The FI list page is loaded |
| COMPONENT_LOAD_MFA | The MFA page is loaded. Contains metadata that indicates what MFA challenges the user received (mfaTypes) |
| COMPONENT_LOAD_MFA_RETRY | The user clicks on retry after a failed MFA challenge.error |
| DISABLED_INSTITUTION | An Institution is disabled. |
| ENHANCED_MFA_HAS_QUESTIONS | When there is unanswered question using enhancedMFA=true |
| ENHANCED_MFA_NO_QUESTIONS | When there is no unanswered question using enhancedMFA=true |
| ENHANCED_MFA_SUCCESS | Successfully completed the enhancedMFA flow using enhancedMFA=true |
| INSTITUTION_SELECTED | The user selected his desired Financial Institution. |
| INVALID_INSTITUTION | An institution is not valid. |
| INSTITUTION_NOT_AVAILABLE | An institution is not available. |
| INVALID_SECURITY_RESPONSE | The MFA challenge failed. |
| MAXIMUM_RETRY_REACHED | The maximum amount of retries is reached using the parameter maximumRetry={number}. It is set in the URL as a parameter. |
| QUESTION_NOT_FOUND | The MFA challenge is returned by the API. Contains metadata that indicates what MFA challenges the user received (mfaTypes) |
| REDIRECT | When the user successfully completed the connection and is redirected using the parameter redirectUrl={https://example.com} |
| RETRY_COUNT | The authorization failed and the retry count is incremented. Staring at 0. |
| SESSION_NONEXISTENT or SESSION_EXPIRED | When the session expired. |
| SESSION_STORAGE_BLOCKED | Legacy cookie management (deprecated) |
| SESSION_STORAGE_BLOCKED_RETRY | Legacy cookie management (deprecated) |
| SKIP_ENHANCED_MFA | The user skips the unanswered MFA question using skipEnhancedMFA=true |
| SUBMIT_ANSWER_MFA_QUESTIONS | The user submits the unanswered MFA questions |
| SUBMIT_CREDENTIAL | The form is valid and the user clicks on continue. |
| SUBMIT_GET_MFA_QUESTIONS | When Flinks Connect gets unanswered MFA questions using enhancedMFA=true |
| SUBMIT_MFA | The user submits the MFA |
Updated 22 days ago
What's Next
Knowing how to handle the Events is essential for controlling your user experience. If you think you have it all covered, you can jump right on the steps to get your integration ready!
| Start your Integration |
| Configure and Install Flinks Connect |