Create and manage custom whitelists to override email validation checks.
The Whitelists API enables you to create, manage, and use custom lists of domains that will always be considered valid, overriding our standard email validation checks.
Method | Endpoint | Description |
---|---|---|
POST | /whitelists | Create a new whitelist |
GET | /whitelists | List all whitelists |
GET | /whitelists/{id} | Retrieve a specific whitelist |
PUT | /whitelists/{id} | Update a whitelist |
DELETE | /whitelists/{id} | Delete a whitelist |
To create a new whitelist, send a POST request to the /whitelists
endpoint with the following payload:
{
"domains": [
"example.com",
"company.org"
],
"name": "Trusted Domains",
"description": "Domains we always want to allow"
}
To get all whitelists, send a GET request to the /whitelists
endpoint. You can also pass a limit
and page
parameter to paginate through the results. A response will look like this:
{
"data": [
{
"id": "<whitelist_id>",
"user": "<user_id>",
"name": "<whitelist_name>",
"description": "<whitelist_description>",
"domains": [
"<domain1>",
"<domain2>",
"<domain3>"
],
"createdAt": "<created_at>",
"updatedAt": "<updated_at>"
}
],
"meta": {
"page": 1,
"limit": 10,
"total": 1,
"totalPages": 1
}
}
To get a specific whitelist, send a GET request to the /whitelists/{'{id}'}
endpoint. A response will look like this:
{
"data": {
"id": "<whitelist_id>",
"user": "<user_id>",
"name": "<whitelist_name>",
"description": "<whitelist_description>",
"domains": [
"<domain1>",
"<domain2>",
"<domain3>"
]
}
}
To update a whitelist, send a PUT request to the /whitelists/{'{id}'}
endpoint with the payload similar to the one used in the Create a Whitelist
section. Here is an example:
{
"domains": [
"example.com",
"company.org"
],
"name": "Updated Whitelist",
"description": "Updated description"
}
You can use a whitelist when checking an email by adding thewhitelistId
query parameter to the check endpoint.
GET /check/example@company.com?whitelistId=your_whitelist_id
Unfake
You can focus on what matters for your business instead of worrying about temp mail and spam detection. With our API, your systems are protected from fake email addresses.
Made with ❤️ in India.
Copyright © 2025 Unfake | All rights reserved.