Interface PasswordlessClient

Public interface for the passwordless client. Accessible via auth0.passwordless after initialization.

interface PasswordlessClient {
start(options: PasswordlessStartOptions): Promise<void>;
verify(options: PasswordlessVerifyOptions): Promise<void>;
}

Index

Methods

Methods

start

start(options: PasswordlessStartOptions): Promise<void>
Starts a passwordless authentication flow by sending an OTP or magic link to the user's email address or phone number.

For magic link (send: 'link') in App Router, the transaction cookie is written via next/headers automatically. In Pages Router, pass explicit req and res so the cookie can be set on the response.
Parameters
- options: PasswordlessStartOptions
  Connection type and user identifier.
Returns Promise<void>
- Defined in src/types/passwordless.ts:145

verify

verify(options: PasswordlessVerifyOptions): Promise<void>
Verifies the OTP entered by the user and establishes an authenticated session.
Parameters
- options: PasswordlessVerifyOptions
  Connection type, user identifier, and OTP code.
Returns Promise<void>
- Defined in src/types/passwordless.ts:152