Embedded Wallets
SDK
Javascript
How to
Setup Authentication
Whatsapp
Login

WhatsApp Login

Using whatsapp login does not require you to interact with any register endpoint, because it automatically registers the user when they login with their whatsapp number.

ℹ️

Before getting started, you need to follow Configuring WhatsApp Meta Business

⚠️

This endpoint is rate limited, you can only send 1 request per minute before you can send another request.

Overview

This API allows you to login to your Xellar Embedded wallet account using User’s whatsapp number.

Parameters

  • phoneNumber (string, required): User's chosen phone number for their WhatsApp number.

Returns

A WhatsAppLoginResponse object containing:

  • verifyToken (string): A token used for verification in subsequent steps.
  • isWalletCreated (boolean): Indicates whether the user has already created a wallet or not.
{
  "verifyToken": "1234567890",
  "isWalletCreated": true | false
}

Example Usage

const phoneNumber = "65212232422";
const response = await sdk.auth.whatsapp.login(email);