SDK Route Events - Web

Overview

When using the SDK embedded iFrame implementation for Finicity Connect there are route events available. Fincity Connect will send events through the SDK as the user progresses through the app.

This article assumes a basic familiarity with route events. If you are unfamiliar with route events, here are a few websites that give some information on them.

There are several route events that can be subscribed or listened to with SDK implementation. These routes are also available via the console log of the browser you’re using.

Once subscribed or listening for these route events, the front end of your application will be able to receive the events. You will need to have a way for the information to move from the front end to the back end of your application, where the information will help inform the flow and next steps.

Institution Search

Institution Search Events
 // initial event
{
"type": "route",
"data": {
"screen": "Search",
"params": {}
}
}

// event after searching for an institution
{
"type": "route",
"data": {
"screen": "Search",
"params": {
"query": "finbank",
"found": 5
}
}
}

// event after searching for an institution with no results
{
"type": "route",
"data": {
"screen": "Search",
"params": {
"query": "nobank",
"found": 0
}
}
}

Add Institution

Add Institution
 {
"type": "route",
"data": {
"screen": "Add-Institution",
"params": {
"id": "101732"
}
}
}

Add OAuth Institution

Add OAuth Institution
 {
"type": "route",
"data": {
"screen": "Add-Oauth-Institution",
"params": {
"id": "12224"
}
}
}

Add Accounts

Add Accounts
 {
"type": "route",
"data": {
"screen": "Add-Accounts",
"params": {}
}
}

Done

This doesn’t mean the user is done, this is just the screen when the user has the option to submit their info or add another account.

Done
 {
"type": "route",
"data": {
"screen": "Done",
"params": {}
}
}

Select Error Account

Select Error Account
 {
"type": "route",
"data": {
"screen": "Select-Error-Accounts",
"params": {}
}
}

Fix Error Account

Fix Error Account
 {

"type": "route",
"data": {
"screen": "Fix-Error-Accounts",
"params": {
"institutionLoginId": "20768778"
}
}
}

Fix Error OAuth Account

Fix Error OAuth Account
 {
"type": "route",
"data": {
"screen": "Fix-Error-OAuth-Accounts",
"params": {
"institutionLoginId": "20768778"
}
}
}