Start Email Magic Link Challenge

POST

challenge

email-magic-link

curl --request POST \
  --url https://api.authsignal.com/v1/client/challenge/email-magic-link \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "userAuthenticatorId": "<string>"
}
'

{
  "challengeId": "<string>"
}

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

userAuthenticatorId

string

The ID of the email authenticator to use. Only required if the user has multiple email authenticators and you want to target a specific one.

Response

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.

Finalize Email Magic Link ChallengeThe email magic link challenge is verified when the user clicks on the link sent to their email. Use this endpoint to finalize the challenge, checking if the user has clicked on the magic link (e.g. via polling).

⌘I

Start Email Magic Link Challenge

curl --request POST \
  --url https://api.authsignal.com/v1/client/challenge/email-magic-link \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "userAuthenticatorId": "<string>"
}
'

{
  "challengeId": "<string>"
}