FastLink 3.0 Integration Guide

Deprecated

The information on this page has been deprecated, but is still available for developer convenience in upgrading. The current information can be found at https://developer.yodlee.com/docs/fastlink/3.0/getting-started

Introduction

FastLink is an application that lets consumers add accounts by searching for the website of a financial institution and entering the login credentials for the account(s) held there. Consumers can add savings, checking, investment, credit card, insurance accounts, and more.

Benefits of using FastLink

1. Allows consumers to edit the login credentials for their online accounts using the edit site credentials flow.
2. Includes an account verification process that prompts consumers to verify ownership of accounts at held away sites.
3. Can be integrated with Web pages hosted by a customer's application server external to the Yodlee application.
4. Can be launched by consumers through a link provided in the customer’s application.

Step 1: Cobrand Login

In the cobrand login step, the customer application is authenticated by the Yodlee Server. The cobrand login REST API accepts the cobrand credentials; once authenticated a cobSession is created and returned in an API response.
Refer to the POST /cobrand/login endpoint for details.

Sample request

Endpoint


POST /cobrand/login

Headers

"Content-Type" : "application/json"
"Api-Version" : "1.1"
"Cobrand-Name" : "restserver"

Body

{
    "cobrand":{
        "cobrandLogin":"exampleCobrand",
        "cobrandPassword":"examplePassword"
    }
}

Response

{
    "cobrandId": 10010352,
    "applicationId": "3A4CAE9B71A1CCD7FF41F51006E9ED00",
    "locale": "en_US",
    "session": {
        "cobSession": "08062013_1:1248d0142f398a68b7125bc2199f6ec242d310b75f6bfde65efba7901340fa272b1b3f7f68a3297a0c2c4b5a56c2809fad4f03bcd7f7f53d4d545389eb9cb4b7"
    }
}

Step 2: User Login

The User Login API enables the consumer (end user) to log in to the application. Once the consumer has logged in, userSession is returned in the API response.
Refer to the POST /user/login endpoint for details.

Sample request

Endpoint

POST /user/login

Headers

"Content-Type" : "application/json"
"Authorization" : "cobSession=08062013_1:1248d0142f398a68b7125bc2199f6ec242d310b75f6bfde65efba7901340fa272b1b3f7f68a3297a0c2c4b5a56c2809fad4f03bcd7f7f53d4d545389eb9cb4b7"
"Api-Version" : "1.1"
"Cobrand-Name" : "restserver"

Body

{
    "user":{
        "loginName":"exampleName",
        "password":"examplePassword",
        "locale":"en_US"
    }
}

Response

{
    "user": {
        "id": 10174097,
        "loginName": "sbMemd9c72e0f851702d88631d22dfc9b28f48a5",
        "name": {
            "first": "Corbin",
            "last": "NA"
        },
        "roleType": "INDIVIDUAL",
        "session": {
            "userSession": "08062013_0:640a053e3f7e078539bdf0557eaede5037e89505f6b3d6981a8b2369747561c7fec60f096d0fa9c9bc361559b82b4be0d5fc51af4376ff037ba11eb3f2212d4a"
        },
        "preferences": {
            "currency": "USD",
            "timeZone": "PST",
            "dateFormat": "MM/dd/yyyy",
            "locale": "en_US"
        }
}

Step 3: Get FastLink Token

Obtain a FastLink application token using the user token call. This token is used to authenticate the consumer's access to the FastLink FinApp.
Refer to the GET /user/accessTokens?appIds=10003600 endpoint for details. Note that the appIds value is a constant of 10003600 which represents FastLink.

Sample request

Endpoint

GET /user/accessTokens?appIds=10003600

Headers

"Authorization" : "cobSession=08062013_1:1248d0142f398a68b7125bc2199f6ec242d310b75f6bfde65efba7901340fa272b1b3f7f68a3297a0c2c4b5a56c2809fad4f03bcd7f7f53d4d545389eb9cb4b7,userSession=08062013_0:640a053e3f7e078539bdf0557eaede5037e89505f6b3d6981a8b2369747561c7fec60f096d0fa9c9bc361559b82b4be0d5fc51af4376ff037ba11eb3f2212d4a"
"Api-Version" : "1.1"
"Cobrand-Name" : "restserver"

Response

{
    "user": {
        "accessTokens": [
            {
                "appId": "10003600",
                "value": "d40445d64f1207ff368b7deac469dcd61ff07f832bab7900d8976342d3098a08",
                "url": "https://192.168.57.139:7100/authenticate/nodesmb/"
            }
        ]
    }
}

Step 4: Launch FastLink

Example of (POST) Request using HTML Form

Aggregation

By default, this will open the aggregation version of FastLink.

Account Verification

To open the Account Verification version of FastLink, append the following code to the form:

For Sandbox:

For other environments:

More on FastLink

For more things you can do with FastLink, look at the detailed FastLink document.