Documentation - Getting Started

Introduction #

Welcome to the AuthKey documentation. AuthKey provides phishing-resistant payment authentication using FIDO2 and WebAuthn standards. This guide will help you integrate secure, passwordless authentication into your application in minutes.

AuthKey replaces traditional authentication methods (passwords, SMS OTP, email codes) with cryptographic authentication that is immune to phishing, credential stuffing, and man-in-the-middle attacks.

AuthKey Architecture Overview — AuthKey architecture showing the flow from user device to your backend

Quick Tip

New to FIDO2? Check out our FIDO2 Overview to understand the fundamentals before diving into integration.

Key Features

AuthKey provides a comprehensive authentication solution with the following features:

Phishing-Resistant Authentication - Credentials are cryptographically bound to your domain
Biometric Support - Face ID, Touch ID, fingerprint, and Windows Hello
Adaptive Risk Engine - Real-time risk assessment for every transaction
Cross-Platform SDKs - Native SDKs for iOS, Android, Web, React Native, and Flutter
PSD2/SCA Compliant - Meet Strong Customer Authentication requirements

Quick Start Guide #

Get up and running with AuthKey in under 10 minutes. This quick start guide covers the essential steps to integrate authentication into your application.

Step 1: Create an Account

Sign up for an AuthKey account at dashboard.authkey.io. Once registered, you'll receive your API credentials:

API Key - Your public identifier
API Secret - Keep this secure, never expose in client-side code
Tenant ID - Your organization identifier

Step 2: Install the SDK

Install the AuthKey SDK for your platform:

npm

npm install @authkey/sdk

yarn

yarn add @authkey/sdk

Step 3: Initialize the SDK

Initialize AuthKey in your application:

javascript

import { AuthKey } from '@authkey/sdk';

// Initialize the SDK
const authkey = new AuthKey({
  apiKey: 'your-api-key',
  tenantId: 'your-tenant-id',
  environment: 'production' // or 'sandbox' for testing
});

// Register a new credential
const credential = await authkey.register({
  userId: 'user-123',
  displayName: 'John Doe'
});

// Authenticate user
const result = await authkey.authenticate({
  userId: 'user-123'
});
                        

Security Warning

Never expose your API Secret in client-side code. Use environment variables and server-side API calls for sensitive operations.

Code editor showing SDK integration — Example SDK integration in a React application

System Requirements #

AuthKey supports a wide range of platforms and browsers. Below are the minimum requirements for each platform:

Platform	Minimum Version	Biometric Support
iOS	iOS 14.0+	Face ID, Touch ID
Android	Android 8.0+ (API 26)	Fingerprint, Face Unlock
Chrome	Version 67+	Platform authenticators
Safari	Version 14+	Touch ID, Face ID (macOS)
Firefox	Version 60+	Platform authenticators
Edge	Version 79+	Windows Hello

Note

For browsers without WebAuthn support, AuthKey automatically falls back to secure alternative authentication methods while maintaining security standards.

Installation #

Choose the installation method that matches your development environment:

Web (JavaScript/TypeScript)

bash

                            # Using npm
npm install @authkey/sdk

# Using yarn
yarn add @authkey/sdk

# Using pnpm
pnpm add @authkey/sdk
                        

iOS (Swift)

swift package

                            // Add to your Package.swift dependencies
.package(url: "https://github.com/authkey/authkey-ios.git", from: "2.0.0")
                        

Or add via CocoaPods:

ruby

pod 'AuthKey', '~> 2.0'

Android (Kotlin/Java)

gradle

                            // Add to your app's build.gradle
dependencies {
    implementation 'io.authkey:sdk:2.0.0'
}
                        

Development environment setup — AuthKey integrates seamlessly with your existing development workflow