Risk insights

Reference information for our risk insights webhook events.

Historical update

With single links, you can choose to add fetch_resources: ["RISK_INSIGHTS", "ACCOUNTS", "TRANSACTIONS"] when you create the link so that Belvo asynchronously performs an enrichment analysis of the user's transactions to identify any risk insights. You will receive a historical_update notification whenever the risk insights analysis is available for you to access.

{
  "webhook_id": "58577409546a4247848055e1e11bbc71",
  "webhook_type": "RISK_INSIGHTS",
  "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={id}' \
-u [Secret Key ID]:[Secret Key PASSWORD]

Where:

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