Prove Auth PPB Integration

Privacy-preserving biometric module adds integration between Prove Auth and 3-rd party components providing identity verification using biometric data, collected without compromising user privacy.

Overview

This integration enables Privacy-Preserving Biometrics (PPB) and Document Verification (DocV) authentication flows within Prove Auth applications by integrating PPB web component. It adds biometric verification capabilities into Prove's authentication framework.

Installation

npm install @prove-identity/prove-auth-ppb

Prerequisites

• @prove-identity/prove-auth (peer dependency)
• Modern web browser with support for:
  • Web Components
  • WebAssembly
  • Camera access (for biometric verification)

Usage

Basic Setup

import * as ppbMod from '@prove-identity/prove-auth-ppb';
import { AuthenticatorBuilder } from '@prove-identity/prove-auth';

// Activate the PPB integration
ppbMod.activate();

// Build authenticator with PPB support
const authenticator = new AuthenticatorBuilder().withPrivacyPreservingBiometrics().build();

PPB Authentication Flow

The integration automatically handles:

• Biometric enrollment (enroll operation)
• Biometric verification (verify operation)
• Web component lifecycle management
• Authentication result processing

Supported Operations

| Operation | Description | AuthID Component | | --------- | ---------------------- | ------------------------------- | | enroll | Biometric enrollment | Identity verification component | | verify | Biometric verification | Authentication component |

API Reference

Methods

activate(): void

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

Error Handling

The integration provides detailed error messages for common failure scenarios:

• Missing endpoint URL
• Invalid operation type
• Missing operation ID or secret
• Web component initialization failures
• Authentication failures

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-ppb

Testing

npm test -w integrations/prove-auth-ppb

Bundling

npm run bundle -w integrations/prove-auth-ppb

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-2026 Prove Identity, Inc. All rights reserved.