Historical update

As soon as your employment link is created (a single link with fetch_resources: ["EMPLOYMENT_RECORDS", "OWNERS","EMPLOYMENT_METRICS"], we asynchronously analyze the employment records and generate an employment metric report. You will receive a historical_update notification whenever the employment metric data is available for you to access.

{
   "webhook_id":"03d1ca0d62db4f769488265d141047b7",
   "webhook_type":"EMPLOYMENT_METRICS", 
   "webhook_code":"historical_update", 
   "link_id":"2f5d361d-dad6-45d4-a0bf-26d479766067",
   "request_id": "4363b08b-51eb-4350-9c74-5df5ac92a7f6",
   "external_id": "your_external_id",
   "data":{
      "total_employment_metrics": 1 // The total number of employment metric reports generated
   }
}

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={id}' \
-u [Secret Key ID]:[Secret Key PASSWORD]

Where:

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