@keverdjs/fraud-sdk

Vanilla JavaScript SDK for Keverd fraud detection and device fingerprinting. Works in any JavaScript environment (browser, Node.js, etc.).

✨ Features

- Custom Fingerprinting System: Built from scratch with 15+ fingerprint collectors (no external dependencies)
- Stable Visitor ID: Deterministic device identification across browsers
- Behavioral Biometrics: Typing patterns, mouse movements, swipe gestures
- Privacy Signals: Incognito mode, VPN, automation detection
- Use-Case Specific: Login, checkout, registration, password reset, account change verification
- Zero Dependencies: No external libraries required

Installation

``bash
npm install @keverdjs/fraud-sdk
`

Quick Start

`javascript
import { Keverd } from '@keverdjs/fraud-sdk';

// Initialize with API key
Keverd.init('your-api-key');

// Get visitor data and risk assessment
const result = await Keverd.getVisitorData();

console.log('Risk Score:', result.risk_score);
console.log('Action:', result.action);
console.log('Session ID:', result.session_id);
`

$3

`javascript
import { Keverd } from '@keverdjs/fraud-sdk';

// Initialize with configuration
Keverd.init({
apiKey: 'your-api-key',
debug: true, // Optional: enable debug logging
});

// Get visitor data
const result = await Keverd.getVisitorData();
`

API Reference

$3

Initialize the SDK with your API key.

Parameters:
- config (string | SDKConfig): API key string or configuration object

Example:
`javascript
// Simple initialization
Keverd.init('your-api-key');

// With options
Keverd.init({
apiKey: 'your-api-key',
userId: 'optional-user-id',
debug: false
});
`

$3

Get visitor data and risk assessment. This is the main method for fraud detection.

Returns: Promise

Example:
`javascript
const result = await Keverd.getVisitorData();

// Result structure:
// {
// risk_score: 25, // 0-100
// score: 0.25, // 0.0-1.0
// action: 'allow', // 'allow' | 'soft_challenge' | 'hard_challenge' | 'block'
// reason: ['new_user'], // Array of risk reasons
// session_id: 'uuid', // Session identifier
// requestId: 'uuid', // Request identifier
// sim_swap_engine: {...} // SIM swap detection results (null for web)
// }
`

$3

Legacy method for backward compatibility. Returns the session ID from getVisitorData().

Parameters:
- metadata (TransactionMetadata, optional): Transaction metadata

Returns: Promise - Session ID

Example:
`javascript
const transactionId = await Keverd.createTransactionID({
amount: 1000,
currency: 'KES',
recipient: '254712345678'
});
`

$3

Destroy the SDK instance and stop all data collection.

Example:
`javascript
Keverd.destroy();
`

Response Structure

`typescript
interface FingerprintResponse {
risk_score: number; // 0-100 risk score
score: number; // 0.0-1.0 normalized score
action: 'allow' | 'soft_challenge' | 'hard_challenge' | 'block';
reason: string[]; // Array of risk reasons
session_id: string; // UUID session identifier
requestId: string; // UUID request identifier
sim_swap_engine?: { // SIM swap detection (null for web SDKs)
userId?: string;
risk: number;
flags: {
sim_changed?: boolean;
device_changed?: boolean;
behavior_anomaly?: boolean;
time_anomaly?: boolean;
velocity_anomaly?: boolean;
};
updatedProfile?: Record;
};
}
``

Browser Support

- Chrome (latest)
- Firefox (latest)
- Safari (latest)
- Edge (latest)

License

MIT

Support

For issues, questions, or contributions, please visit the GitHub repository.