DocumentationAPI Reference
DocumentationAPI Reference

Idempotence

The Persona API supports idempotency for safely retrying requests without accidentally performing the same operation twice. This is useful when an API call is disrupted in transit and you do not receive a response. For example, if a request to create an inquiry does not respond due to a network connection error, you can retry the request with the same idempotency key to guarantee that no more than one inquiry is created.

To perform an idempotent request, provide an additional Idempotency-Key: <key> header to the request.

Persona's idempotency works by saving the resulting status code and body of the first request made for any given idempotency key, regardless of whether it succeeded or failed. Subsequent requests with the same key return the same result, including 500 errors.

Keys are eligible to be removed from the system after they're at least 1 hour old, and a new request is generated if a key is reused after the original has been pruned. The idempotency layer compares incoming parameters to those of the original request and errors unless they're the same to prevent accidental misuse

All POST requests accept idempotency keys. Sending idempotency keys in GET and DELETE requests has no effect and should be avoided, as these requests are idempotent by definition.