Request identifier

Each response processed by the API includes an identifier for the attempt. Store this value with the status and time when you need to investigate a request.

Request-Id is a response header. Do not send this name in the request or try to choose its value.

Where to find it

The response contains the main header and an alias with the same value:

Request-Id: req_4ZxYp8Q2mV7nR6sT5uW3aB
X-Request-Id: req_4ZxYp8Q2mV7nR6sT5uW3aB

Use Request-Id in new integrations. X-Request-Id remains available for compatibility.

In the Raims CLI, the field appears as request_id in JSON output and as Request-Id in text output. This documentation console shows the value on the real response and lets you copy it. Response examples do not have a real ID.

Provide it to support

When asking for help with an API response, provide its Request-Id, the approximate time and the endpoint you called. Do not send the API key, webhook secret or a payload containing customer data.

The identifier helps locate an attempt when its records are available. Company request logging may be disabled or the history may have expired, so having the ID does not guarantee that the request can still be searched.

Identifier limits

Each HTTP attempt receives another Request-Id, including a retry or an idempotent response replay. To retry the same intent safely, use Idempotency-Key; do not reuse Request-Id.

The value with the req_ prefix is not a resource, payment or pending operation ID. Continue using identifiers returned in the body to query the result.

The header identifies responses processed by the API. A failure produced before it, for example at the edge or a proxy, may not contain Request-Id.