Idempotent Requests

Check supports idempotency for safely retrying requests without accidentally performing the same operation twice. This can be useful for issuing requests that you do not want to happen more than once, like attaching payroll item payments for an employee. You can retry the request with the same idempotency key to guarantee that no more than one entity is created.

To perform an idempotent request, provide an X-Idempotency-Key header to the request. We save the response's status code and body for the first request made with the given idempotency key regardless of whether it succeeded or failed. Subsequent requests with the same key return the same result, including 500 errors.

The format of the idempotency key is up to you, however we suggest using UUIDs. Note that keys expire after 24 hours, so if you issue the same request after 24 hours, that operation will complete.

X-Idempotency-Key: 8ac545e4-e918-4fb9-ac55-71edb1dec791