Detectors /   DETECTOR
Generate Code Validate Data   Nightfall Console

US Passport

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

Description Detects a US passport number, typically a 6-9 character alphanumeric string.
Detector type AI Model (Entity Detection)
Category Standard PII
Region Americas
Tags pii us passport
Enum (for using this detector via the API)
US_PASSPORT

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": "US Passport",
                              "detectorType": "NIGHTFALL_DETECTOR",
                              "nightfallDetector": "US_PASSPORT"
                         }                    ],
                    "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 Passport",
                                  "detectorType": "NIGHTFALL_DETECTOR",
                                  "nightfallDetector": "US_PASSPORT"
                              }
                          ],
                          "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())
          

US Passport Validator

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