Advanced Integration

We hope you have gone through the FastLink 4 Documentation page that talks about the different FastLink product flows and provides details on how to integrate FastLink for Web.

For more information on errors, see Handling Errors.

Additional Params

You can further configure the FastLink application by passing additional launch parameters to customize the way FastLink application loads. In addition to passing the configName in the params object (as explained in the FastLink 4 Documentation page), the following types of additional parameters can be passed:

• Deep-Linking attributes: Pass the attributes to launch FastLink in the desired flow.
• Callback details: Pass the callback URL that has to be called when the flow ends and pass the callbackLocation, if the callback URL is used in an iFrame integration.

Deep-Linking Attributes

The different deep-linking flows are as follows:

• Link account
• Edit account
• Refresh account flow
• Account balance refresh
• Open Banking
  • Multiple Open Banking application support
  • Manage consent
  • Consent notifications
  • Renew consent

Without calling on a specific deep-linking flow, the FastLink application will start with selecting a site. Click to view the Select a Site screen.

Link Account

• Link account - Start with login form

  The FastLink aggregate account scenario allows you to deep-link the application to a specific provider and add all the accounts belonging to it. Pass flow=add and providerId to start with the site's account authentication screen. Click to view the Verify Credentials screen.

  

  Parameters to deep-link to the site's account authentication screen follow:

  Parameter Name	Description	Example
  flow	Pass add to invoke the aggregate account flow.	... window.fastlink.open({ ... params: { providerId : 16441, flow : 'add', configName : '<config-name-from-config-tool>' }, ... }, 'container-fastlink'); ...
  providerId	The unique identifier for a particular provider (site).
  groupId	The unique group identifier to get the single site experience. Note: Applies only to UK OB.	... window.fastlink.open({ ... params: { groupId : 23235, flow : 'add', configName : '<config-name-from-config-tool>' }, ... }, 'container-fastlink'); ...
  routingNumber	A bank routing number or routing transit number (RTN) is a nine-digit number used in the US to identify a financial institution in a transaction.	... window.fastlink.open({ ... params: { routingNumber : 11103093, flow : 'add', configName : '<config-name-from-config-tool>' }, ... }, 'container-fastlink'); ...

• Add Manual Account

  The add manual account flow allows you to deep-link the application to the Add Manual Account screen, so that consumers can manually add accounts that the Yodlee aggregation engine does not support. Click to view the Add Manual Account screen.

  

  Parameters to deep-link to the Add Manual Account screen follow:

  Parameter Name	Description	Example
  flow	Pass addManual to invoke the manual account flow.	... window.fastlink.open({ ... params: { flow : 'addManual', configName : '<config-name-from-config-tool>' }, ... }, 'container-fastlink'); ...

• Add Real Estate Account

  In the FastLink add real estate account flow, you can deep-link the application to the Add Real Estate Account screen to allow consumers to add the value of their home or property to their profile. Click to view the Add Real Estate Account screen.

  

  Parameters to deep-link to the Add Real Estate Account screen follow:

  Parameter Name	Description	Example
  flow	Pass addRealEstate to invoke the add real estate account flow.	... window.fastlink.open({ ... params: { flow : 'addRealEstate', configName : '<config-name-from-config-tool>' }, ... }, 'container-fastlink'); ...

Edit Account

• Edit account credentials flow

  The FastLink edit credentials flow allows you to view the edit credentials screen of an already linked provider account. Click to view the Edit Account Credential screen.

  

  Parameters to deep-link to the edit account view based on the providerAccountId follow:

  Parameter Name	Description	Example
  flow	The edit account credentials flow has to be invoked.	... window.fastlink.open({ ... params: { providerAccountId : 11799016, flow : 'edit', configName : '<config-name-from-config-tool>' }, ... }, 'container-fastlink'); ...
  providerAccountId	The unique identifier for a particular provider account for which the edit account credentials flow will be invoked.

