Detection Rules /   DETECTION RULE
Generate Code Validate Data Nightfall Console  

PII - US ID Numbers

This is a DLP detection rule template that you can implement easily in the Nightfall platform.

Description: Detects personally identifiable information (PII) related to US identification numbers.
Logical operator: ANY i.e. This rule will evaluate to TRUE if any of the Detectors meet their criteria below.

Detectors in this Detection Rule

Detector Minimum Confidence Minimum Number of Findings Scope
US Driver's License Number VERY_LIKELY 1 content
US Individual Taxpayer Identification Number VERY_LIKELY 1 content
US Passport VERY_LIKELY 1 content
US Social Security Number VERY_LIKELY 1 content
US Vehicle Identification Number VERY_LIKELY 1 content

Used in These Policies


Use Detection Rule via API

Read API Reference

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": "VERY_LIKELY",
                              "displayName": "US Driver's License Number",
                              "detectorType": "NIGHTFALL_DETECTOR",
                              "nightfallDetector": "US_DRIVERS_LICENSE_NUMBER"
                         },                         {
                              "minNumFindings": 1,
                              "minConfidence": "VERY_LIKELY",
                              "displayName": "US Individual Taxpayer Identification Number",
                              "detectorType": "NIGHTFALL_DETECTOR",
                              "nightfallDetector": "US_INDIVIDUAL_TAXPAYER_IDENTIFICATION_NUMBER"
                         },                         {
                              "minNumFindings": 1,
                              "minConfidence": "VERY_LIKELY",
                              "displayName": "US Passport",
                              "detectorType": "NIGHTFALL_DETECTOR",
                              "nightfallDetector": "US_PASSPORT"
                         },                         {
                              "minNumFindings": 1,
                              "minConfidence": "VERY_LIKELY",
                              "displayName": "US Social Security Number",
                              "detectorType": "NIGHTFALL_DETECTOR",
                              "nightfallDetector": "US_SOCIAL_SECURITY_NUMBER"
                         },                         {
                              "minNumFindings": 1,
                              "minConfidence": "VERY_LIKELY",
                              "displayName": "US Vehicle Identification Number",
                              "detectorType": "NIGHTFALL_DETECTOR",
                              "nightfallDetector": "US_VEHICLE_IDENTIFICATION_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": "VERY_LIKELY",
                                  "displayName": "US Driver's License Number",
                                  "detectorType": "NIGHTFALL_DETECTOR",
                                  "nightfallDetector": "US_DRIVERS_LICENSE_NUMBER"
                              },
                              {
                                  "minNumFindings": 1,
                                  "minConfidence": "VERY_LIKELY",
                                  "displayName": "US Individual Taxpayer Identification Number",
                                  "detectorType": "NIGHTFALL_DETECTOR",
                                  "nightfallDetector": "US_INDIVIDUAL_TAXPAYER_IDENTIFICATION_NUMBER"
                              },
                              {
                                  "minNumFindings": 1,
                                  "minConfidence": "VERY_LIKELY",
                                  "displayName": "US Passport",
                                  "detectorType": "NIGHTFALL_DETECTOR",
                                  "nightfallDetector": "US_PASSPORT"
                              },
                              {
                                  "minNumFindings": 1,
                                  "minConfidence": "VERY_LIKELY",
                                  "displayName": "US Social Security Number",
                                  "detectorType": "NIGHTFALL_DETECTOR",
                                  "nightfallDetector": "US_SOCIAL_SECURITY_NUMBER"
                              },
                              {
                                  "minNumFindings": 1,
                                  "minConfidence": "VERY_LIKELY",
                                  "displayName": "US Vehicle Identification Number",
                                  "detectorType": "NIGHTFALL_DETECTOR",
                                  "nightfallDetector": "US_VEHICLE_IDENTIFICATION_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())
          

PII - US ID Numbers Detection Rule Validator

Input any text to validate or test. The default minimum confidence is set to "Possible".