Quick Start

This tutorial will guide you through setting up your account and verifing your first phone number.

Setup your Account

To start, create a free Authmoji account at https://authmoji.com.

After creating your account, navigate to "Settings" to configure your callback URL and copy your project ID and secret key.

  • Callback URL - When a user successfully authenticates one of your Authmoji sequences, they will be redirected to your callback URL with a success token. Defaults to /callback.
  • Secret Key - A private identifier used to authenticate the creation of new Authmoji sequences for your project and verify success tokens. This key should not be shared with anyone and should be stored in a secure location.
  • Project ID - A unique identifier used to associate Authmoji sequences and success tokens with your project.
Authmoji Project Information

Verify phone numbers

To verify your user's phone number, you will use the Authmoji API to create a new emoji sequence. The correct emoji sequence will be sent in a text message to the provided phone number.

const phoneNumber = "12025550158";
const response = await fetch(`https://app.authmoji.com/api/sequences`, {
  method: "post",
  headers: {
    authorization: process.env.AUTHMOJI_SECRET,
    'content-type': 'application/json',
  },
  body: {
    tel: phoneNumber,
  },
});


// Grab the unique identifier for the Authmoji verification page
const { sequence_id } = await response.json();

The API response will contain a sequence_id, a unique identifier for the emoji sequence. You should redirect your user to Authmoji's verification page with the sequence_id.

window.location.href = `https://app.authmoji.com/verify/${sequence_id}`

When your user lands on Authmoji's verification page, they will select emojis matching the sequence they received in a text message to their phone number.

Authmoji Verification Page

After the user confirms the emoji sequence, they will be redirected back to your callback URL with a success token in the query string.

window.location.href = `https://{your_domain}/callback?code=xxx`

Finally, you'll want to verify the success token is coming from Authmoji. Using any JWT library, you can verify the success token using your project's secret key. Set the audience to your project ID and the issuer to https://app.authmoji.com.

import jwt from 'jsonwebtoken';


const verifiedJwt = jwt.verify(
  req.query.code,
  process.env.AUTHMOJI_SECRET, 
  {
    issuer: "https://app.authmoji.com",
    audience: process.env.AUTHMOJI_ID,
  }
);


// If the sequence was entered correctly, status will be completed
if (verifiedJwt.status === "COMPLETED") {
  console.log("Success", verifiedJwt.tel);
} else if (verifiedJwt.status === "FAILED") {
  console.log("Failed", verifiedJwt.tel);
}

That's it! Now check your project's dashboard: https://app.authmoji.com.

What's Next

Check out our example React application using Authmoji: