This is a DLP detector that you can easily use or extend upon in the Nightfall platform.
| Description | Detects US social security number (SSN), a 9-digit numeric string often used as a unique identification number for United States citizens and residents. |
|---|---|
| Detector type | AI Model (Entity Detection) |
| Category | Standard PII |
| Region | Americas |
| Tags | pii us ssn |
| Enum (for using this detector via the API) |
US_SOCIAL_SECURITY_NUMBER
|
curl --request POST \
--url https://api.nightfall.ai/v3/scan \
--header 'Accept: application/json' \
--header 'Authorization: Bearer REPLACE-WITH-YOUR-KEY' \
--header 'Content-Type: application/json' \
--data '
{
"policy": {
"detectionRules": [
{
"detectors": [
{
"minNumFindings": 1,
"minConfidence": "LIKELY",
"displayName": "US Social Security Number",
"detectorType": "NIGHTFALL_DETECTOR",
"nightfallDetector": "US_SOCIAL_SECURITY_NUMBER"
} ],
"name": "My Inline Detection Rule",
"logicalOp": "ANY"
}
]
},
"payload": [
"INSERT 1+ PAYLOAD(S)",
"INSERT 1+ PAYLOAD(S)"
]
}
'
import requests
import json
api_key = "REPLACE-WITH-YOUR-KEY"
url = "https://api.nightfall.ai/v3/scan"
headers = {
"Accept": "application/json",
"Authorization": f"Bearer {api_key}",
"Content-Type": "application/json"
}
payload = {
"policy": {
"detectionRules": [
{
"detectors": [
{
"minNumFindings": 1,
"minConfidence": "LIKELY",
"displayName": "US Social Security Number",
"detectorType": "NIGHTFALL_DETECTOR",
"nightfallDetector": "US_SOCIAL_SECURITY_NUMBER"
}
],
"name": "My Inline Detection Rule",
"logicalOp": "ANY"
}
]
},
"payload": [
"INSERT 1+ PAYLOAD(S)",
"INSERT 1+ PAYLOAD(S)"
]
}
response = requests.post(url, headers=headers, data=json.dumps(payload))
print(response.status_code)
print(response.json())
Input any text to validate or test. The default minimum confidence is set to "Possible".