Skip to main content

Installation

Zero external dependencies — uses only built-in .NET libraries (System.Text.Json). Targets net6.0, net8.0, and netstandard2.1.

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

All methods are async with Async suffix and accept an optional CancellationToken parameter. The client implements IDisposable.

DetectAsync

Identify PII without modifying the text.

TokenizeAsync / Detokenize

Replace PII with reversible tokens, then restore.

RedactAsync

Permanently remove PII from text.

MaskAsync

Partially hide PII while keeping some characters visible.

HashAsync

Create deterministic identifiers for analytics.

EncryptAsync

Encrypt PII using AES-256.

SynthesizeAsync

Replace PII with realistic fake data.

Batch Processing

Process multiple texts in a single call.
All methods have batch variants: DetectBatchAsync, TokenizeBatchAsync, RedactBatchAsync, MaskBatchAsync, HashBatchAsync, EncryptBatchAsync, SynthesizeBatchAsync.

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, API reference, and additional examples.