Getting started with Anonymization API is simple. Create your free account, grab your API key, and start protecting sensitive data with just a few lines of code. No credit card required for the free tier.
From signup to your first anonymized response in under 5 minutes. Follow this guide to integrate privacy protection into your application.
Sign up for a free account using your email or SSO provider. No credit card is required for the free tier, which includes 1,000 API calls per month. You'll have immediate access to all core features including text anonymization, entity detection, and basic analytics.
1 minuteNavigate to your dashboard and generate your first API key. You can create multiple keys for different environments (development, staging, production) and set permissions for each. Keys can be rotated at any time without disrupting service.
30 secondsexport ANON_API_KEY="your_api_key_here"
We provide official SDKs for Python, JavaScript/Node.js, Java, Go, and Ruby. Each SDK handles authentication, retries, and error handling automatically. If you prefer, you can also use the REST API directly with any HTTP client.
1 minute# Python pip install anonymization-api # Node.js npm install @anonymization/api # Go go get github.com/anonymization/api-go
With your SDK installed and API key configured, you're ready to anonymize data. The example below shows how to detect and redact sensitive information from a text string. The response includes the anonymized text plus metadata about what was detected.
2 minutesfrom anonymization import Client # Initialize the client client = Client(api_key="your_api_key") # Anonymize text result = client.anonymize( text="John Smith's email is [email protected]", mode="redact" ) print(result.anonymized_text) # Output: [PERSON]'s email is [EMAIL]
We provide official SDKs for the most popular programming languages. Each SDK is fully typed, well-documented, and includes comprehensive examples.
pip install anonymization-api
npm install @anonymization/api
Maven: anonymization-api
go get anonymization/api-go
Every API response includes not just the anonymized text, but comprehensive metadata about what was detected and how it was transformed. This information is invaluable for auditing, debugging, and understanding how your data is being processed.
A list of all sensitive data found in the input, including the entity type (PERSON, EMAIL, SSN, etc.), the original text, its location in the string, and a classification detail from 0 to 1.
Details about how each entity was anonymized, whether through redaction, masking, pseudonymization, or generalization. This provides a complete audit trail of the anonymization process.
Information about the request itself, including processing time, model version used, and any warnings or suggestions for improving results.
{
"anonymized_text": "[PERSON] lives at [ADDRESS]",
"entities": [
{ "type": "PERSON", "text": "John", "confidence": 0.98 },
{ "type": "ADDRESS", "text": "123 Main St", "confidence": 0.95 }
],
"processing_time_ms": 47
}
One size doesn't fit all when it comes to data privacy. Our API offers extensive customization options to match your specific requirements, compliance needs, and data utility goals. You control exactly how each type of sensitive data is handled.
Choose which entity types to detect and anonymize. Focus only on what matters for your use case, whether that's just PII like names and emails, or a comprehensive set including PHI, financial data, and custom patterns.
Select different techniques for different entity types. Redact names completely, pseudonymize emails to preserve format, generalize dates to month/year, or mask credit cards while keeping the last four digits visible.
Define your own detection rules using regular expressions or provide examples for our AI to learn from. This is perfect for industry-specific identifiers, internal codes, or proprietary data formats.
Start free and scale as you grow. No hidden fees, no surprises. Pay only for what you use.
Perfect for testing and small projects
For growing teams and production apps
For large organizations with custom needs
To get the most out of Anonymization API and ensure smooth operation in production, follow these best practices developed from thousands of successful implementations across industries.
Always implement robust error handling. While our API has 99.99% uptime, network issues can occur. Our SDKs include automatic retries with exponential backoff, but you should also handle edge cases in your application logic.
For large volumes, use our batch endpoint instead of making individual requests. Batch processing is more efficient and reduces the total number of API calls, saving you money and reducing latency.
Consider caching anonymized results for identical inputs to reduce API calls. Our pseudonymization mode generates consistent outputs for the same input within a session, making caching straightforward.
Use our sandbox environment for development and testing. It behaves identically to production but doesn't count against your quota. Always test with realistic data patterns before going live.
Common questions about setting up and using the Anonymization API.
No, you can create an account and start using the API immediately without a credit card. The free tier includes 1,000 API calls per month, which is enough for testing, development, and small projects. You'll only need to add payment information if you want to upgrade to a paid plan or exceed the free tier limits.
When you approach your monthly limit, we'll send email notifications at 80% and 95% usage. If you exceed your limit, API calls will return a 429 (rate limited) response.
Yes, the free tier uses the same infrastructure and models as paid plans. There's no difference in quality or reliability. However, the free tier has lower rate limits and doesn't include SLA guarantees. For production workloads with significant volume or where uptime is critical, we recommend upgrading to a paid plan.
You can create and delete API keys at any time from your dashboard. We recommend creating a new key before deleting the old one to ensure uninterrupted service. Simply update your application with the new key, verify it's working, then delete the old key. There's no limit to how many keys you can have active simultaneously.
Yes, we provide a full sandbox environment that mirrors production exactly. Sandbox requests don't count against your quota and are perfect for development, testing, and CI/CD pipelines. Access the sandbox by using the sandbox API endpoint or by setting the environment parameter in your SDK initialization.
By default, we process data in real-time and don't store any content after the response is returned. We retain only metadata for analytics and debugging purposes (request timestamps, entity counts, processing times).
Join over 1,000 organizations using Anonymization API to secure their data. Start free today.