Risk insights (Webhooks)

Reference information for our risk insights webhook events.

Historical update

As soon as your banking link is created and you have added RISK_INSIGHTS to the list of resources in fetch_resources, we asynchronously generate the risk insights for the link and will send you the following webhook:

Webhook CodeDescription
historical_updateThe total number of risk insights identified for the link.

In the webhook payload we include the number of risk insights identified for the link.

{
  "webhook_id": "58577409546a4247848055e1e11bbc71",
  "webhook_type": "RISK_INSIGHTS",
  "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_risk_insights": 1 // Always = 1, Indicates that the analysis is ready for retrieval.
  }
}

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

curl --request GET 'https://api.belvo.com/api/risk-insights/?link=link_id' \
-u [Secret Key ID]:[Secret Key PASSWORD]
Query ParameterDescriptionExample
linkThe link_id you received in the webhook notification.2f5d361d-dad6-45d4-a0bf-26d479766067