Some of our APIs either require or allow use of an Idempotency Key in order to ensure that duplicate requests (in particular those with side-effects) are not processed, leaving the system in a state with invalid duplicate objects or performaning an unintended operation more than once.


In order to use this mechanism, specify a header called Idempotency-Key with a value which MUST be unique and no more than 40 characters, the uuid format is perfect for this use.


An example of this can be seen in the Boarding API's Merchant Applications

Did this page help you?