AldeaAldea
ConceptsData protection

PII redaction

Redact personally identifiable information with redact=pii|pci|numbers

PII redaction automatically removes personally identifiable information from transcripts before the results reach your application. Sensitive data is replaced in the transcript text and word-level output.

Usage

Add one or more redact query parameters to a streaming WebSocket URL:

# Redact personal information
wss://api.aldea.ai/v1/listen?redact=pii&encoding=mp3

# Redact payment card data
wss://api.aldea.ai/v1/listen?redact=pci&encoding=mp3

# Combine multiple redaction types
wss://api.aldea.ai/v1/listen?redact=pii&redact=pci&encoding=mp3

# Redact all supported types
wss://api.aldea.ai/v1/listen?redact=true&encoding=mp3

Redaction types

ValueWhat it redacts
piiPerson names, email addresses, phone numbers, physical addresses, Social Security numbers
pciCredit card numbers, bank account numbers
numbersDates, phone numbers, Social Security numbers, credit card numbers
trueAll PII types combined

The redact parameter is repeatable. You can combine multiple types in a single request (e.g., ?redact=pii&redact=pci).

Redaction mode

Control how redacted content appears in the transcript with the redact_mode parameter:

ModeDescriptionExample output
maskReplaces characters with asterisksMy SSN is ***-**-****
redactRemoves the content entirelyMy SSN is
replaceSubstitutes with a type labelMy SSN is [SSN]
wss://api.aldea.ai/v1/listen?redact=pii&redact_mode=replace&encoding=mp3

Next steps