> For the complete documentation index, see [llms.txt](https://bewinxed.gitbook.io/niftybot/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://bewinxed.gitbook.io/niftybot/features/whitelisting.md).

# Whitelisting

## NiftyPASS Whitelist Tool

This tool allows you to **easily** collect wallet addresses **securely** and easily be able to export them to an **excel sheet,** It can also be used to collect wallet addresses for whitelist collaborations or any other purpose.

You can collect <mark style="color:purple;background-color:purple;">SOL</mark> or <mark style="color:green;background-color:green;">ETH</mark> addresses and the bot will verify the addresses for validity before submission.

![](/files/BhWiLeqZc4k6Laml0bC7)

### Flexible

You can create any number of whitelists and each whitelist can have a different sets of criteria:

* 🎭 Restrict wallet submission to certain **roles**.
  * Each role can have a <mark style="background-color:red;">cap</mark> on the number of wallet submissions.
  * You can allow people to submit only <mark style="background-color:red;">One</mark> address to a whitelist or allow certain roles to submit to multiple whitelists.
* 🪩 Restrict wallet submission to certain **channels**.
* 📆 Restrict wallet submission to a certain **deadline**.

You can also have a global **cap** that all the combined whitelists cannot exceed.

### Hype

The bot will show a counter of how many people have whitelisted right on the panel

#### Planned

The bot can make announcements in chats when you hit a certain threshold of whitelist submissions.

### Self Service

No need to busy your mods with managing wallet submissions, asking if they're whitelisted or not, or updating wallet addresses, each member can manage their submissions by themselves.

Using the bot, your members can:

* 🤔 Check if they’re whitelisted.
* ✍️ Update their wallet address at any time.

### Customizable

* The whitelist panel can be customized with a logo/banner of your choice, each panel can have its own branding and can reflect your brand on the submission buttons.

### Secure & Private

Your users will enter their info in the bot **securely** without announcing their wallets in the server, for privacy and security, this also protects your users from wallet scrapers and sniffers.

### Admin-Friendly

* You can purge or delete whitelists at any time and **undo** your actions at any time.
* You can allow certain users to manage whitelists.
* You can export any whitelist or all whitelists to an Excel sheet that has the usernames, IDs, mentions, and wallet addresses.

**This tool is included in all niftyBOT packages.**

## Available Commands:

Just type **/whitelist** and you will see all the available commands

![](https://i.imgur.com/eV3Fqrx.png)

### Creating Whitelists

Type /whitelist create and you will see all the available options

#### Options:

* **Name:** Set any name you like for the whitelist, for reference.
* **Cap:** Set a global cap for this whitelist, all the participants inside this whitelist cannot exceed this number
* **Month/Day/Hour/Minute:** Set a deadline for entering the whitelist, people cannot enter the whitelist after this.

### Creating Whitelist Process

Just type <mark style="background-color:purple;">/create</mark> or <mark style="background-color:purple;">/whitelist create</mark> to start making your whitelist

![](/files/CHuV8G6kS4ETtbcnZkYc)

### View submission statistics

Type <mark style="background-color:purple;">/stats</mark> or <mark style="background-color:purple;">/whitelist stats</mark> to view a list of your whitelists and the number of submissions for each whitelist, as well as the total submissions.

![](/files/tfNN5xksJvI18Yqf65qP)


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://bewinxed.gitbook.io/niftybot/features/whitelisting.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.