{
"ok": true,
"data": {
"redacted_text": "Contact Alice at [PII_EMAIL_1] or [PII_PHONE_1]. IBAN: [PII_IBAN_1].",
"findings": [
{
"type": "EMAIL",
"start": 17,
"end": 35,
"token": "[PII_EMAIL_1]",
"locale": "GLOBAL",
"validated": false
},
{
"type": "PHONE",
"start": 39,
"end": 54,
"token": "[PII_PHONE_1]",
"locale": "GLOBAL",
"validated": true
},
{
"type": "IBAN",
"start": 62,
"end": 90,
"token": "[PII_IBAN_1]",
"locale": "EU",
"validated": true
}
],
"counts": {
"EMAIL": 1,
"PHONE": 1,
"IBAN": 1
},
"total_redacted": 3,
"tokens": {
"[PII_EMAIL_1]": "[email protected]",
"[PII_PHONE_1]": "+36 30 123 4567",
"[PII_IBAN_1]": "HU42117730161111101800000000"
}
},
"meta": {
"request_id": "5b6ca9ee-827f-4d22-946b-1f37f22d936e",
"ms": 0,
"version": "1.0.0"
}
}
curl --location --request POST 'https://zylalabs.com/api/14914/pii+redactor+api/38822/redact-pii' --header 'Authorization: Bearer YOUR_API_KEY'
--data-raw '{
"text": "Contact Alice at [email protected] or +36 30 123 4567. IBAN: HU42117730161111101800000000.",
"locales": ["GLOBAL", "EU", "HU"],
"mode": "token"
}'
{
"ok": true,
"data": {
"text": "Contact Alice at [email protected].",
"restored_count": 1
},
"meta": {
"request_id": "4a296f30-574f-4eb6-b9e6-b0e7511fb92e",
"ms": 0,
"version": "1.0.0"
}
}
curl --location --request POST 'https://zylalabs.com/api/14914/pii+redactor+api/38823/restore-pii' --header 'Authorization: Bearer YOUR_API_KEY'
--data-raw '{
"redacted_text": "Contact Alice at [PII_EMAIL_1].",
"tokens": {
"[PII_EMAIL_1]": "[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 PII Redactor 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.
Detects and redacts PII (emails, Luhn-validated cards, MOD-97 IBANs, EU VATs, phones, IPs, SSNs, and HU tax/TAJ IDs) with reversible caller-only tokens and zero payload storage.
The `redact-pii` endpoint returns redacted text, findings of detected PII, counts of each PII type, and tokens for reversible redaction. The `restore-pii` endpoint returns the original text with restored PII and a count of restored items.
Key fields in the `redact-pii` response include `redacted_text`, `findings`, `counts`, and `tokens`. In the `restore-pii` response, important fields are `text`, `restored_count`, and `meta` information like `request_id`.
The `redact-pii` endpoint detects and redacts emails, credit cards, IBANs, VAT numbers, phone numbers, IPs, SSNs, and Hungarian Tax/TAJ IDs. The `restore-pii` endpoint restores the original versions of these redacted items.
The response data is structured in JSON format. The `redact-pii` response includes a main `data` object with redacted text and findings, while the `restore-pii` response contains the restored text and metadata about the request.
The PII Redactor API uses algorithms to identify and redact PII based on established patterns and validation rules, such as Luhn for credit cards and MOD-97 for IBANs. The accuracy is maintained through continuous updates to these algorithms.
Typical use cases include data anonymization for compliance with privacy regulations, secure data sharing in development environments, and protecting sensitive information in logs or communications.
Users can customize requests by providing specific text inputs to the `redact-pii` endpoint. The API automatically detects and processes various PII types based on the input text without requiring additional parameters.
If the `redact-pii` endpoint returns no findings, it indicates no PII was detected. Users should check the input text for PII patterns. For the `restore-pii` endpoint, an empty result suggests no tokens were provided for restoration.
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