Whitelists API

Create and manage custom whitelists to override email validation checks.

  • Each user can have multiple whitelists
  • Whitelist names must be unique per user
  • Domains are case-insensitive
  • Both full domains and root domains are supported

Overview

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.

API Endpoints

MethodEndpointDescription
POST/whitelistsCreate a new whitelist
GET/whitelistsList all whitelists
GET/whitelists/{id}Retrieve a specific whitelist
PUT/whitelists/{id}Update a whitelist
DELETE/whitelists/{id}Delete a whitelist

Create 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" }

Get all Whitelists

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 } }

Get a Whitelist

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>" ] } }

Update a Whitelist

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" }

Using Whitelists in Check API

You can use a whitelist when checking an email by adding thewhitelistIdquery parameter to the check endpoint.

GET /check/example@company.com?whitelistId=your_whitelist_id
Unfake

Unfake

beta

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.