Authn-Id Project

This library allows you to easily add multi-factor authentication (MFA) or passwordless signin to your web application.

• You can simply add an email verification
• You can simply add MFA using fingerprint, Face ID or PIN powered by WebAuthn

Installation

Frontend

npm install @authn-id/browser

Email Verification

You can verify an email for multi-factor authentication, user registration or passwordless login.

1. Send a verification link (frontend)

const authnId = new AuthnId.Client({ apiKey: API_KEY });

const email = "[email protected]";
const { approved, token } = await authnId.verifyEmail(email);

if (approved) {
  const response = await fetch(`/your-backend/verifyEmail?token=${token}`);
  const verified = await response.json();
  if (verified.success) {
    // Success!
  }
}

2. Verify a token (backend)

const { token } = req.query;

const response = await fetch(apiUrl + "/verify/token", {
  method: "POST",
  body: token,
  headers: { "x-authnid-api-secret": API_SECRET, "Content-Type": "text/plain" },
});

var result = await response.json();
if (result.success) {
  // Success!
}

WebAuthn (Passkeys)

You can verify a user with platform authenticator for MFA or passwordless signin.

• Windows: Fingerprint, Facial recognition or PIN (Windows Hello)
• Mac & iOS: Touch ID or Face ID
• Android: fingerprint, face or screen lock

Registration

1. Retrieve a registration token (backend)

const body = {
  userId: "1234567",
  username: "[email protected]",
  displayName: "John Doe",
};

const response = await fetch(apiUrl + "/register/authenticator", {
  method: "POST",
  body: JSON.stringify(body),
  headers: {
    "x-authnid-api-secret": API_SECRET,
    "Content-Type": "application/json",
  },
});

const token = await response.text();

2. Initiate the registration (frontend)

const authnId = new AuthnId.Client({ apiKey: API_KEY });

const response = await fetch("/your-backend/registerAuthenticator");
const token = await response.text();

try {
  await authnId.registerAuthenticator(token);
  // Success!
} catch (e) {
  // Error
}

Authentication

1. Start the authentication (frontend)

const authnId = new AuthnId.Client({ apiKey: API_KEY });

const username = "[email protected]";
const token = await authnId.authenticate(username);

const response = await fetch(`/your-backend/verifyUser?token=${token}`);
const authenticated = await response.json();
if (authenticated.success) {
  // Success!
}

2. Verify the token (backend)

const { token } = req.query;

const response = await fetch(apiUrl + "/verify/token", {
  method: "POST",
  body: token,
  headers: { "x-authnid-api-secret": API_SECRET, "Content-Type": "text/plain" },
});

var result = await response.json();
if (result.success) {
  // Success!
}

Common

Frontend

import AuthnId from "@authn-id/browser";

Backend

const apiUrl = "https://api.authn.id/v1";