RevKeenDocs
StatusSupport
API Reference
👥 Customers & VaultEntitlements

Check entitlement access

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

GET/entitlements/check

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 /entitlements — List entitlements

Common errors

  • 401 authentication_error — missing, invalid, expired, or revoked credential. Codes: authentication_failed, invalid_api_key, expired_api_key, api_key_revoked, session_invalid, merchant_required. Carries a WWW-Authenticate: Bearer challenge.
  • 404 resource_missing — the referenced resource does not exist or is not visible to your key.

Authorization

x-api-key<token>

Your RevKeen merchant API key. Create and manage keys in Dashboard → Settings → Developer. Use rk_sandbox_* for staging/test and rk_live_* for production. The same key may be sent as Authorization: Bearer <key> if that suits your HTTP client better. A missing, invalid, expired, or revoked key returns 401 with a WWW-Authenticate: Bearer challenge; a valid key without the required scope returns 403.

In: header

Scope: customers:read

Query Parameters

customer_id*string

Customer UUID (required)

Formatuuid
benefit_key*string

Benefit key to check

Length1 <= length

Response Body

application/json

application/json

application/json

application/json

Stuck on an error response? Ask the RevKeen assistant to explain it.
curl -X GET "https://api.revkeen.com/v2/entitlements/check?customer_id=11111111-1111-4111-8111-111111111111&benefit_key=example" \
  -H "x-api-key: $REVKEEN_API_KEY"

Synthetic documentation data, validated against the response schema; not a live API result.

{  "data": {    "benefit_key": "priority_support",    "has_access": true,    "access_level": "full",    "status": "active",    "benefit": {      "id": "9e0f1a2b-3c4d-4652-af60-7b8c9d0e1f23",      "name": "Priority support",      "description": "Replies within four working hours.",      "benefit_type": "custom",      "benefit_key": "priority_support",      "category": "support",      "icon_url": null,      "display_order": "1",      "is_active": true,      "default_value": null,      "config": null    },    "reason": null  }}