Skip to main content
Use redact to replace detected sensitive text with placeholders such as [REDACTED_1], [NAME_1] and [EMAIL_ADDRESS_1]. Redaction is opt-in and available to every organization when requested with redact. It applies to both primary transcription and automatic recovery. For ordinary customer calls, start with redact: ["pii", "pci"]. Add "phi" when you also want to remove medical information. You do not need trace: true to use STT redaction.

Choose what to redact

Contextual entity recognition is for English. Digit masking also recognizes digits in other writing systems. Recognition quality depends on what was transcribed: a missed or misrecognized word may also be missed by redaction. Spoken English digit sequences are checked even when numerals is off.

Recorded calls, stereo and speaker diarization

Add redact to your normal asynchronous job. Use channel: true for stereo, or diarize: true for speaker separation on mono recordings. The following example assumes the recording contains English speech.
transcription_language: "en" selects English speech, not English letters. For Hindi in English letters, use transcription_language: "hi" and output_script: "latin". For mixed Hindi–English calls, omit transcription_language and add output_script: "latin". This preserves the spoken words without translating them. See the Hindi, English and mixed-language examples.
The main text, speaker segments, word text, SRT and VTT all use protected text. Speaker labels, channel IDs and original timing are retained. Text from both stereo channels is considered together. Roman-script output is generated after redaction, so its source_text and source_word fields are protected too. Poll the returned job ID or use the signed completion webhook. A completed job’s inline result and result_url contain protected output. Recap and completion integrations receive that same protected transcript. See async jobs and callbacks for retry and signature verification. Redaction adds processing time after recognition. Use asynchronous jobs for long recordings; protecting a long transcript can take minutes. If protection cannot finish within the job’s processing budget, the job retries or fails without publishing an unprotected transcript.

Synchronous file uploads

Send selectors as a comma-separated multipart field:
json, verbose_json and text responses are protected. A JSON-array string is also accepted for multipart jobs and synchronous uploads.

Live transcription

Add selectors to the normal authenticated Hear WebSocket connection:
A protected stream can send one partial with redaction_status: "pending" and the fixed text [REDACTED] when it receives the first speech draft for an utterance. Show this as a temporary “Checking speech” indicator. It carries no recognized words or word times. Replace it with verified text for the same utterance_id and save the corrected final. Some turns go straight to the final. Set interim_results=false for finals only. Requested redaction adds processing time. Keep reading until the stream closes. If verification is temporarily unavailable for one utterance, the stream emits transcript_gap with its utterance_id and code: "redaction_unavailable". Discard any earlier preview for that ID, mark the gap, and keep reading. Subsequent protected finals remain usable. The session ends with redaction_failed and close code 1011. Treat the call transcript as incomplete. Automatic Recap is skipped for a call with a gap. When live word timestamps are available, each final word retains its original start and end time in seconds from the start of the stream. A multiword entity may have the same placeholder on several word intervals. Display text as the readable sentence and use words for timing and speaker ordering. Recent utterances provide context for the next final. Repeated detected values reuse their placeholder within the session where the entity category and value match. Contextual checks can use the general [REDACTED_n] label; do not infer an entity category from every placeholder. Placeholders are not identifiers you should join across separate calls. See streaming STT for audio framing, finalization and error handling.

Failure behavior

Redaction changes returned transcript text. It does not mute or delete the source recording, change recording retention, or remove metadata you supplied such as customer_name or crm_fields. Keep those under your application’s own data handling policy.

Individual selectors

The API also accepts these narrower categories. Selecting name or location includes its subtypes.
expiration is an alias for credit_card_expiration; pin is an alias for password. Unknown values are rejected instead of silently ignored. The older trace: true option remains a separate compliance add-on with its existing entitlement and metering. Combining Trace with redact retains the five legacy identity/payment checks as well as your chosen selectors. Use redact for stereo, diarized, sync and live redaction.