• Edit manual account flow

  The FastLink edit manual account flow allows you to view the edit account screen of a manually added account. Parameters to deep-link to the edit manual account view based on the accountId follow:

  Parameter Name	Description	Example
  flow	Pass editManual to invoke the edit manual account flow.	... window.fastlink.open({ ... params: { accountId : <accountId>, flow : 'editManual', configName : '<config-name-from-config-tool>', container : <container> }, ... }, 'container-fastlink'); ...
  accountId	The unique identifier for a particular manual account for which the edit account flow will be invoked.
  container	The container of the account for which the edit account flow will be invoked. Applicable container values: bank, creditCard, investment, insurance, loan, reward, bill, otherAssets, and otherLiabilities.

• Edit real estate account flow

  The FastLink edit real estate account flow allows you to view the edit account screen of an already added real estate account. Parameters to deep-link to the edit real estate account view based on the accountId follow:

  Parameter Name	Description	Example
  flow	Pass editRealEstate to invoke the edit real estate account flow.	... window.fastlink.open({ ... params: { accountId : <accountId>, flow : 'editRealEstate', configName : '<config-name-from-config-tool>' }, ... }, 'container-fastlink'); ...
  accountId	The unique identifier for a particular real estate account for which the edit account flow will be invoked.

Refresh Account Flow

The FastLink refresh account flow allows you to initiate the refresh of an already linked provider account and update with the latest data. This flow may prompt for the additional multi-factor authentication (MFA) required by the site during login. Click to view the Refresh Account Login screen.

Parameters to deep-link to the refresh account view follow:

...
window.fastlink.open({
    ...
	params: { providerAccountId : 11799016,
		flow : 'refresh',
		configName : '<config-name-from-config-tool>'
		}, 
		...
	}, 'container-fastlink');
...

Account Balance Refresh

The balance refresh verification flow allows you to verify accounts by performing an on-demand refresh to get the latest account balance. The balance refresh flow can only be invoked when the Verification config name is passed.

Parameters to deep-link to the balance refresh flow follow:

...
window.fastlink.open({
    ...
	params: { providerAccountId : 11799016,
		flow : 'balanceRefresh',
		configName : '<config-name-from-config-tool>'
		}, 
		...
	}, 'container-fastlink');
...

Open Banking

Multiple Open Banking Application Support

If the customer has multiple OB application, passing the following parameter will launch the particular application:

...
window.fastlink.open({
    ...
	params: { providerId : 16441,
		flow : 'add',
		configName : '<config-name-from-config-tool>'
		obAppName: '<OB-application-name-from-config-tool>'
		}, 
		...
	}, 'container-fastlink');
...

Manage Consent

The consent dashboard or manage consent feature in the UK OB and AU OB lets consumers renew or delete their consent to share account data (for the sites that require the consumer’s consent).

• Consent dashboard – Parameters to deep-link to launch the consent dashboard for UK OB and AU OB follow:

  Parameter Name	Description	Example
  flow	The manageConsent flow has to be invoked to launch the consent dashboard.	... window.fastlink.open({ ... params: { flow : 'manageConsent', configName : '<config-name-from-config-tool>' }, ... }, 'container-fastlink'); ...

• Consent details – Parameters to deep-link to the consent details screen of a particular financial institution follows:

  Parameter Name	Description	Example
  flow	The manageConsent flow has to be invoked to launch the consent dashboard.	... window.fastlink.open({ ... params: { providerAccountId : 11799016, flow : 'manageConsent', configName : '<config-name-from-config-tool>' }, ... }, 'container-fastlink'); ...
  providerAccountId	The unique identifier for the provider account has to be mandatorily passed for which the consent details are displayed.

Consent Notifications – AU OB

The notification screen notifies the consumer if it has been more than 90 days since the consumer has provided consent to the collection and the use of the account data.

Parameter to deep-link to consent notifications follow:

...
window.fastlink.open({
    ...
	params: { flow : 'notifications',
		configName : '<config-name-from-config-tool>'
		}, 
		...
	}, 'container-fastlink');
