v1

latestOpenAPI 3.0.22026-08-061464031.4 MB
Links

Delete a link

Delete a specific link and all the associated data (for example: transactions, accounts, invoices, tax returns, employments, and so on) for that link from your Belvo account. This action is irreversible, and you will not be able to recover the deleted data.

{% admonition type="success" name="Use the X-Belvo-Request-Mode: async header" %} We highly recommend setting the X-Belvo-Request-Mode header to async to enable asynchronous deletion. This way, you will avoid the rate limit of 5 deletions per minute. When set, the endpoint will respond with a 202 Accepted status and provide a request ID for tracking the deletion process. Once the process is complete, you will receive a link_deleted webhook notification.

If you do not set this header, the endpoint will respond with a 204 No Content status, but you will be subject to the rate limit of 5 deletions per minute. If you exceed this limit, you will receive a 429 Too Many Requests error. {% /admonition %}

delete/api/links/{id}/

Path parameters

idstring uuid required

The link.id that you want to delete.

Headers

X-Belvo-Request-Mode'async'

Set to async to enable asynchronous deletion, which bypasses rate limiting. When set, the endpoint returns a 202 Accepted response with a request ID. You will later receive a webhook notification when the deletion is complete.

Response

Accepted

request_idstring uuid required

The unique identifier for tracking the async deletion request.