Doccape Anonymization icon

Doccape Anonymization

Anonymizes text using the DocCape API
Join our community

Overview

This node integrates with the DocCape API to anonymize text by detecting and replacing personally identifiable information (PII). It is useful in scenarios where sensitive data must be protected before sharing, processing, or storing text, such as in compliance with privacy regulations (e.g., GDPR). For example, it can anonymize customer feedback, medical records, or legal documents by masking names, locations, organizations, and other PII categories.

The node sends the input text to the DocCape API, specifying which PII categories to detect and whether to pseudonymize (replace PII with unique consistent identifiers) or fully anonymize (replace PII with generic placeholders).

Properties

Name Meaning
Text The raw text string that you want to anonymize.
Pseudonymization Boolean option to enable pseudonymization (true) which replaces PII with unique consistent identifiers, or disable it (false) for full anonymization using generic placeholders.
PII Classes to Detect Comma-separated list of PII categories to detect and anonymize. Common values include: PER (person), STR (street), LOC (location), ORG (organization).

Output

The node outputs a JSON object containing a single field:

  • pseudonymizedText: A string representing the anonymized version of the input text, where specified PII categories have been replaced according to the pseudonymization setting.

No binary data output is produced by this node.

Dependencies

  • Requires an active connection to the DocCape API service.
  • Requires configuration of an API authentication credential providing:
    • The base URL of the DocCape API.
    • An API key or token for authorization.
  • The node sends POST requests with JSON payloads to the /api/external/v1/text endpoint of the DocCape API.

Troubleshooting

  • Common issues:

    • Invalid or missing API credentials will cause authentication failures.
    • Incorrect API base URL configuration may lead to network errors or 404 responses.
    • Providing empty or malformed text input will result in no meaningful anonymization.
    • Specifying unsupported or misspelled PII categories in the "PII Classes to Detect" property may cause the API to ignore those categories.

  • Error messages:

    • Authentication errors typically indicate invalid or expired API keys; verify and update credentials.
    • HTTP 400 errors may indicate malformed request body; ensure all required properties are correctly set.
    • Network timeouts or connectivity errors suggest checking internet connection or API service status.

Links and References

Discussion