Skip to main content
POST
/
user-authenticators
/
email-magic-link
Start Email Magic Link Enrollment
curl --request POST \
  --url https://api.authsignal.com/v1/client/user-authenticators/email-magic-link \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "email": "<string>"
}
'
{
  "challengeId": "<string>",
  "userAuthenticatorId": "<string>",
  "userId": "<string>"
}

Documentation Index

Fetch the complete documentation index at: https://docs.authsignal.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

Use a short-lived token obtained from the Server API's Track Action endpoint. The token is valid for 10 minutes and should be passed in the Authorization header as 'Bearer {token}'.

Body

application/json
​
email
string
required

The user’s email address.

Response

OK

​
challengeId
string

The ID of the challenge. Pass this ID back to check if the user has clicked on the magic link and finalize the challenge.

​
userAuthenticatorId
string

The ID of the email authenticator which has been created but not yet verified.

​
userId
string