API ReferenceEnchanted Link
POST
/v1/auth/enchantedlink/verify

Verify that the enchanted link token in the URL clicked by the end user matches and has not expired. This endpoint completes the enchanted link flow for:

Next Steps

Poll for the successful completion of the token verification using the Poll Session endpoint, providing the pendingRef returned by the this endpoint.

The response object will be empty when this endpoint completes successfully. The session information will be returned by the the Poll Session endpoint.

See Also

  • See Enchanted link Authentication for details about implementing enchanted links.
  • See The User Object for further details on how to identify users and their contact information such as email addresses and phone number.

Endpoint Authentication

Use authorization bearer header with the following format:

Authorization: Bearer \<Project ID\>

Try it

/v1/auth/enchantedlink/verify

The Authorization access token

Authorization

Authorization
Required
Bearer <token>

In: header

Request Body

tokenstring

pkceVerifierstring

Format: "bytes"
Status codeDescription
200OK
curl -X POST "https://api.descope.com/v1/auth/enchantedlink/verify" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer <Project ID>" \
  -d '{
  "token": "string",
  "pkceVerifier": "string"
}'

{}

Was this helpful?

Previous

Sign-In with Auto Sign-Up

Next

Poll Session