Presidio - Data Protection and Anonymization API

Context aware, pluggable and customizable PII anonymization service for text and images.

---

What is Presidio

Presidio (Origin from Latin praesidium ‘protection, garrison’) helps to ensure sensitive data is properly managed and governed. It provides fast identification and anonymization modules for private entities in text such as credit card numbers, names, locations, social security numbers, bitcoin wallets, US phone numbers, financial data and more.

Goals

• Allow organizations to preserve privacy in a simpler way by democratizing de-identification technologies and introducing transparency in decisions.
• Embrace extensibility and customizability to a specific business need.
• Facilitate both fully automated and semi-automated PII de-identification flows on multiple platforms.

Main features

1. Predefined or custom PII recognizers leveraging Named Entity Recognition, regular expressions, rule based logic and checksum with relevant context in multiple languages.
2. Options for connecting to external PII detection models.
3. Multiple usage options, from Python or PySpark workloads through Docker to Kubernetes.
4. Customizability in PII identification and anonymization.
5. Module for redacting PII text in images.

⚠️ Presidio can help identify sensitive/PII data in un/structured text. However, because Presidio is using trained ML models, there is no guarantee that Presidio will find all sensitive information. Consequently, additional systems and protections should be employed.

📔 Full documentation

💭 Try Presidio with your own data

Installing Presidio

1. Using pip
2. Using Docker
3. From source
4. Supported Python Versions
5. Migrating from V1 to V2

Running Presidio

1. Getting started
2. Setting up a development environment
3. PII anonymization in text
4. PII anonymization in images
5. Usage samples and example deployments

---

Support

• Before you submit an issue, please go over the documentation.
• For general discussions, please use the Github repo's discussion board.
• If you have a usage question, found a bug or have a suggestion for improvement, please file a Github issue.
• For other matters, please email presidio@microsoft.com.

Contributing

For details on contributing to this repository, see the contributing guide.

This project welcomes contributions and suggestions. Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, visit https://cla.microsoft.com.

When you submit a pull request, a CLA-bot will automatically determine whether you need to provide a CLA and decorate the PR appropriately (e.g., label, comment). Simply follow the instructions provided by the bot. You will only need to do this once across all repos using our CLA.

This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact opencode@microsoft.com with any additional questions or comments.