Clerk docs

Allow-list / Block-list

Allow-lists and Block-lists allow you to control who can sign up or sign in to your application, by restricting access based on the user's email address or phone number.

https://clerk.com/docs/authentication/allowlist

List all identifiers on the allow-list

Get a list of all identifiers allowed to sign up to an instance

SecuritybearerAuth
Request
query Parameters
paginated
boolean

Whether to paginate the results. If true, the results will be paginated. If false, the results will not be paginated.

limit
integer [ 1 .. 500 ]
Default: 10

Applies a limit to the number of results returned. Can be used for paginating the results together with offset.

offset
integer >= 0
Default: 0

Skip the first offset results when paginating. Needs to be an integer greater or equal to zero. To be used in conjunction with limit.

Responses
200

Success

401

Authentication invalid

402

Payment required

get/allowlist_identifiers
Response samples
application/json
[
  • {
    }
]

Add identifier to the allow-list

Create an identifier allowed to sign up to an instance

SecuritybearerAuth
Request
Request Body schema: application/json
identifier
required
string

The identifier to be added in the allow-list. This can be an email address, a phone number or a web3 wallet.

notify
boolean
Default: false

This flag denotes whether the given identifier will receive an invitation to join the application. Note that this only works for email address and phone number identifiers.

Responses
200

Success

400

Request was not successful

402

Payment required

422

Invalid request parameters

post/allowlist_identifiers
Request samples
application/json
{
  • "identifier": "string",
  • "notify": false
}
Response samples
application/json
{
  • "object": "allowlist_identifier",
  • "id": "string",
  • "invitation_id": "string",
  • "identifier": "string",
  • "identifier_type": "email_address",
  • "instance_id": "string",
  • "created_at": 0,
  • "updated_at": 0
}

Delete identifier from allow-list

Delete an identifier from the instance allow-list

SecuritybearerAuth
Request
path Parameters
identifier_id
required
string

The ID of the identifier to delete from the allow-list

Responses
200

Deleted Object

402

Payment required

404

Resource not found

delete/allowlist_identifiers/{identifier_id}
Response samples
application/json
{
  • "object": "string",
  • "id": "string",
  • "slug": "string",
  • "deleted": true
}

List all identifiers on the block-list

Get a list of all identifiers which are not allowed to access an instance

SecuritybearerAuth
Responses
200

Success

401

Authentication invalid

402

Payment required

get/blocklist_identifiers
Response samples
application/json
{
  • "data": [
    ],
  • "total_count": 0
}

Add identifier to the block-list

Create an identifier that is blocked from accessing an instance

SecuritybearerAuth
Request
Request Body schema: application/json
identifier
required
string

The identifier to be added in the block-list. This can be an email address, a phone number or a web3 wallet.

Responses
200

Success

400

Request was not successful

402

Payment required

422

Invalid request parameters

post/blocklist_identifiers
Request samples
application/json
{
  • "identifier": "string"
}
Response samples
application/json
{
  • "object": "blocklist_identifier",
  • "id": "string",
  • "identifier": "string",
  • "identifier_type": "email_address",
  • "instance_id": "string",
  • "created_at": 0,
  • "updated_at": 0
}

Delete identifier from block-list

Delete an identifier from the instance block-list

SecuritybearerAuth
Request
path Parameters
identifier_id
required
string

The ID of the identifier to delete from the block-list

Responses
200

Deleted Object

402

Payment required

404

Resource not found

delete/blocklist_identifiers/{identifier_id}
Response samples
application/json
{
  • "object": "string",
  • "id": "string",
  • "slug": "string",
  • "deleted": true
}
➔ Next to Clients