Allowlist Identifiers

This object represents an identifier (email address or phone number) which is allowed to sign-up. It is only used if you have enabled the "Allow List" beta feature. Related guide: Beta Features

Available requests

  • GET/v1/allowlist_identifiers

  • POST/v1/allowlist_identifiers

  • DELETE/v1/allowlist_identifiers/:id

Example allowlist identifier schema

{
"object": "allowlist_identifier",
"id": "alid_1sOWqxBnLKkD7Alxv5EymdOKjue",
"identifier": "+1655559004",
"created_at": 1620370000,
"updated_at": 1620370000
}

get
List all allowlist identifiers

https://api.clerk.dev/v1/allowlist_identifiers
List all allowlist identifiers.
Request
Response
Request
Headers
Authorization
required
string
Bearer [YOUR_API_KEY]
Response
200: OK
[
{
"object":"allowlist_identifier",
"id":"alid_1sOWqxBnLKkD7Alxv5Eym0OKjue",
"identifier":"[email protected]"
},
{
"object":"allowlist_identifier",
"id":"alid_1sOWqxBnLKkD7Alxv5EymdOKjue",
"identifier":"+12025559999"
}
]

post
Create an allowlist identifier

https://api.clerk.dev/v1/allowlist_identifiers
Add a new identifier to the allowlist.
Request
Response
Request
Headers
Authorization
required
string
Bearer [YOUR_API_KEY]
Body Parameters
notify
required
boolean
Send an invitation via SMS (for phone identifier) or email (for email address identifier).
identifier
required
string
An email address or a phone number in international format (E.164)
Response
200: OK
{
"object": "allowlist_identifier",
"id": "alid_1sOWqxBnLKkD7Alxv5EymdOKjue",
"identifier": "+1655559004"
}

delete
Delete an allowlist identifier

https://api.clerk.dev/v1/allowlist_identifiers/:id
Remove an identifier from the allowlist.
Request
Response
Request
Headers
Authorization
required
string
Bearer [YOUR_API_KEY]
Response
200: OK
{
"id": "alid_1sQqrOkmSTiXu8ho74r5lWuk3Zi",
"object": "allowlist_identifier",
"deleted": true
}