# PII Scan

## POST /api/v1/pii\_scan/{database\_id}/start/

> Scan for PII

```json
{"openapi":"3.0.3","info":{"title":"Syntho Backend API","version":"1.0.0 (v1)"},"servers":[{"url":"/"}],"security":[{"authentication":[]},{"OIDC":[]}],"components":{"securitySchemes":{"authentication":{"type":"apiKey","in":"cookie","name":"sessionid","description":"Log in using the <a href='/api/playground/#/Auth/auth_create'>POST /api/v1/auth/</a> endpoint"},"OIDC":{"type":"apiKey","in":"header","name":"Authorization"}},"schemas":{"ScanPIIParams":{"properties":{"allow_list":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"default":null,"title":"Allow List"},"deny_list":{"anyOf":[{"$ref":"#/components/schemas/DenyDict"},{"type":"null"}],"default":null},"deselected_entities":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"default":null,"title":"Deselected Entities"}},"title":"ScanPIIParams","type":"object"},"DenyDict":{"properties":{"language":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"title":"Language"},"ad_hoc_recognizers":{"anyOf":[{"items":{"$ref":"#/components/schemas/AdHocRecognizer"},"type":"array"},{"type":"null"}],"default":null,"title":"Ad Hoc Recognizers"}},"title":"DenyDict","type":"object"},"AdHocRecognizer":{"properties":{"name":{"title":"Name","type":"string"},"deny_list":{"items":{"type":"string"},"title":"Deny List","type":"array"}},"required":["name","deny_list"],"title":"AdHocRecognizer","type":"object"},"JobMessageSchema":{"properties":{"id":{"anyOf":[{"format":"uuid","type":"string"},{"type":"null"}],"default":null,"title":"Id"},"status":{"anyOf":[{"$ref":"#/components/schemas/JobStatus"},{"type":"null"}],"default":null},"reason":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"title":"Reason"}},"title":"JobMessageSchema","type":"object"},"JobStatus":{"enum":["STARTED","IN_PROGRESS","SUCCESS","FAILURE","REVOKED"],"title":"JobStatus","type":"string"}}},"paths":{"/api/v1/pii_scan/{database_id}/start/":{"post":{"operationId":"pii_scan_start_create","description":"Scan for PII","parameters":[{"in":"query","name":"cardinality_check","schema":{"type":"boolean"}},{"in":"query","name":"data_scan","schema":{"type":"boolean"},"required":true},{"in":"path","name":"database_id","schema":{"type":"string"},"required":true},{"in":"query","name":"locale","schema":{"type":"string"},"required":true},{"in":"query","name":"overwrite_previous_scans","schema":{"type":"boolean"}}],"tags":["PII Scan","Jobs"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScanPIIParams"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/JobMessageSchema"}}},"description":"Success: found foreign keys"},"503":{"description":"Message: unable to fetch engine from external service"}}}}}}
```

## GET /api/v1/pii\_scan/{engine\_id}/recognizers/

> List of Allow/Deny options for PII Scan

```json
{"openapi":"3.0.3","info":{"title":"Syntho Backend API","version":"1.0.0 (v1)"},"servers":[{"url":"/"}],"security":[{"authentication":[]},{"OIDC":[]}],"components":{"securitySchemes":{"authentication":{"type":"apiKey","in":"cookie","name":"sessionid","description":"Log in using the <a href='/api/playground/#/Auth/auth_create'>POST /api/v1/auth/</a> endpoint"},"OIDC":{"type":"apiKey","in":"header","name":"Authorization"}},"schemas":{"PIIRecognizerList":{"properties":{"recognizers":{"items":{"$ref":"#/components/schemas/PIIRecognizer"},"title":"Recognizers","type":"array"}},"required":["recognizers"],"title":"PIIRecognizerList","type":"object"},"PIIRecognizer":{"properties":{"name":{"title":"Name","type":"string"},"value":{"title":"Value","type":"boolean"}},"required":["name","value"],"title":"PIIRecognizer","type":"object"}}},"paths":{"/api/v1/pii_scan/{engine_id}/recognizers/":{"get":{"operationId":"pii_scan_recognizers_retrieve","description":"List of Allow/Deny options for PII Scan","parameters":[{"in":"query","name":"deepScan","schema":{"type":"boolean"}},{"in":"path","name":"engine_id","schema":{"type":"string"},"required":true},{"in":"query","name":"locale","schema":{"type":"string"}},{"in":"query","name":"textPii","schema":{"type":"boolean"}}],"tags":["PII Scan"],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PIIRecognizerList"}}},"description":"Success: List of PII Scan options"},"503":{"description":"Message: unable to fetch engine from external service"}}}}}}
```