initSmsAuth

Begin authenticating a user through sms. Initializes the iframe stamper to get the target public key. This method sends a text message to the user to complete their login

Import

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

Usage

1
import { AlchemySignerWebClient } from "@account-kit/signer";
2
3
const client = new AlchemySignerWebClient({
4
  connection: {
5
    apiKey: "your-api-key",
6
  },
7
  iframeConfig: {
8
    iframeContainerId: "signer-iframe-container",
9
  },
10
});
11
12
const account = await client.initSmsAuth({ phone: "+1234567890" });

Parameters

params

Omit<SmsAuthParams, "targetPublicKey"> The parameters for sms authentication, excluding the target public key

Returns

Promise<any> The response from the authentication request