Skip to main content
POST
Start Email Magic Link Challenge

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

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.

retryAfterSeconds
number

The number of seconds the client should wait before retrying the challenge. Only present if a rate limit threshold has been reached.

Example:

5