Banksearch 🔍

An important part of Yoli is to be able to find the bank the user has an account with. We also have to consider the different authentication schemes of banks, some just require an e-mail and a corresponding password, others require 3 different fields.

Fortunately Yoli is able to handle of these cases with a powerful and simple banksearch query that provides all relevant information.

Top Banks and Grouping

Before even starting to search for a bank, it might be a good idea to only look for one of the major banks that have many branches. (i.e. the German Sparkassen)

To retrieve the list of avaibale groups you can use the listTopBanks query

{
  listTopBanks {
    name
    icon
    group
    hasBranches
    branch {
      bankCode
      group
      interfaces{interface}
    }
  }
}

You can use the name and icon for display purposes. The hasBranches field tells you whether this is a single major bank (i.e. ING-Diba) or a major bank with lots of regional branches (i.e. Sparkasse).

If hasBranches is true, you can use the group field in the searchBanks query to limit results to that branch

If hasBranches is false on the other hand, the single bank will be in the branch field.

Searching for Banks

To actually search for banks by name, use the searchBanks query. It supports limiting the amount of hits returned, as well as only getting banks from a particular group. To later use this information for connecting a bank login, you will need to retrieve the interfaces for the login. An interface specifies the internal interface, which is used to access the bank account data and the credential input fields that need to be returned when using the addBankLogin mutation.

{
  searchBanks(search:"fino sca", limit: 10) {
    city
    description
    bic
    postcode
    bankCode
    shortName
    group
    icon
    advice
    additionalIcons{size_120x120}
    alias
    interfaces{
      interface
      advice
      credentials{
        masked
        label
      }
    }
  }
}