Request IDs
Every response carries an X-Request-Id header — a correlation id for that single request.
- If you send your own
X-Request-Id, it is echoed back unchanged (up to 100 characters), so you can thread your own trace id end to end. - If you do not send one, the platform generates one and returns it.
curl -i https://your-app.example.com/api/v1/customers \
-H "Authorization: Bearer sk_live_PUBLICID.SECRET" \
-H "X-Company-Id: 0190abcd-1234-7000-8000-000000000000"
# → X-Request-Id: 0190abcd-1234-7000-8000-000000000000On errors
The same id is embedded in every error envelope as requestId (see Errors):
{
"error": {
"code": "not_found",
"message": "not found",
"requestId": "0190abcd-1234-7000-8000-000000000000"
}
}Quote it in support requests
Log the X-Request-Id for every call. When something goes wrong, including the request id lets support
pinpoint the exact request in the platform's logs.