Detection Rules /   DETECTION RULE
Generate Code Validate Data Nightfall Console  

PII - Names and Addresses

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

Description: Detects personally identifiable information (PII) related to names and addresses.
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
Person Name VERY_LIKELY 10 content
Street Address VERY_LIKELY 10 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": 10,
                              "minConfidence": "VERY_LIKELY",
                              "displayName": "Person Name",
                              "detectorType": "NIGHTFALL_DETECTOR",
                              "nightfallDetector": "PERSON_NAME"
                         },                         {
                              "minNumFindings": 10,
                              "minConfidence": "VERY_LIKELY",
                              "displayName": "Street Address",
                              "detectorType": "NIGHTFALL_DETECTOR",
                              "nightfallDetector": "STREET_ADDRESS"
                         }
                    ],
                    "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": 10,
                                  "minConfidence": "VERY_LIKELY",
                                  "displayName": "Person Name",
                                  "detectorType": "NIGHTFALL_DETECTOR",
                                  "nightfallDetector": "PERSON_NAME"
                              },
                              {
                                  "minNumFindings": 10,
                                  "minConfidence": "VERY_LIKELY",
                                  "displayName": "Street Address",
                                  "detectorType": "NIGHTFALL_DETECTOR",
                                  "nightfallDetector": "STREET_ADDRESS"
                              }
                          ],
                          "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 - Names and Addresses Detection Rule Validator

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