Device Management

Check Scan Limit

GET /api/v1/device/scan/check-limit

Universal scan limit checker for all user types.

Headers:

  • Authorization: Bearer token (for authenticated users)
  • X-Device-Id: device_instance_id (for anonymous/logged-out users)

Returns detailed limit information with action_required for UI.

Scenarios handled:

  • Anonymous user (device not linked)
  • Authenticated user (FREE or PREMIUM)
  • Logged-out user with FREE plan exhausted
  • Logged-out user with PREMIUM plan
get/api/v1/device/scan/check-limit

Request

  • Base URL: https://api.gemstoneaiapp.com (the document declares no server; this is the origin it was published from)
  • URL: https://api.gemstoneaiapp.com/api/v1/device/scan/check-limit
  • Auth: none declared

Headers

X-Device-Idinteger nullable
authorizationstring nullable

Response

Successful Response

device_idstring required
can_scanboolean required
scans_usedinteger required
scan_limitinteger nullable
plan_typestring required
user_statusstring required
messagestring required
linked_to_userboolean
action_requiredstring nullable
tierstring nullable
resets_atstring nullable
upgrade_tierstring nullable

Example response

{
  "can_scan": true,
  "linked_to_user": false,
  "message": "3 free scans remaining",
  "plan_type": "free",
  "scan_limit": 5,
  "scans_remaining": 3,
  "scans_used": 2,
  "user_status": "anonymous"
}

Changes

No recorded changes to this operation across all 1 revision of this API.