PII Redaction
Static PII Redaction
The Static Redactor offers fast, out-of-the-box redaction by detecting and removing a predefined set of common PII types. This includes typical PII such as emails, phone numbers, social security numbers, and more. It is ideal for scenarios where speed is critical and the types of PII are well-known.
POST
|
/ api / dlp / static / v1 / redact
Send
Header Parameters
X-Api-KeystringrequiredYour unique API key, needed for most API requests. You can find it in the 'Profile' section of the website.
Body Parameters
contentstringrequiredThe text you want to redact.
redact_field_modeenumrequiredChoose how the redacted text will appear. You can customize this setting for a consistent style or to match specific preferences.
REDACTED: Replaces the sensitive data with [REDACTED] to conceal it while maintaining data security.CONTEXT_LABEL: Redacts the data but adds a label to give context about the type of information being hidden.MASK: Replaces the sensitive data with asterisks (*) of the same length.ANONYMIZE: Replaces the sensitive data with a fake data.
Python
Javascript
Dynamic PII Redaction
The Dynamic Redactor allows you to define your own custom rules for what should be considered PII. This is perfect when your data contains specialized or less common types of PII, such as customer IDs, internal codes, or other proprietary information that isn’t covered by standard PII lists.
POST
|
/ api / dlp / dynamic / v1 / redact
Send
Header Parameters
X-Api-KeystringrequiredYour unique API key, needed for most API requests. You can find it in the 'Profile' section of the website.
Body Parameters
contentstringrequiredThe text you want to redact.
labelsarray[string]requiredA list of labels (e.g., ['credit-card','name','ssn','phone']) that you want the Dynamic Redactor to look for and redact from the provided content.
redact_field_modeenumrequiredChoose how the redacted text will appear. You can customize this setting for a consistent style or to match specific preferences.
REDACTED: Replaces the sensitive data with [REDACTED] to conceal it while maintaining data security.MASK: Replaces the sensitive data with asterisks (*) of the same length.
Python
Javascript