...

Renew Consent – UK OB

A consumer can choose to renew consent if, for example, the selection of accounts has changed at the financial institution site or consent is about to expire at the site and it has to be renewed.

Parameters to launch the renew consent flow follows

...
window.fastlink.open({
    ...
	params: { providerAccountId : 11799016,
		flow : 'renew',
		configName : '<config-name-from-config-tool>'
		}, 
		...
	}, 'container-fastlink');
...

Callback Details

The callback details allow you to receive the control from the FastLink application at the end of the flow or when the user exits the application. The parameters to define the callback URL and location follow:

...
window.fastlink.open({
    ...
	params: { callback : '<URL>,
		callbackLocation : 'top',
		configName : '<config-name-from-config-tool>'
		}, 
		...
	}, 'container-fastlink');
...

Post Messages

The FastLink application shares the account addition status with the customer application using the following four callback methods:

• onSuccess(data)
• onError(data)
• onClose(data)
• onEvent(data)

The callback/post message attributes follows:

onSuccess(data) Method

The onSuccess(data) method reports intermediate account addition events to inform the customer that the consumer’s account is successfully added.

onError(data) Method

The onError(data) method reports intermediate account addition failure event, integration error, and FastLink application launch error.

{
   "providerId":16441,
   "providerName":"Dag Site",
   "requestId":"rsglj0CIMoQsopKQrNLE4fz7nzE=",
   "reason":"Please visit Dag Site to update your account information or password.",
   "status":"FAILED",
   "additionalStatus":"USER_ACTION_NEEDED_AT_SITE",
   "providerAccountId":11350520
}

{
   "code":"NXXX",
   "title":"{error_title_NXX}",
   "message":"{error_description_NXX}",
   "fnToCall":"errorHandler",
   "redirectUrl":"{sso_redirect_url}"
}

{
   "code":"E701",
   "title":"INVALID_PARAMETER_OR_VALUE",
   "message":"Invalid value for providerId",
   "fnToCall":"errorHandler"
}

onClose(data) Method

The onClose(data) method refers to the action where a consumer has exited or terminated the flow – either abruptly or intentionally, which marks the end of the session.
Following are the possible exit points where an exit post message will be received:

• Clicking or tapping the X or close icon in the header of the FastLink application.
• Clicking or tapping exit points such as Cancel, Save, or Finish buttons in the success screen.
• Clicking or tapping the Close button in the error screen.
• Clicking or tapping the Save & Link More Accounts button in the add deep-link flow.

{
   "action":"exit",
   "fnToCall":"accountStatus",
   "sites":[
      {
         "providerId":5,
         "providerName":"Wells Fargo",
         "requestId":"vNHnOZ05sXZF1gFzEpF9BoMlSt0=",
         "status":"SUCCESS",
         "additionalStatus":"AVAILABLE_DATA_RETRIEVED",
         "providerAccountId":11333937
      }
   ]
}

{
   "action":"exit",
   "fnToCall":"accountStatus",
   "sites":[
      {
         "providerId":5,
         "providerName":"Wells Fargo",
         "requestId":"vNHnOZ05sXZF1gFzEpF9BoMlSt0=",
         "status":"SUCCESS",
         "additionalStatus":"AVAILABLE_DATA_RETRIEVED",
         "accountId":134539937,
         "providerAccountId":11333937,
         "isAlreadyVerified":false
      }
   ]
}

{
   "action":"exit",
   "fnToCall":"accountStatus",
   "sites":[
      {
         "providerId":5,
         "providerName":"Wells Fargo",
         "requestId":"vNHnOZ05sXZF1gFzEpF9BoMlSt0=",
         "status":"FAILED",
         "additionalStatus":"NO_ACCOUNTS_FOR_VERIFICATION",
         "providerAccountId":11333937,
         "reason":"You do not have any accounts eligible for verification with this site. Verification eligibility is determined by Company based on the type of data available for this account."
      }
   ]
}

