HEhexclave
OTP

Send sign-in code

Changed on

Send a code to the user's email address for sign-in.

post/auth/otp/send-sign-in-code

Request

  • Base URL
    https://api.hexclave.com/api/v1
  • URL
    https://api.hexclave.com/api/v1/auth/otp/send-sign-in-code
  • Auth
    none declared

Request body

emailstring required

The email to sign in with.

callback_urlstring required

The base callback URL to construct the magic link from. A query parameter code with the verification code will be appended to it. The page should then make a request to the /auth/otp/sign-in endpoint.

bot_challenge_tokenstring
bot_challenge_phase'invisible' | 'visible'
bot_challenge_unavailable'true'

Example request

{
  "email": "johndoe@example.com",
  "callback_url": "https://example.com/handler/magic-link-callback"
}

Response

Successful response

noncestring required

A token that must be stored temporarily and provided when verifying the 6-digit code

Example response

{
  "nonce": "u3h6gn4w24pqc8ya679inrhjwh1rybth6a7thurqhnpf2"
}

Changes

  • 180fda38d099Revision changes
    • breaking

      request property was restricted to a list of enum values

    • breaking

      request property was restricted to a list of enum values

    • info

      added the new invisible enum value to the request property

    • info

      added the new true enum value to the request property

    • info

      added the new visible enum value to the request property

  • 9025167b1683Revision changes
    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property