Classify

post

Detect personal or sensitive information within any given payload

Authorizations

sec0

x-api-keystringRequired

Body

application/json

contentstringOptional

Data you would like to classify

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

filtersstring[]Optional

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

Responses

200

200

application/json

400

400

application/json

post

/v1/classify

HTTPcURLJavaScriptPython

POST /v1/classify 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"
  ]
}

{
	"classifications": [
		{
			"data_element": "FIRST_NAME",
      "category": "PERSONAL",
			"star_char": 15,
			"char_size": 4,
		},
		{
			"data_element": "LAST_NAME",
      "category": "PERSONAL",
			"star_char": 20,
			"char_size": 3,
		},
		{
			"data_element": "EMAIL",
      "category": "PERSONAL",
			"star_char": 45,
			"char_size": 18,
		}
	]
}