Prove Auth Device Context Integration

Device Context module adds integration between Prove Auth and 3-rd party components for enhanced device identification and fraud prevention.

Overview

This integration enables collection of Device Context data during Prove Auth authentication flows. It provides device identification capabilities that enhance security and user experience through persistent device recognition.

Installation

npm install @prove-identity/prove-auth-device-context

Prerequisites

• @prove-identity/prove-auth (peer dependency)
• Modern web browser with JavaScript enabled

Usage

Basic Setup

import * as dcMod from '@prove-identity/prove-auth-device-context';
import { AuthenticatorBuilder } from '@prove-identity/prove-auth';

// Activate the Device Context integration
dcMod.activate();

// Build authenticator with device context enabled
const authenticator = new AuthenticatorBuilder()
  .withDeviceContext({
    publicApiKey: 'your API key',
    buildConfig: BuildConfig.US_UAT,
  })
  .build();

Device Context Options

interface DeviceContextOptions {
  publicApiKey: string; // Device Conext API key
  buildConfig?: BuildConfig; // Environment configuration
  customScriptUrl?: string; // Custom script URL (optional)
  customEndpointUrl?: string; // Custom endpoint URL (optional)
}

API Reference

Methods

activate(): void

Activates Device Context integration. This function must be called at least once before running any authentication flows.

Browser Compatibility

• Chrome 60+
• Firefox 55+
• Safari 11+
• Edge 79+

Development

Run npm from the repository root directory using workspaces

Building

npm run build -w integrations/prove-auth-device-context

Testing

npm test -w integrations/prove-auth-device-context

Bundling

npm run bundle -w integrations/prove-auth-device-context

Configuration

Environment-Specific Settings

The integration supports different build configurations:

• BuildConfig.DEV - Development environment
• BuildConfig.US_UAT - User Acceptance Testing environment
• BuildConfig.US_PROD - Production environment

Custom Endpoints

You can specify custom script and endpoint URLs for on-premise deployments:

{
  publicApiKey: 'your-api-key',
  customScriptUrl: 'https://your-domain.com/fp-script.js',
  customEndpointUrl: 'https://your-domain.com/fp-endpoint'
}

License

This project is licensed under the Creative Commons Attribution NonCommercial NoDerivs 4.0 International License (CC BY-NC-ND 4.0).

Support

For technical support and documentation, visit:

• Prove Developer Portal

© 2023-2025 Prove Identity, Inc. All rights reserved.