RevKeen Docs
Api reference

Check customer entitlement

Check if a customer has access to a specific benefit by key. This is the primary endpoint for feature gating and licensing checks.


Related endpoints

  • GET /customers/{customerId}/entitlements — List customer entitlements
  • POST /customers/{customerId}/entitlements — Grant entitlement to customer
  • DELETE /customers/{customerId}/entitlements — Revoke entitlement by benefit key
  • DELETE /customers/{customerId}/entitlements/{entitlementId} — Revoke entitlement by ID
  • GET /entitlements — List entitlements
  • GET /entitlements/check — Check entitlement access

Common errors

  • 401 unauthenticated — missing, malformed, or revoked API key.
  • 404 resource_missing — the referenced resource does not exist or is not visible to your key.
GET
/customers/{customerId}/entitlements/check
x-api-key<token>

Your RevKeen API key (powered by Unkey). Get it from Dashboard > Settings > API Keys. Use rk_sandbox_* for test mode and rk_live_* for production.

In: header

Path Parameters

customerId*string

Customer UUID

Formatuuid

Query Parameters

benefitKey*string

Benefit key to check

Length1 <= length

Response Body

application/json

curl "https://api.revkeen.com/v2/customers/00000000-0000-0000-0000-000000000000/entitlements/check?benefitKey=value" \  -H "x-api-key: $REVKEEN_API_KEY"
{
  "data": {
    "benefitKey": "string",
    "hasAccess": true,
    "accessLevel": "full",
    "status": "active",
    "benefit": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "name": "string",
      "description": "string",
      "benefitType": "string",
      "benefitKey": "string",
      "category": "string",
      "iconUrl": "string",
      "displayOrder": "string",
      "isActive": true,
      "defaultValue": null,
      "config": null
    },
    "reason": "string"
  }
}
Empty
Empty