Historical update

As soon as your banking link is created and you have added INCOMES to the list of resources in fetch_resources, we asynchronously calculate the income data for the link and will send you the following webhook:

Webhook Code	Description
historical_update	The total number of incomes and incomes streams identified for the link.

In the webhook payload we include the number of incomes and income streams identified for the link.

{
  "webhook_id": "75f0c2ca92e64f228da04cc7f5039c03",
  "webhook_type": "INCOMES",
  "process_type": "historical_update",
  "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_incomes": 1, // Always = 1, Indicates that the analysis is ready for retrieval.
    "number_of_income_streams": 5, // Total number of income stream identified.
  }
}

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

curl --request GET 'https://api.belvo.com/api/employment-metrics/?link=link_id' \
  -u [Secret Key ID]:[Secret Key PASSWORD]

Query Parameter	Description	Example
`link`	The `link_id` you received in the webhook notification.	`2f5d361d-dad6-45d4-a0bf-26d479766067`