Detectors /   DETECTOR
Generate Code Validate Data   Nightfall Console

Phone Number

This is a DLP detector that you can easily use or extend upon in the Nightfall platform.

Description Detects a US or UK phone number. The number can include an area code and country code. As a very commonly used infotype, we recommend that you only use it combination with another detector OR with a minimum findings count greater than or equal to 10.
Detector type AI Model (Entity Detection)
Category Common Entity
Region Americas, EMEA
Tags pii phone number
Enum (for using this detector via the API)
PHONE_NUMBER

Used in These Detection Rules

Used in These Policies


Use Detector 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": "LIKELY",
                              "displayName": "Phone Number",
                              "detectorType": "NIGHTFALL_DETECTOR",
                              "nightfallDetector": "PHONE_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": "Phone Number",
                                  "detectorType": "NIGHTFALL_DETECTOR",
                                  "nightfallDetector": "PHONE_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())
          

Phone Number Validator

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