JavaScript SDK
Advanced fingerprinting and verification for web applications
Installation
Get started by installing the Trueguard JavaScript SDK
# npm
npm install @trueguard/trueguard-js
# yarn
yarn add @trueguard/trueguard-js
# pnpm
pnpm add @trueguard/trueguard-js
Quick Start
Get up and running with fingerprinting in minutes
Basic Usage
import { Trueguard } from "@trueguard/trueguard-js";
// Initialize with your public API key
const trueguard = new Trueguard({ apiKey: "your-public-api-key" });
// Create a verification session
try {
const verificationId = await trueguard.verificationSession();
console.log("Verification ID:", verificationId);
// Use this verification ID in your backend API calls
// to associate user actions with this fingerprint session
} catch (error) {
console.error("Verification failed:", error.message);
}
Public API Key: Use your public API key (starts with "pub-") in the frontend. Never expose your secret API key in client-side code.
API Reference
Complete reference for the Trueguard class and methods
Constructor
new Trueguard(config: InitData)
Parameters:
config.apiKey
(string) - Your public API key
Methods
verificationSession(): Promise<string>
Initiates a verification session by collecting browser and network fingerprints.
Returns:
Promise<string>
- Unique verification ID
Throws:
Error
- If error occurs