Skip to main content

Verify an API key

GET /v1/public/auth

Verifies the API key and returns the merchant connected to the integration

Authorization​

X-API-Key required

Request example​

curl -X GET "https://api.remyrewards.co.uk/v1/public/auth" \
  -H "Accept: application/json" \
  -H "X-API-Key: YOUR_API_KEY"

Responses​

StatusDescription
200The API key is valid.
401The API key is missing or invalid.
404The requested integration resource was not found.
429A rate or concurrency limit was exceeded.

Success response example​

{
"success": true,
"merchant": "Example Coffee"
}