v1

latestOpenAPI 3.0.22026-08-061464031.4 MB

Links

Trigger a historical update for a link

{% admonition type="warning" name="Concurrent Request Limit" %} To prevent duplicate requests, this endpoint has a 10-minute cooldown period per link. If you attempt to refresh the same link within 10 minutes of a previous request, you will receive a 409 Conflict error with the message "The link has already been refreshed. Please wait X minutes before trying again.". {% /admonition %}

Use this method to trigger a historical update for a specific link (single or recurrent). Use the fetch_resources parameter to specify which resources you want to update. If you do not specify this parameter, the historical update will be performed for all resources supported by the institution that the link is associated with.

On a successful request, our API will respond with a 202 status code and a request_id that you can later use to associate a given historical_update webhook to this request.

{% admonition type="info" name="Does not update link definition" %} This endpoint does not update the link definition itself, only the historical data for the specified resources. If you want to change the link's fetch_resources permanently, you should use the Modify a link's data retrieval method instead. {% /admonition %}

post/api/links/{id}/refresh/

Path parameters

idstring uuid required

Example:e4bb1afb-4a4f-4dd6-8be0-e615d233185b

The link.id you want to refresh.

Request body

fetch_resourcesstring[]

An array of resources that you would like to receive a historical update for. If you do not specify this field, the historical update will be performed for all resources supported by the institution.

{% admonition type="warning" name="Unsupported Resources for a Link" %} If you specify a resource that is not supported by the institution, we return a 400 Bad Request error, specifying which resources are supported for the given link. {% /admonition %}

Example request

{
  "fetch_resources": [
    "ACCOUNTS",
    "TRANSACTIONS",
    "OWNERS"
  ]
}

Response

Historical Refresh Request Accepted

request_idstring required

The unique ID for this request. We recommend you store this value to later identify which webhook event relates to an asynchronous request.

Example response

{
  "request_id": "b5d0106ac9cc43d5b36199fe831f6bbe"
}