{
   "action":"exit",
   "fnToCall":"accountStatus",
   "sites":[
      {
         "providerId":5,
         "providerName":"Wells Fargo",
         "requestId":"4CQQB7ylnUJcI7DR/D3z111lPy8=",
         "reason":"User cancelled the linking process confirming account deletion.",
         "status":"ACTION_ABANDONED",
         "providerAccountId":11333937
      }
   ]
}

{
   "action":"linkAnotherSite",
   "fnToCall":"accountStatus,
   "sites":[
      {
         "providerId":5,
         "providerName":"Wells Fargo",
         "requestId":"vNHnOZ05sXZF1gFzEpF9BoMlSt0=",
         "status":"SUCCESS",
         "additionalStatus":"AVAILABLE_DATA_RETRIEVED",
         "providerAccountId":11333937
      }
   ]
}

{
   "action":"exit",
   "fnToCall":"accountStatus",
   "sites":[
      {
         "accountId":12658703,
         "accountType":"CD",
         "providerAccountId":11548845,
         "container":"bank",
         "status":"SUCCESS",
         "isManual":true
      }
   ]
}

{
   "action":"exit",
   "fnToCall":"accountStatus",
   "sites":[
      {
         "accountId":12658703,
         "accountType":"CD",
         "providerAccountId":11548845,
         "isDeleted":true,
         "container":"bank",
         "status":"SUCCESS",
         "isManual":true
      }
   ]
}

[
   {
      "action":"exit",
      "fnToCall":"accountStatus",
      "sites":[
         {
            "accountId":13078724,
            "accountType":"Real Estate",
            "providerAccountId":11545871,
            "container":"realEstate",
            "status":"SUCCESS",
            "valuationType":"SYSTEM"
         }
      ]
   },
   {
      "action":"exit",
      "fnToCall":"accountStatus",
      "sites":[
         {
            "accountId":13078722,
            "accountType":"Real Estate",
            "providerAccountId":11545869,
            "container":"realEstate",
            "status":"SUCCESS",
            "valuationType":"MANUAL"
         }
      ]
   }
]

{
   "action":"exit",
   "fnToCall":"accountStatus",
   "sites":[
      {
         "accountId":13078722,
         "accountType":"Real Estate",
         "providerAccountId":11545869,
         "container":"realEstate",
         "status":"SUCCESS",
         "valuationType":"MANUAL",
         "isDeleted":true
      }
   ]
}

{
   "action":"exit",
   "fnToCall":"accountStatus",
   "sites":[
      {
         "providerId":5,
         "providerName":"Dag oAuth",
         "requestId":"vNHnOZ05sXZF1gFzEpF9BoMlSt0=",
         "status":"MIGRATION_IN_PROGRESS",
         "additionalStatus":"MIGRATION_IN_PROGRESS",
         "providerAccountId":11333937
      }
   ]
}

onEvent(data) Method

The onEvent(data) method is called to notify intermittent status messages to the host application.

Challenge Deposit Verification Entry Point Post Messages

The challenge deposit verification (CDV) or manual verification entry point post messages are as follows:

{
   "pageName":"SELECT_A_SITE",
   "action":"cdv_exit",
   "type":"CDV",
   "pageTitle":"SITE_SELECTION"
}

{
   "pageName":"SITE_SEARCH",
   "action":"cdv_exit",
   "type":"CDV",
   "pageTitle":"SITE_SELECTION"
}

{
   "pageName":"LOGIN_PAGE",
   "action":"cdv_exit",
   "type":"CDV",
   "pageTitle":"LOGIN"
}

{
   "pageName":"ERROR_PAGE",
   "action":"cdv_exit",
   "type":"CDV",
   "pageTitle":"ERROR"
}

{
   "pageName":"ACCOUNT_SUMMARY",
   "action":"cdv_exit",
   "type":"CDV",
   "pageTitle":"ACCOUNT_SUMMARY"
}