Scrub

post

Redact personal or sensitive information from any given payload

Authorizations

sec0

x-api-keystringRequired

Query parameters

typestringOptional

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

Default: class

Body

application/json

contentstringOptional

Content you would like to scrub personal and sensitive information from

Default: Hi, my name is John Doe, you can reach me on [email protected]

filtersstring[]Optional

List of data elements to redact from the payload. If set to None, will redact all data elements Teleskope supports

Responses

200

200

application/json

400

400

application/json

post

/v1/scrub

HTTPcURLJavaScriptPython

POST /v1/scrub HTTP/1.1
Host: api.scanner.demo-001.teleskope.ai
x-api-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 96

{
  "content": "Hi, my name is John Doe, you can reach me on [email protected]",
  "filters": [
    "text"
  ]
}

{
	"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,
		}
	]
}