Search…
Blocklist Identifiers
Learn how to prevent access to your application for certain emails, domain, phones or web3 wallets

Overview

The blocklist feature allows you to control who should not be allowed access to your application. It basically prevents sign ups and sign ins for certain set of identifiers, which can be email addresses, email domains, phone numbers or web3 wallets.
In order to add a set of email addresses to your blocklist identifiers, simply pass an asterisk as the email inbox. The asterisk will act as a wildcard and add all inboxes for a certain email domain.
Here's an example. If you add *@clerk.dev as your blocklist identifier, it means that email addresses from the clerk.dev email domain cannot sign up or sign in to your application. Email addresses from different domains can have access to it.
In order to use the blocklist feature, it needs to be enabled for your instance. To enable it, use our Backend API to update your instance settings. Each instance of the app (development, staging, production) needs to be updated separately.

Available requests

  • GET /v1/blocklist_identifiers
  • POST/v1/blocklist_identifiers
  • DEL /v1/blocklist_identifiers/:id

Example blocklist identifier schema

{
"object": "blocklist_identifier",
"id": "blid_1sOWqxBnLKkD7Alxv5EymdOKjue",
"identifier": "+1655559004",
"identifier_type": "phone_number",
"created_at": 1620370000,
"updated_at": 1620370000
}
get
https://api.clerk.dev
/v1/blocklist_identifiers
List all blocklist identifiers
post
https://api.clerk.dev
/v1/blocklist_identifiers
Create a blocklist identifier
delete
https://api.clerk.dev
/v1/blocklist_identifiers/:id
Delete a blocklist identifier
Copy link
On this page
Overview
Available requests
Example blocklist identifier schema
get
List all blocklist identifiers
post
Create a blocklist identifier
delete
Delete a blocklist identifier