The whitelist is your city’s front gate. On Discord, the person answers the questions, goes through the team (if you want) and, at the end, sends their game ID in a panel. The bot unlocks that ID right away, gives the access role and changes the nickname. With the fivedash resource installed on the FiveM server, the ID is also unlocked inside the game. This page is for owners and staff who set up and review whitelists.
Plan: the whitelist is part of the Discord module, on every plan (Plus, Pro and Ultra).
Bot connected: the city’s bot must be linked to the Discord server. See Bot.
Roles above: the bot’s role must sit above the roles it gives and takes (approved, unlocked, interview, role to remove). Otherwise the bot warns that its role needs to be above that role.
In-game unlock (optional): install the fivedash resource and connect the server. See Install the resource.
Dashboard permissions (the Whitelist area):
Level
What it allows
View
Whitelists, interviews and approved players (Overview, sheets, the codes list and who used them)
Manage
Approve, refuse and generate codes (also disable, reactivate and delete codes)
Configure
Questions, modes and panels (save settings, publish, resend and delete panels)
Open Discord → Whitelist. The top of the page has the On / Off switch, the Publish panels button (it becomes Resend panels after the first time) and, in the three-dot menu, Delete panels. Below, four tabs:
Tab
What it has
Overview
Whitelist numbers, the board or list of whitelists, the interview queue and Unlocked
Settings
Mode, Steps (start, questions, interview), Rules, Result in a channel and Logs
Unlock
The unlock panel, the form, what happens On unlock, the /liberar command and In the city
Codes
The code panel and the Codes list. Only shows in the Manual review and Interview only modes
Each tab has a Discord preview beside it. Changes are marked with a dot on the tab until you click Save (or Discard).
In Discord → Whitelist → Settings, in the Mode group, click the card for the mode your city uses.
Set up the start
In Steps, open Start and pick the Panel channel: that’s where the bot posts the message with the Start whitelist button. Click Title, text, button and image to change the texts. (Interview only and Unlock only don’t have this panel.)
Write the questions
In Questions, click Add question. For each one, fill in Question, pick the Type and, for multiple choice, create the Options and click the circle of the right answer. Drag to reorder; use Duplicate and Delete in the question’s menu.
Decide on the interview
On the Interview card, use Turn on the interview if whoever passes should still talk to the team. Pick the Role during the interview, the Waiting rooms (voice) and build the cheat sheet.
Adjust the rules
In the Rules group, set the Pass mark, Time to answer, Private channel, Try again and Team channel.
Set up the unlock
Go to the Unlock tab and pick the Channel, the Approved members’ role and the Unlocked members’ role. See the Unlock section below.
Turn on, save and publish
Flip the switch to On, click Save and then Publish panels. The Panels published notice shows where they are.
Gets one question at a time (“Question 1 of 6”), with the time left. Multiple choice opens a list; written answers open a form through the Answer button. There’s always Cancel and, on optional questions, Skip.
At the end:
Automatic questions: gets the score right away. Passed (or passed the quiz, if there’s an interview) or failed, with when they can try again.
Manual review: the answers are sent. The result arrives by DM, so the person must keep direct messages open.
With Private channel on, each person answers in a channel of their own, created when they start and deleted when they finish. In that channel, if the bot has the Message Content intent on, written answers are typed straight into the chat (“Type your answer here in the chat.”), with no form.
The interview is a talk with the team before the unlock. It’s optional in Automatic questions and Manual review (the Turn on the interview switch on the Interview card) and always there in Interview only.
Field
What it does
Modes
Default
Role during the interview
Optional. Given while the person waits; removed when the interview ends
Automatic, manual
None
DM message
Sent by DM to whoever passes the quiz (or whose answers were approved)
Automatic, manual
“Now there’s just the interview left, {membro}! Keep an eye on Discord, the team will call you for a chat.”
Interview channel
Optional. The channel where the team interviews. Whoever tries to unlock before being approved is sent there
Interview only
None
Waiting rooms (voice)
Up to 10 voice channels. In Interview only, whoever joins a room enters the queue on their own. In the other modes, whoever is already waiting shows as “in the room”
All with an interview
None
Interview cheat sheet
Up to 20 questions to guide the talk, each with “What to expect from the answer”. Only the team sees it
In Discord → Whitelist → Overview, the Waiting for interview column shows who is in the waiting room, live, with how long they’ve been waiting. The Interview column shows who is waiting outside the room.
Open the sheet and the cheat sheet
Click the person’s card. The sheet shows how they got there (quiz, approved answers, waiting room or code). Beside it, the Interview cheat sheet: check off what you’ve asked. In Interview only, use the Open cheat sheet button.
Decide
After the talk, click Pass interview or Fail. When refusing, write the Reason (optional, up to 500 characters): it goes to the person’s DM.
In Discord → Whitelist → Overview, switch between Board and List in View. Search by name or Discord ID and filter by status. Reviewing needs the Manage level.
In review → Interview, Waiting for interview, Refused
Automatic questions with interview, or Interview only
Interview, Waiting for interview → Approved / Refused
Automatic questions without interview, or Unlock only
No board: list only
Drag a card to the decision’s column (“Drop to approve”, “Drop to refuse”, “Drop to send to the interview”). With the keyboard: space to pick up, arrow keys to choose the column, space to drop, Esc to cancel. With the interview in manual review, the final approval happens in the sheet.
Click a whitelist to see Started, Score (for example, “3 of 4 · 75%”), Decided by, Time to decide and each answer (with the right one, for multiple choice). The buttons change with the step:
Step
Buttons
In review, no interview
Approve · Refuse
In review, with interview
Approve for interview · Refuse
Interview
Pass interview · Fail
If someone else on the team decides first, the dashboard says “Someone else just decided that whitelist.”
The top of the Overview shows recent numbers compared with the previous 7 days: incoming (Quizzes taken, Whitelists sent or Interview requests, depending on the mode), Average quiz score, Waiting for interview or In the team’s queue, Failed, Time to decide, Approved (with the approval rate) and Unlocked.
Unlocking is automatic: approved members send their game ID through the panel and the bot unlocks it right away, with nobody on the team having to do anything. In Unlock only mode, anyone can use the panel. Set it up in Discord → Whitelist → Unlock.
Only members with this role can use the panel. The bot gives the role to whoever passes the whitelist (in Interview only, the team gives it after the interview), and it’s removed once the ID is unlocked. Not in Unlock only
None (required)
Mention approved members
When the whitelist is approved, the bot mentions the person in this channel and deletes the message right after: the channel lights up
Right away, the person gets the unlocked role, loses the approved one, gets the new nickname and, with the server connected, is unlocked in the city.
Field
What it does
Default
Unlocked members’ role
Access to the city
None (required with the whitelist on)
Role to remove
Optional. The bot takes this role from whoever is unlocked (a “not unlocked” role, say)
None
Nickname format
The nickname the bot sets. Type / to insert {personagem} (character), {id} or {nome} (name). Up to 60 characters; the final nickname is cut at 32. It doesn’t work for the server owner or roles above the bot
{personagem} | {id}
Message
Shown to the person as soon as the ID is unlocked, with the ID and nickname below
“All set, {membro}! Your ID was unlocked on {servidor}. Have fun!”
Example: with the default format, the character “Carlos Andrade” and the ID 1234, the nickname becomes Carlos Andrade | 1234.
With the fivedash resource installed and the server connected, the In the city card shows Server connected and the unlock also unlocks the ID in the game. Without a connection, the whitelist stays on Discord only (roles and nickname).
Field
What it does
Default
Remove the whitelist from whoever is kicked or banned
Kicked or banned from the Discord (by /kick, /ban, protection or by hand), they lose the whitelist in the city and, if playing, are disconnected
On
Remove the whitelist from whoever leaves the Discord
Any exit from the Discord server, even on their own, removes the whitelist in the city and disconnects them if they’re playing
On
What the person sends depends on the city’s framework, which the resource detects on its own:
Framework
What the person enters
Creative Network Enchanted
The game ID (Your in-game ID) or, if the city unlocks by token, the token (Your in-game token)
vRP / vRPex
The game ID
QBCore, Qbox, ESX (esx_whitelist)
Nothing besides the character’s name: the city finds the person by their Discord. They must try to join the server once, with Discord open, before unlocking
ox_core
No whitelist through FiveDash yet: unlocking keeps giving the role on Discord
On the Overview, the Unlocked list shows each unlock with the ID, the character, the nickname, the in-game status and, when it applies, “Skipped the whitelist with the code …”. Search by name, character, game ID or code and filter by code.
Codes (“codiguinhos”) let someone skip the whitelist: for partners, giveaways or anyone the team wants to let in. The person types the code in its own panel and gets the approved role right away. They exist in the Manual review and Interview only modes, in the Codes tab.
Posts a panel in its own channel, with the button to type the code
Off
Panel channel
Where the button to use the code sits
None (required with the whitelist on)
What about the interview?
Only in Manual review with an interview. Skips the interview: gets the approved role right away. Goes to the interview: joins the queue, like someone whose answers were approved
Skips the interview
Title, text, button and image
The panel’s texts and the Accepted reply
Title “Code”, button “Use code”
A code always skips the questions. In Interview only, it skips the interview too.
In the Codes list, search by code or note and filter by Active, Used up, Expired or Disabled. In each code’s menu: Copy code, See who used it, Disable / Reactivate and Delete. All of these need Manage.
Status
Meaning
Active
Can be used
Used up
Reached its use limit
Expired
Past its validity
Disabled
The team disabled it (can be reactivated)
Deleting a code removes it from the list along with who used it. Unlocks made with it stay marked.
The person sent their ID and the bot said it doesn’t exist in the city. What now?
The city didn’t find that ID. The person must join the server once, check the ID shown and try again. On QBCore, Qbox and ESX, they must try to join with Discord open on their computer before unlocking.
The bot didn’t give the access role. Why?
The bot’s role is below the role it’s trying to give. In Discord’s Server Settings → Roles, drag the bot’s role above the whitelist roles.
Can I let someone in without the whitelist?
Yes. Use /liberar on Discord (team members with the roles in Roles that can use it) or generate a code in the Manual review and Interview only modes.
What happens if the FiveM server is off at unlock time?
The person gets the role on Discord as usual, and the unlock stays Queued. The ID is unlocked in the city as soon as the server is back.
How long does the person wait to try again?
The Try again time (default: 30 min). The bot shows when they can try.