Scrub

Redact personal or sensitive information from any given payload

post

/v1/scrub

Authorizations

Query parameters

typestring · default: class

the type of redaction to perform, possible values are: class, class_numbered, empty, masked, encrypted, fake_data

Body

contentstring · default: Hi, my name is John Doe, you can reach me on [e-mail]

Content you would like to scrub personal and sensitive information from

filtersstring[]

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://api.scanner.demo-001.teleskope.ai/v1/scrub' \
  --header 'x-api-key: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "content": "Hi, my name is John Doe, you can reach me on [e-mail]",
    "filters": [
      "text"
    ]
  }'

200

400

200

{
	"content": "Hi, my name is <FIRST_NAME> <LAST_NAME>, you can reach me on <EMAIL>",
	"classifications": [
		{
			"data_element": "FIRST_NAME",
			"start_char": 15,
			"char_size": 4,
		},
		{
			"data_element": "LAST_NAME",
			"start_char": 20,
			"char_size": 3,
		},
		{
			"data_element": "EMAIL",
			"start_char": 45,
			"char_size": 18,
		}
	]
}

200