Link

This is a preview of the screens your users will go through when linking their accounts, and thus giving you access to their user-authorized data.

It's important to understand that the goal here is to set the parameters of what your users will see when trying to connect; you cannot actually connect to either Sandbox or Live endpoints from this screen, as stated in the comment on top.

Flow Steps Preview

This illustrates the order in which the screens are displayed to your users when they try to link their account.

  • Consent: This makes them click on a button to confirm their consent to have you connect to their data on read/write on them.
  • Selecting Source: This is the meat of the Link and what you have most control over. Using the parameters on the right, you can preset a list of sources to show to your users, from which they can select one to link with.
  • Adding New Source: The source you're looking for isn't in the list? No problem! You can simply add it yourself by providing its email address.
  • Login: This is where your user will enter their credentials. Note that you will not receive their credentials, we will. We then enables you to access their data, but their credentials stay encrypted and safe with us.
  • Loading: The loading screen while the link is being made.
  • MFA: If the connection to the source implies an MFA, the user will enter their code here.
  • Account selection: The little on/off button here enables or disables account selection. You can also find the same button in the parameters to the right. Turning this on allows the user to select one or more accounts available on the source they connected to.
  • Success: The final screen where they get the confirmation that the Link has been created.

Parameters

On the right, there will be an exhaustive list of all the parameters you can set to smoothen the linking experience for your users. They are:

  • Language: The language in which the widget will be presented to the user. If you would like a language to be added to the list, please let us know.
  • Countries: Select one or more countries from which to retrieve sources.
  • Types: Turn on one or more types to be able to list all sources of that type. They are separate categories, not cumulative; this means that if you select Electricity and Water, you will get all the sources for electricity and all the sources for water, not only the sources branded as both electricity and water.
  • Account selection: Turning this option on allows the user to select one or more accounts available on the source they connected to.
  • Auto-Suggest Sources: This helps filter further and brings to the surface some sources over others.
  • Auto-Refresh: Enables or disables the automation of updating the list of sources to display the latest Deck update.