{"flagged_content":"Contact me at **MASKED** or [email protected]","masked_content":"Contact me at *** or [email protected]","notifications":"Inappropriate data submission detected: phone number"}
curl --location --request POST 'https://zylalabs.com/api/5392/privacy+guard+api/6985/detect+and+mask+sensitive+data' --header 'Authorization: Bearer YOUR_API_KEY'
--data-raw '{
"user_content": "Contact me at 123-456-7890 or [email protected]"
}'
After signing up, every developer is assigned a personal API access key, a unique combination of letters and digits provided to access to our API endpoint. To authenticate with the Privacy Guard API simply include your bearer token in the Authorization header.
| Header | Description |
|---|---|
Authorization
|
Required
Should be Bearer access_key. See "Your API Access Key" above when you are subscribed.
|
No long-term commitment. Upgrade, downgrade, or cancel anytime. Free Trial includes up to 50 requests.
(Save 2 months with annual billing 🎉)
Send text with sensitive information; API automatically detects and maks personal data.
It is an API that protects the privacy of online users by automatically masking personal data.
Receives user content with possible personal data; returns text with masked sensitive information.
Customer care masking sensitive data in chats. Health applications that protect patient information. Social networks hiding private data in comments or posts.
Beside the number of API calls per month allowed, there are no other limitations.
There are different plans suits everyone including a free trial for small amount of requests, but it’s rate is limit to prevent abuse of the service.
The API uses API keys for authentication. To access the API, include your API key in the request header. The API key is provided upon registration and should be kept secure.
The API returns detailed information about the age and history of a domain, including years, months and days since its creation, as well as expiration and update dates.
This endpoint returns two key fields: `flagged_content`, which shows the original text with detected sensitive data masked, and `masked_content`, which provides the text with all sensitive information redacted. Additionally, it includes `notifications` for any inappropriate data submissions detected.
The API can detect and mask various types of personal data, including names, addresses, phone numbers, social security numbers, and credit card information, across multiple formats such as text, images, and documents.
The response data is structured in JSON format, containing distinct fields: `flagged_content`, `masked_content`, and `notifications`. This organization allows users to easily identify the original and masked versions of the content.
The primary parameter for this endpoint is `user_content`, which should contain the text or data that may include sensitive information. Users can customize their requests by varying the content submitted for detection.
The API employs advanced recognition algorithms to ensure high accuracy in detecting sensitive data. Continuous updates and improvements to these algorithms help maintain data quality and reliability.
Common use cases include customer support interactions where sensitive data needs to be masked, telemedicine applications protecting patient information, and e-commerce platforms ensuring secure transactions by redacting personal details.
Users can utilize the `masked_content` to display safe text without exposing sensitive information, while `flagged_content` can help identify what was masked. This is useful for auditing and ensuring compliance with privacy regulations.
If the API returns partial or empty results, users should verify the input data for completeness and ensure it contains recognizable sensitive information. Adjusting the content or format may improve detection outcomes.
To obtain your API key, first sign in to your account and navigate to the API you want to use. From the API's Pricing section, choose a plan and complete the subscription process. Once subscribed, return to the API page and you will see your API Access Key displayed at the top of the documentation page. You can use this key to authenticate your requests.
You can’t switch APIs during the free trial. If you subscribe to a different API, your trial will end and the new subscription will start as a paid plan.
The free trial lasts for 7 days and allows you to make up to 50 API requests.
No, the free trial is available only once, so we recommend using it on the API that interests you the most. Most of our APIs offer a free trial, but some may not include this option.
Yes. If the API offers a free trial, you will see a "Free 7-Day Trial" option in its Pricing section. The trial lasts for 7 days and allows up to 50 API requests, enabling you to evaluate the API before subscribing to a paid plan.
Zyla API Hub is like a big store for APIs, where you can find thousands of them all in one place. We also offer dedicated support and real-time monitoring of all APIs. Once you sign up, you can pick and choose which APIs you want to use. Just remember, each API needs its own subscription. But if you subscribe to multiple ones, you'll use the same key for all of them, making things easier for you.
You can monitor your API usage through the response headers included with every request:
x-zyla-api-calls-monthly-used: Shows the total number of API requests you have used during the current billing period.
x-zyla-api-calls-monthly-remaining: Shows the number of API requests you have remaining for the current billing period.
Yes, you can cancel your subscription at any time. Simply go to the Pricing section of the API you're subscribed to and click the "Unsubscribe" button.
Please note that upgrades, downgrades, and cancellations take effect immediately. Once your subscription is canceled, access to the service will end immediately, regardless of any remaining API calls in your quota.
Please have a look at our Refund Policy: https://zylalabs.com/terms#refund