Skip to main content

Installation

Quick Start (Local Mode)

No API key needed — runs entirely in-process with 86 regex-based entity types.

Cloud API Setup

For NLP-powered detection (names, addresses, organizations), compliance policies, and audit logs:

Methods

Detect

Identify PII without modifying the text.

Tokenize / Detokenize

Replace PII with reversible tokens, then restore.

Redact

Permanently remove PII from text.

Mask

Partially hide PII while keeping some characters visible.

Hash

Create deterministic identifiers for analytics.

Encrypt

Encrypt PII using AES-256.

Synthesize

Replace PII with realistic fake data.

Batch Processing

Process multiple texts in a single call.

Async Client

For non-blocking operations using CompletableFuture.

Entity Filtering

Only detect specific entity types:

Error Handling

Locales

Configure country-specific entity detection:
Available locales: us, uk, eu, de, fr, es, it, pt, pl, cz, sk, ru, nl, ro, dk, se, no, be, at, ie, fi, hu, bg, hr, si, lt, lv, ee, ca, ch, au, nz, in, jp, kr, za, tr, il, ar, cl, co, br

Source Code

GitHub Repository

Full source code, Javadoc, and additional examples.