Historical update

As soon as your fiscal link is created (a single link with fetch_resources: ["FINANCIAL_STATEMENTS"], we asynchronously load the financial statement information. You will receive a historical_update notification whenever the employment record data is available for you to access.

{
  "webhook_id": "aadf41a1fc8e4f79a49f7f04027ac999",
  "webhook_type": "FINANCIAL_STATEMENTS",
  "webhook_code": "historical_update",
  "process_type": "historical_update",
  "link_id": "2f8ca7a1-c28f-46f2-bb41-21633099a280",
  "request_id": "4363b08b-51eb-4350-9c74-5df5ac92a7f6",
  "external_id": "COHORT_32_User_6790023X5",
  "data": {
    "new_financial_statements": 3
  }
}

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

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

Where:

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

New financial statements available

You can receive a new_financial_statements_available notification whenever you made a POST request to retrieve Financial Statements using the async header.

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

{
  "webhook_id": "aadf41a1fc8e4f79a49f7f04027ac999",
  "webhook_type": "FINANCIAL_STATEMENTS",
  "webhook_code": "new_financial_statements_available",
  "process_type": "async_post",
  "link_id": "16f68516-bcbc-4cf7-b815-c500d4204e28",
  "request_id": "4363b08b-51eb-4350-9c74-5df5ac92a7f6",
  "external_id": "COHORT_32_User_6790023X5",
  "data": {
    "new_financial_statements": 3
  }
}

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

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

Where:

{id} is the link_id you receive in the notification.