FiveM resource
The official fiveban Lua resource talks to our API at every connection and
silently rejects confirmed cheaters before they can play. It also forwards
ban events to your server (Business plan only) so you can mirror them in
your own database.
Install
Grab the latest ZIP from /download (it's pinned with a SHA-256 checksum so you can verify integrity), then:
cd resources/[fiveban]
unzip ~/Downloads/fiveban-resource-*.zip
# → resources/[fiveban]/fiveban-resource/
Add ensure fiveban-resource to server.cfg and restart.
Resource will auto-update notifications via
/api/v1/resource-version— when a new version is published, it'll log a warning at startup. The actual download is manual (we don't auto-replace files on running servers).
Configure
Open config.lua:
Config = {}
-- Required: API key from https://fiveban.xyz/dashboard
Config.ApiKey = "paste-your-key-here"
-- Locale (en, cs, pt, es, de, pl, ru, no, sv)
Config.Locale = "en"
-- Per-status actions: kick / lockdown / warn / log
Config.OnConfirmed = "kick"
Config.OnSuspicious = "warn"
Config.OnAltMatch = "log"
Config.OnWarnings3 = "kick"
-- Behaviour when our API is unreachable
Config.OfflineAction = "log" -- log | block | lockdown
-- Periodic blacklist sync (seconds)
Config.SyncInterval = 600
How a connection check works
player connects
├── deferrals.defer()
├── POST /api/v1/check?q=<discord_id>
│ Authorization: Bearer <ApiKey>
├── 200 → status field
│ ├── confirmed → kick + log
│ ├── suspicious → warn (allow with notice)
│ ├── clean → done
│ └── unknown → done
└── 401 / network err → fallback per Config.OfflineAction
The whole check should finish in <500 ms; we recommend leaving it on
(OfflineAction = "log") so a temporary outage doesn't lock players out.
Webhook payload (Business)
If you set a webhook_url in your dashboard, every ban issued by FiveBan
staff is POSTed to your endpoint:
{
"event": "player_banned",
"source": "fiveban-web",
"timestamp": "2026-04-30T19:00:00.000Z",
"discord_id": "1234567890",
"username": "Cheater#1337",
"ban_reason": "EAC bypass",
"evidence_url": null,
"banned_by": "staff:0987654321",
"alts_count": 3
}
Respond with 200 within 8 seconds — we don't retry. Use a queue if your
DB writes are slow.
Admin commands (in-game)
| Command | Plan | Description |
| --- | --- | --- |
| /fbcheck <id> | Pro+ | Manual lookup (q is whatever your input parser accepts). |
| /fbstatus | Pro+ | Show resource version and current cache size. |
| /fbsync | Pro+ | Force blacklist resync. |
| /fbreport <id> <reason> | Business | Submit a cheater report directly to FiveBan staff. |