Skip to main content

Account Selection and Tag

For specific use-cases, it is important to know which account the user will want to work with. For instance, for verifying an account, typically used for money transfers, knowing which account to draw money from is important to avoid NSFs.

Selected Account Identification

You can store the information about which account your user has selected by collecting and keeping the AccountId along with the loginId.
Custom tags can be used to mark specific requests or groups of requests according to your own context. For example, if you already have a specific UserId that you want to associate with a loginId, it can be done by using a tag.

Note:

Different tags need to be assigned directly in the iframe URL using the “Tag” parameter.

Handling AccountId and Tag

Using the same methods to receive the loginId, you are able to capture both Tag and AccountId information. Below is an example of a redirected landing page URL: Below is an example of a JavaScript event listener:
Json
{
  "step": "REDIRECT",
  "institution": "FlinksCapital",
  "url": "https://example.com/thank-you?loginId=8b35f6c8-e7b6-41d3-98f8-08d68b7f8d31&tag=YourTag&institution=FlinksCapital"
}
If you’re using Webhooks to receive your data, the payload will contain the chosen tag. Below is an example of a Webhook payload (transactions, balance, and holder have been abbreviated for simplicity):
Json
{
    "ResponseType": "GetAccountsDetail",
    "HttpStatusCode": 200,
    "Accounts": [
        {
            "Transactions": [...],
            "TransitNumber": "77777",
            "InstitutionNumber": "777",
            "OverdraftLimit": 0,
            "Title": "Chequing CAD",
            "AccountNumber": "1111000",
            "Balance": {...},
            "Category": "Operations",
            "Type": "Chequing",
            "Currency": "CAD",
            "Holder": {...},
            "Id": "ae1dac72-70da-4626-fed8-08d682e1ff4a"
        },
        {...}
    ],
    "Login": {
        "Username": "Greatday",
        "IsScheduledRefresh": false,
        "LastRefresh": "2019-05-09T13:47:46.5227901",
        "Type": "Personal",
        "Id": "5e115eac-1209-4f19-641c-08d6d484e2fe"
    },
    "Institution": "FlinksCapital",
    "RequestId": "1243c283-e0ca-4fda-a5e4-343068430190",
    "Tag":"YourTag"
}