Next.js
useSignInEmailOTP()
Use the hook useSignInEmailOTP
to sign in a user with a one-time password sent via email.
Usage
- Call the
signInEmailOTP
function with the user’s email to send a one-time password (OTP) to that email address. - The state
needsOtp
will betrue
, indicating that an OTP is required. - Once the user receives the OTP via email, call the
verifyEmailOTP
function with the email and the received OTP. - On successful verification, the user is authenticated, and
isSuccess
becomestrue
.
Any error is monitored through isError
and error
. While the signInEmailOTP
and verifyEmailOTP
actions are running, isLoading
equals true
.
Parameters
options optional EmailOTPOptions