# Whitelist

Choose how each person gets into the city (quiz, review, interview or direct unlock) and unlock their game ID from Discord, right away.

Source: https://fivedash.fivex.gg/docs/en/discord/whitelist

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.

[Video: how to do it in under 20 seconds](https://fivedash.fivex.gg/docs/videos/discord-whitelist-en.mp4)

## Before you start

* **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](https://fivedash.fivex.gg/docs/en/discord/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](https://fivedash.fivex.gg/docs/en/getting-started/install-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)                   |

> The&#x20;
>
> **Whitelist team**
>
> &#x20;("Approves and refuses whitelists and generates codes.") and&#x20;
>
> **Whitelist and support (read-only)**
>
> &#x20;("Only sees the whitelist and tickets.") access presets come ready to use. See&#x20;
>
> [Team and permissions](https://fivedash.fivex.gg/docs/en/dashboard/team-and-permissions)
>
> .

## Where it is

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**).

## Modes

The mode decides the path of whoever joins. Pick it in **Settings → Mode**.

| Mode                    | How it works                                                                               | Questions | Team decides          | Interview | Codes |
| ----------------------- | ------------------------------------------------------------------------------------------ | --------- | --------------------- | --------- | ----- |
| **Automatic questions** | A multiple-choice quiz. Whoever gets enough right passes or goes on to the interview.      | ✓         | — (the score decides) | Optional  | —     |
| **Manual review**       | The team reads the answers and approves or refuses. Can include an interview.              | ✓         | ✓                     | Optional  | ✓     |
| **Interview only**      | No questions. The team interviews in its own channel and gives the role to whoever passes. | —         | ✓                     | Always    | ✓     |
| **Unlock only**         | No questions. The person sends their game ID and is unlocked right away.                   | —         | —                     | —         | —     |

The full path, from the click to the city:

1. The person clicks **Start whitelist** on the panel (modes with questions).
2. **Automatic questions:** the score decides. **Manual review:** the team approves or refuses.
3. With the interview on (or in **Interview only**), the person joins the interview queue and the team decides after the talk.
4. Once approved, they get the **Approved members' role** and use the unlock panel to send their ID.
5. The bot gives the **Unlocked members' role**, changes the nickname and, with the server connected, unlocks the ID in the game.

In **Unlock only** mode, the person goes straight to step 4, with no role needed.

> If you haven't touched the sample questions yet, switching between&#x20;
>
> **Automatic questions**
>
> &#x20;and&#x20;
>
> **Manual review**
>
> &#x20;swaps the sample set too: a 4-question multiple-choice quiz (RDM, VDM, metagaming, fear for your life) or 6 written questions.

## Set up the whitelist

### Pick the mode

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.

> **Publish panels**
>
> &#x20;stays blocked while there are unsaved changes ("Save your changes before publishing."), with the whitelist off ("Turn on the whitelist and save to publish the panels.") or with something missing ("Finish the settings first."). Once published, saving again updates the messages on Discord.

### What the dashboard requires to save

The dashboard points out the first problem and takes you to the field:

| Message                                                                                                                     | When it shows                                                             |
| --------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------- |
| Pick the whitelist panel's channel.                                                                                         | Modes with questions, whitelist on, no **Panel channel**                  |
| Write the whitelist panel's title or text.                                                                                  | Panel title and text both empty                                           |
| Create at least one question.                                                                                               | Modes with questions, none created                                        |
| Automatic mode needs at least one multiple-choice question.                                                                 | **Automatic questions** with written questions only                       |
| Question N: write the question. / add at least two options. / fill in or remove the empty options. / mark the right answer. | Incomplete question (the right answer is required only in automatic mode) |
| Pick the role approved members get to unlock their ID.                                                                      | Every mode except **Unlock only**                                         |
| Pick the unlock panel's channel.                                                                                            | Whitelist on                                                              |
| Pick the role for members already unlocked.                                                                                 | Whitelist on                                                              |
| The role to remove can't be the same as the unlocked members' role.                                                         | **Role to remove** equals **Unlocked members' role**                      |
| Pick the code panel's channel.                                                                                              | **Use codes** on, whitelist on                                            |
| Pick the channel where results are announced.                                                                               | **Announce the result** on with no channel                                |
| Write the nickname format or turn off "Ask for the character's name".                                                       | Empty **Nickname format**                                                 |

## Questions

Up to **25 questions** per whitelist, each with up to **10 options**.

| Type                | How the person answers               | Counts toward the score |
| ------------------- | ------------------------------------ | ----------------------- |
| **Multiple choice** | Picks from a list ("Pick an answer") | ✓ (in automatic mode)   |
| **Short answer**    | Writes one line                      | —                       |
| **Long answer**     | Writes a text                        | —                       |

| Field                | What it does                                                                                                                            | Default            |
| -------------------- | --------------------------------------------------------------------------------------------------------------------------------------- | ------------------ |
| **Question**         | The question itself (up to 200 characters)                                                                                              | Empty              |
| **Description**      | Optional. Shows below the question (up to 300)                                                                                          | Empty              |
| **Type**             | **Multiple choice**, **Short answer** or **Long answer**                                                                                | Picked when adding |
| **Placeholder text** | Written answers: shows inside the answer box (up to 100). In automatic mode, written answers are saved but don't count toward the score | Empty              |
| **Options**          | Multiple choice: at least two, up to 100 characters each. Click the circle of the right answer                                          | 2 empty options    |
| **Required**         | When off, the person sees the **Skip** button                                                                                           | On                 |

Written answers take up to 1,000 characters.

### How the person answers on Discord

1. Clicks **Start whitelist** on the panel.
2. 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**.
3. 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.

> What the bot writes on Discord follows the city's language. The defaults above are the English ones; a Portuguese city sees the Portuguese texts.

## Rules

In **Settings → Rules** (the **Automatic questions** and **Manual review** modes):

| Field                | What it does                                                                                                                                          | Options                                                | Default    |
| -------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------ | ---------- |
| **Pass mark**        | The share of multiple-choice questions that must be right. Automatic mode only                                                                        | 50%, 60%, 70%, 80%, 90%, **Get them all right**        | 70%        |
| **Time to answer**   | After that, the whitelist expires and the person starts over                                                                                          | 5, 10, 15, 20, 30 minutes, 1 hour                      | 15 minutes |
| **Private channel**  | Each person answers in a channel of their own. When off, the questions show in a message only they can see                                            | On / off                                               | Off        |
| **Channel category** | Where the whitelist channels are created. Without a category, they sit at the top of the list. Shows with **Private channel** on                      | Any category                                           | None       |
| **Try again**        | How long to wait after being refused or failing                                                                                                       | **Right away**, 10 min, 30 min, 1 hour, 6 hours, 1 day | 30 min     |
| **Team channel**     | Optional. The bot posts here when a whitelist arrives for review or there's an interview to schedule. Shows in **Manual review** or with an interview | Any channel                                            | None       |

> With&#x20;
>
> **Private channel**
>
> &#x20;on, the bot needs permission to create channels. Without it, the person is told the bot doesn't have permission to create their channel.

## Interview

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                                                                   | All with an interview | 6 sample questions                                                                                          |

> The&#x20;
>
> **Waiting rooms (voice)**
>
> &#x20;need the Gateway worker running so the dashboard knows who joined and left.

### Run an interview

### Check the queue

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.

## Review whitelists

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.

### Board

The columns change with the mode:

| Setup                                                         | Columns                                                               |
| ------------------------------------------------------------- | --------------------------------------------------------------------- |
| **Manual review** without interview                           | **In review** → **Approved** / **Refused**                            |
| **Manual review** with interview                              | **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.

### 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."

### Statuses

| Status        | Meaning                                                        |
| ------------- | -------------------------------------------------------------- |
| **Answering** | The person is still answering                                  |
| **In review** | Answers sent, waiting for the team                             |
| **Interview** | Waiting for the interview                                      |
| **Approved**  | Got the approved role and can unlock their ID                  |
| **Refused**   | Refused or failed (can try again after the **Try again** time) |
| **Expired**   | Time ran out or the person canceled                            |

### Whitelist numbers

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**.

## Result in a channel and logs

| Field                   | What it does                                                                                 | Default                                                                                        |
| ----------------------- | -------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- |
| **Announce the result** | Posts a message in a channel when the whitelist is approved or failed, mentioning the person | Off                                                                                            |
| **Results channel**     | Where the bot posts approvals and failures                                                   | None                                                                                           |
| **Approved**            | The approval text                                                                            | "{membro}, your **WHITELIST** was **APPROVED** on our server. Congratulations and welcome! 🎉" |
| **Failed**              | The failure text. {motivo} becomes the score or the reason                                   | "{membro}, your **WHITELIST** was **DENIED** on our server. **REASON:** *{motivo}*"            |
| **Log channel**         | Optional. Approvals, refusals, interviews and unlocks                                        | None                                                                                           |

**Result in a channel** doesn't exist in **Unlock only** mode. The bot pack's icon goes in front of each message.

## Unlock

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**.

### Panel

| Field                             | What it does                                                                                                                                                                                                                           | Default                               |
| --------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------- |
| **Channel**                       | Where the panel with the unlock button sits                                                                                                                                                                                            | None (required with the whitelist on) |
| **Approved members' role**        | 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                                                                                                 | Off                                   |
| **Title, text, button and image** | The panel's texts                                                                                                                                                                                                                      | Title "Unlock", button "Unlock my ID" |

### Form

| Field                            | What it does                                                                                                                 | Default |
| -------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ------- |
| **Ask for the character's name** | Besides the ID, the form asks for the character's name (up to 60 characters). With it, the bot changes the person's nickname | On      |
| **One ID per account**           | Refuses an ID already unlocked for another Discord account                                                                   | On      |

The ID is up to 12 characters, digits only (for example, `1234`).

### On unlock

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`.

### /liberar command

The team uses `/liberar` on Discord to unlock an ID right away, and `/remover` to take the whitelist away.

| Field                     | What it does                                                                                                               | Default                    |
| ------------------------- | -------------------------------------------------------------------------------------------------------------------------- | -------------------------- |
| **Roles that can use it** | Up to 10 team roles that can use `/liberar` and `/remover`. Administrators and anyone who can manage the server always can | None (administrators only) |

| Command    | Options                                                    | What it does                                                                                                                                  |
| ---------- | ---------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- |
| `/liberar` | `id` (the game ID or token, up to 12 characters), `membro` | Unlocks the ID in the city. With `membro`, the bot also gives the unlocked role and takes the whitelist back if the person leaves the Discord |
| `/remover` | `id`, `membro` (give one or both)                          | Takes the whitelist and the unlocked role away from the ID or the member                                                                      |

Without the server connected, give the `membro`: the bot only gives (or takes) the role. See every command in [Commands](https://fivedash.fivex.gg/docs/en/discord/commands).

## Unlock in the game

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                                                                                |

Details per framework in [Frameworks](https://fivedash.fivex.gg/docs/en/developers/frameworks).

| In-game status  | Meaning                                                                                                |
| --------------- | ------------------------------------------------------------------------------------------------------ |
| **Queued**      | Waiting for the server to unlock the ID in the city (server offline: the unlock waits until it's back) |
| **In the city** | Unlocked in the game                                                                                   |
| **Failed**      | The server couldn't unlock the ID in the city. Unlock it in the game                                   |
| **Removed**     | Left the Discord and lost the whitelist in the city                                                    |

> If the card shows&#x20;
>
> **in-game whitelist unavailable**
>
> , the framework's whitelist isn't on in the city. The warnings in&#x20;
>
> **Server → Game connection**
>
> &#x20;say what's missing. Until then, unlocking only gives the role on Discord.

### Unlocked

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

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.

### Code panel

| Field                             | What it does                                                                                                                                                                                  | Default                               |
| --------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------- |
| **Use codes**                     | 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.

### Generate codes

### Open the generator

In **Discord → Whitelist → Codes**, scroll to **Codes** and click **Generate codes**.

### Pick the type

**Several random** (with **Amount** and an optional **Prefix**) or **One custom** (for example, `PARTNER-VIP`).

### Set the limit, validity and note

Pick the **Use limit**, the **Validity** and, if you want, a **Note** to remember who it was for.

### Create and copy

Click **Generate 10 codes** (or **Create code**). Use **Copy all** and send them to whoever will use them. Click **Done**.

| Field         | What it does                                                                                               | Default        |
| ------------- | ---------------------------------------------------------------------------------------------------------- | -------------- |
| **Code type** | **Several random** or **One custom**                                                                       | Several random |
| **Amount**    | How many random codes to generate (1 to 50)                                                                | 10             |
| **Prefix**    | Optional. Up to 10 letters, numbers or hyphens, like `CITY`. Codes look like `CITY-7KQ2M9XA`               | Empty          |
| **Code**      | Custom: 3 to 24 letters, numbers or hyphens                                                                | Empty          |
| **Use limit** | **One** person, **Up to a limit** (up to 10,000 people) or **No limit**. Each person uses a code only once | One            |
| **Validity**  | **No expiration**, 1 day, 7 days, 30 days or 90 days                                                       | No expiration  |
| **Note**      | Only the team sees it (up to 80 characters)                                                                | Empty          |

Random codes never use `0`, `O`, `1`, `I` or `L`, so nobody mixes them up when typing. Case and spaces don't matter when typing a code.

### Manage codes

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.

## Messages and look

Each tab has two shortcuts: **Messages** (texts and images) and **Embed**.

### Messages

| Message               | When it shows                                                   | Default                                                                                                                           |
| --------------------- | --------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- |
| **Panel** (whitelist) | The public panel with the button                                | Title "Whitelist", button "Start whitelist"                                                                                       |
| **Reply**             | When finishing the quiz (with the score) or sending the answers | The bot's text                                                                                                                    |
| **Interview**         | By DM to whoever goes to the interview                          | See the **Interview** section                                                                                                     |
| **Approved**          | By DM when the whitelist is approved, with the unlock link      | "Congratulations, {membro}! You were approved in the **{servidor}** whitelist. Now just unlock your access with your in-game ID." |
| **Refused**           | By DM when the whitelist is refused, with the reason below      | "Your whitelist on **{servidor}** wasn't approved this time, {membro}."                                                           |
| **Panel** (unlock)    | The unlock panel                                                | "Passed the whitelist? Join the city once, grab your ID and send it here. You're unlocked on the spot."                           |
| **Unlocked**          | Shown to the person as soon as the ID is unlocked               | See the **On unlock** section                                                                                                     |
| **Panel** (code)      | The code panel                                                  | "Got a code from the team? Use the button below to redeem it and skip the whitelist."                                             |
| **Accepted**          | When the code is valid, with the unlock link                    | "Code accepted, {membro}! You skipped the **{servidor}** whitelist. Now just unlock your access with your in-game ID."            |

Limits: title up to 80 characters, text up to 1,500, button up to 40. Optional images as PNG, JPG, WebP or GIF up to 1 MB, wide (2:1).

Variables (type `/` in the field to insert them). The tokens are the same in every language:

| Variable       | What it becomes                                | Where it works                           |
| -------------- | ---------------------------------------------- | ---------------------------------------- |
| `{membro}`     | Mentions the person                            | DMs, replies and the result in a channel |
| `{servidor}`   | The Discord server's name                      | Every text                               |
| `{motivo}`     | Why it was refused (or "Motivo não informado") | Result in a channel                      |
| `{personagem}` | The character's name from the form             | Nickname format                          |
| `{id}`         | The game ID                                    | Nickname format                          |
| `{nome}`       | The person's name on Discord                   | Nickname format                          |

### Embed

| Field             | What it does                                                                       | Default   |
| ----------------- | ---------------------------------------------------------------------------------- | --------- |
| **Color**         | The side bar of the panels, replies and DMs. Refusals stay red                     | Bot color |
| **Server header** | The server's name and icon at the top of the panels                                | On        |
| **Thumbnail**     | Optional. Square image to the right of the panel                                   | None      |
| **Footer**        | Optional. Text (up to 100 characters) with an icon from the bot's pack on its left | Empty     |

## FAQ

**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.

## Next steps

[Bot](https://fivedash.fivex.gg/docs/en/discord/bot)Connect the bot and adjust its profile and emojis.
[Commands](https://fivedash.fivex.gg/docs/en/discord/commands)Every command, including /liberar and /remover.
[Install the resource](https://fivedash.fivex.gg/docs/en/getting-started/install-resource)Unlock the ID straight in the game.
[Moderation](https://fivedash.fivex.gg/docs/en/discord/moderation)/kick and /ban, which can also remove the whitelist.
