With the Refresh endpoints you can refresh the data from an existing Link without requiring the user to enter their payroll credentials a second time.

Performing a Refresh

To successfully perform a Refresh you need to follow these steps:

  1. [Optional] Subscribe to Webhooks so when a Task is completed (with a status of done) you can pull payroll data.
  2. Make a POST request to the /refresh/tasks endpoint passing in the access_token from the original connection.
  3. Use webhooks or poll backend GET endpoint to check the status of the refresh

It's important to note that each Refresh Task is billed.


Note on refresh rate interval:

There is a per access_token limit that will allow an initial request and 3 refreshed in a 24-hour period. If exceeded, you will receive a error: "Refresh limit for the access_token exceeded"