PCI, SSN, PII Redaction

VoiceBase allows you to redact and/or detect sensitive data from your recordings, transcripts, and analytics.

Transcript redaction

To redact sensitive information from a media file, include a redactor section in the detector configuration when making a POST request to the /v3/media resource. In this example, any words in the detected region will be replaced with [redacted].

For more on detectionLevel parameter options within the PCI model, please refer to the detect page.

IMPORTANT NOTE: We recommend disabling number formatting on the PCI detector for best results.

{
	"transcript": {
		"formatting": {
			"enableNumberFormatting": false
		}
	},
	"prediction": {
		"detectors": [{
			"detectorName": "PCI",
			"parameters": [{
				"parameter": "detectionLevel",
				"value": "probableNumbers"
			}],
			"redactor": {
				"transcript": {
					"replacement": "[redacted]"
				}
			}
		}]
	}
}

Analytics redaction

Sensitive data is automatically redacted from analytics (such as keywords and topics) when transcript redaction is enabled. No additional configuration is needed.

Audio redaction

To redact sensitive regions from your recording, include an audio section to the detector's redaction configuration when making a POST request to the /v3/media resource. In this example, sensitive audio regions will be replaced with a 170 Hz tone of moderate volume.

IMPORTANT NOTE: We recommend disabling Number Formatting on the PCI detector for best results.

{
	"transcript": {
		"formatting": {
			"enableNumberFormatting": false
		}
	},
	"prediction": {
		"detectors": [{
			"detectorName": "PCI",
			"parameters": [{
				"parameter": "detectionLevel",
				"value": "probableNumbers"
			}],
			"redactor": {
				"transcript": {
					"replacement": "[redacted]"
				},
				"audio": {
					"tone": 170,
					"gain": 0.25
				}
			}
		}]
	}
}

To download the redacted audio, make a GET request to /v3/media/{mediaId}/streams. The response will be of the form:

{
  "streams": [{
    "streamName": "original",
    "streamLocation": "https://link.to.redacted.media"
  }]
}

An expiring link to download the audio file with redacted will appear in place of https://link.to.redacted.media. The link expires after 15 minutes. If the link has expired, perform a new GET request to /v3/media/{mediaId}/streams.

Examples

Transcript Redaction Request

curl https://apis.voicebase.com/v3/media \
  --form [email protected] \
  --form configuration='{
      "transcript": {
        "formatting" : {
          "enableNumberFormatting" : false
        }
      },
      "prediction": {
        "detectors": [ {
            "detectorName": "PCI",
             "redactor": {
                "transcript":{
                    "replacement" : "[redacted]"
                }
             }
        }, {
           "detectorName": "SSN",
            "redactor": {
               "transcript":{
                   "replacement" : "[redacted]"
               }
            }
       }]
      }
  }' \
  --header "Authorization: Bearer ${TOKEN}"

Audio Redaction Request

curl https://apis.voicebase.com/v3/media \
  --form [email protected] \
  --form configuration='{
      "transcript": {
        "formatting" : {
          "enableNumberFormatting" : false
        }
      },
      "prediction": {
        "detectors": [ {
            "detectorName": "PCI",
             "redactor": {
                "transcript": {
                    "replacement" : "[redacted]"
                },
                "audio": {
                    "tone": 170,
                    "gain": 0.25
                }
             }
        }, {
           "detectorName": "SSN",
            "redactor": {
               "transcript": {
                   "replacement" : "[redacted]"
               },
               "audio": {
                    "tone": 170,
                    "gain": 0.25
               }
            }
       }]
      }
  }' \
  --header "Authorization: Bearer ${TOKEN}"

Redacted Audio Request

curl https://apis.voicebase.com/v3/media/${MEDIA_ID}/streams \
  --header "Authorization: Bearer ${TOKEN}"