Reference IDs

Reference ID sample

{
  "reference_id": "Abc123ed-F456Gh",
  ...
}

The reference IDs are provided by you. Lirium will store and associate them with the resources.
These IDs are used as idempotency keys to avoid replays, creating a resource with an existing reference id will result in an error.

The expected value for the Reference IDs is a case sensitive string up to 64 characters long.

❗️

Case sensitive values

In order to allow any type of Reference ID, this field is case sensitive, meaning that a value of ABC123 is considered a different ID from a value of abc123.

If your system uses case insensitive ID and may have a different cases, we suggest you to normalize this value making it all lowercase before using it as a parameter for the Lirium API.