Skip to content

initEmailAuth

Begin authenticating a user with their email and an expiration time for the authentication request. Initializes the iframe stamper to get the target public key. This method sends an email to the user to complete their login

Import

import { AlchemySignerWebClient } from "@account-kit/signer";

Usage

import { AlchemySignerWebClient } from "@account-kit/signer";
 
const client = new AlchemySignerWebClient({
  connection: {
    apiKey: "your-api-key",
  },
  iframeConfig: {
    iframeContainerId: "signer-iframe-container",
  },
});
 
const account = await client.initEmailAuth({ email: "[email protected]" });

Parameters

params

Omit<EmailAuthParams, "targetPublicKey"> The parameters for email authentication, excluding the target public key

Returns

Promise<any> The response from the authentication request