Clerk API (unofficial showcase)
POST/allowlist_identifiers

Add identifier to the allow-list

Create an identifier allowed to sign up to an instance

  • IdempotentThe SDK sends Idempotency-Key, so a retried request is only applied once.

2 body fields
identifierstringrequired
The identifier to be added in the allow-list. This can be an email address, a phone number, or a web3 wallet.
notifybooleanoptional
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.
Default:false

4 status codes
200Success
objectstringoptional
String representing the object's type. Objects of the same type share the same value.
Allowed:allowlist_identifier
idstringoptional
invitation_idstringoptional
identifierstringoptional
An email address or a phone number.
identifier_typestringoptional
Allowed:email_addressphone_numberweb3_wallet
instance_idstringoptional
created_atintegeroptional
Unix timestamp of creation
updated_atintegeroptional
Unix timestamp of last update.
400Request was not successful
errorsarray<object>required
metaobjectoptional
clerk_trace_idstringoptional
402Payment required
errorsarray<object>required
metaobjectoptional
clerk_trace_idstringoptional
422Invalid request parameters
errorsarray<object>required
metaobjectoptional
clerk_trace_idstringoptional

Error handling

A 400 is returned: Request was not successful. A 402 is returned: Payment required. A 422 is returned: Invalid request parameters.