Owners
Reference information for our Owners webhook events.
Historical update
As soon as your banking recurrent link is created, we asynchronously load the owners available. You will receive a historical_update
notification whenever the owner list is available for you to access.
{
"webhook_id": "aadf41a1fc8e4f79a49f7f04027ac999",
"webhook_type": "OWNERS",
"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_owners": 2 // Total number of owners of the accounts
}
}
Once you receive the notification, you can get further details by making the following request:
curl --request GET 'https://api.belvo.com/api/owners/?link={id}' \
-u [Secret Key ID]:[Secret Key PASSWORD]
client.owners.list({
filters: {
link: "{id}"
}
})
client.Owners.list(link="{id}")
client.owners.list(params: {
link: "{id}"
})
Where:
{id}
is thelink_id
your receive in the webhook notification.
New owners available
You can receive a new_owners_available
notification whenever new owners are available for a bank recurrent link.
Once you receive the notification, you can query the Owners endpoint to pull the details of these new invoices. For example, if you receive the following webhook:
{
"webhook_id": "aadf41a1fc8e4f79a49f7f04027ac999",
"webhook_type": "OWNERS",
"webhook_code": "new_owners_available",
"link_id": "16f68516-bcbc-4cf7-b815-c500d4204e28",
"request_id": "4363b08b-51eb-4350-9c74-5df5ac92a7f6",
"external_id": "your_external_id",
"data": {
"new_owners": 1 // Number of new owners
}
}
You can request more information about the accounts with the following query to the Owners endpoint:
curl --request GET 'https://api.belvo.com/api/owners/?link={id}' \
-u [Secret Key ID]:[Secret Key PASSWORD]
client.owners.list({
filters: {
link: "{id}"
}
})
client.Owners.list(link="{id}")
client.owners.list(params: {
link: "{id}"
})
Where:
{id}
is thelink_id
you receive in the notification.
Updated 4 months ago