Historical update

As soon as your OFDA banking link is created (either recurrent or a single link with fetch_resources: ["BILLS"], we asynchronously load the employment record information. You will receive a historical_update notification whenever the employment record data is available for you to access.

{
  "webhook_id": "aadf41a1fc8e4f79a49f7f04027ac999",
  "webhook_type": "BILLS",
  "webhook_code": "historical_update",
  "link_id": "16f68516-bcbc-4cf7-b815-c500d4204e28",
  "request_id": "4363b08b-51eb-4350-9c74-5df5ac92a7f6",
  "external_id": "your_external_id",
  "data": {
    "total_bills": 2 // Total number of bills
  }
}

Once you receive the notification, you can get further details by making the following request:

curl --request GET 'https://api.belvo.com/api/bills/?link={id}' \
-u [Secret Key ID]:[Secret Key PASSWORD]

Where:

• {id} is the link_id your receive in the webhook notification.

New bills available

You can receive a new_bills_available notification whenever new owners are available for a bank recurrent link.

Once you receive the notification, you can query the Bills endpoint to pull the details of these new bills. For example, if you receive the following webhook:

{
  "webhook_id": "aadf41a1fc8e4f79a49f7f04027ac999",
  "webhook_type": "BILLS",
  "webhook_code": "new_bills_available",
  "link_id": "16f68516-bcbc-4cf7-b815-c500d4204e28",
  "request_id": "4363b08b-51eb-4350-9c74-5df5ac92a7f6",
  "external_id": "your_external_id",
  "data": {
    "new_bills": 1 // Number of new bills
  }
}

You can request more information about the owners with the following query to the Bills endpoint:

curl --request GET 'https://api.belvo.com/api/bills/?link={id}&created_at_gte={YYYY-MM-DD}' \
-u [Secret Key ID]:[Secret Key PASSWORD]

Where:

• {id} is the link_id you receive in the notification.
• {YYYY-MM-DD} is the date you receive the notification.