No-Access Route Guard - API Contract

POST /api/v1/route-guard/api/v1/route-guard/check

Evaluate whether the current auth state should be blocked and what redirect to apply

Public

Request Example

{
  "user_id": "usr-9912",
  "role": "STUDENT",
  "organization_id": "org-4821",
  "requested_path": "/dashboard"
}

Response Example

{
  "is_blocked": true,
  "redirect_path": "/no-access",
  "reason": "role_not_permitted_on_mobile"
}

GET /api/v1/route-guard/api/v1/route-guard/redirect

Get the redirect destination for a blocked auth state without posting full state

Public

Response Example

{
  "role": "GUARDIAN",
  "is_blocked": true,
  "redirect_path": "/no-access"
}

Additional Metadata

{
  "contract_summary": {
    "total_contracts": 410,
    "total_endpoints": 2416,
    "api_styles_used": [
      "rest"
    ]
  },
  "generated_at": "2026-03-26T06:55:53.316Z"
}