A Link is a set of credentials associated to an end-user's access to an institution.

Example: The username and password combination used to log in to an online banking application would be a link.

You will need to register a Link before accessing information from that specific end-user, such as account or transaction details.

Note: We recommend using our Connect Widget to handle link creation and link status updates.

You have the possibility to register two types of links:

Recurrent links

With recurrent links, Belvo automatically refreshes information weekly and notifies you via webhook so you always have up-to-date data. Then, when you receive the webhook, you can use GET requests to the List or Detail endpoints to instantly access up-to-date information, without needing to connect to the institution.


Recurrent link flow

When you create a recurrent link, Belvo automatically retrieves key information about the Link ID. Once we have the information, we'll send you a historical webhook event indicating that you can make a GET request for that information.

We recommend you don't make POST calls immediately after a link is created. Instead, wait for a historical update webhook which indicates that Belvo has scraped the data and then you can make a GET request to retrieve the information (the webhook is sent soon after a link is created). If you make a GET request before you receive a historical webhook, you will receive responses with empty data fields or duplicated information.

Single links

Single links are used to perform ad hoc data access to accounts, owners, transactions, and so on. For example, you can use it when you want to do an underwriting process to assess risk before lending money.

For single links, you need to pass the fetch_resources parameter when creating and then listen for webhooks once the historical data has been asynchronously extracted.