PIIRedact 1.0.19

dotnet add package PIIRedact --version 1.0.19                
NuGet\Install-Package PIIRedact -Version 1.0.19                
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="PIIRedact" Version="1.0.19" />                
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add PIIRedact --version 1.0.19                
#r "nuget: PIIRedact, 1.0.19"                
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
// Install PIIRedact as a Cake Addin
#addin nuget:?package=PIIRedact&version=1.0.19

// Install PIIRedact as a Cake Tool
#tool nuget:?package=PIIRedact&version=1.0.19                


Redacts the PII information. This package uses Stanford NER package to identify and scrub Name, organization and location. It also redacts email, ssn, driver license, passport no. It aggressively removes any number with more than 3 consecutive digits. Use AddToWhitelist to whitelist any pattern. In order to use this you must have JAVA 8+ installed.

Getting Started

Install the nuget package to get started.

The usage is: var redactor = new PIIRedactor(); var redactedData = redactor.GetRedactedData("My name is John Doe. My email is m@n.o");

The redacted string looks like : My name is xxxx xxx. My email is x@x.x

If you want to whitelist any pattern i.e any number with 6-8 consecutive digits, it should be done as follows: redactor.AddToWhitelist(new RegexFinder("\b\d{6,8}\b"));

Similarly to add a new redactable pattern follow the below syntax. It will redact any word with 6-8 consecutive digits. redactor.Add(new RegexFinder("\b\d{6,8}\b"));


In order to use this package , you have to have JAVA 8 installed. If you don't want to use java, you have to set redactor.PIIRedactorConfig.IncludeEntityRedaction = false;


We use appveyor for versioning.


Musfiqur Rahman

See also the list of contributors who participated in this project.


This project is licensed under the MIT License - see the LICENSE.md file for details


This project uses Standford NER package.

Product Compatible and additional computed target framework versions.
.NET Framework net452 is compatible.  net46 was computed.  net461 was computed.  net462 was computed.  net463 was computed.  net47 was computed.  net471 was computed.  net472 was computed.  net48 was computed.  net481 was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
1.0.19 1,647 11/11/2017
1.0.18 1,021 11/4/2017
1.0.17 1,031 11/4/2017
1.0.16 1,003 10/30/2017
1.0.13 948 10/30/2017
1.0.12 995 10/29/2017

Added license information