Detector Glossary

Nightfall's API currently supports the following detectors pre-built by Nightfall covering a variety of PII, PHI, PCI, and secrets/credentials.

For ease of use, you may use the text in the Name column as an identification code within your API calls instead of the UUID of the Detectors in the Nightfall Dashboard.

In addition to the provided list, the API supports both custom REGEX and WORD_LIST detector types. Any of these detectors can be customized with Context Rules or Exclusion Rules specific to your needs.

Standard PII

NameDescription
BRAZIL_CPF_NUMBERDetects a Brazilian Natural Person Registry number (CPF number), an 11-digit number with format 000.000.000-00.
CANADA_BANK_ACCOUNTDetects a Canadian bank account number, typically a 15-20 digit number.
CANADA_BC_PHNDetects British Columbia personal health numbers. The 10-digit personal health number is assigned to individuals to receive health services in the British Columbia province. This token must pass the checksum validation.
CANADA_DRIVERS_LICENSE_NUMBERDetects Canadian driver's license numbers.
CANADA_GOVERNMENT_IDDetects Canada government ID numbers. This number is provided to all residents that do not have a driver’s license, used for general identification purposes.
CANADA_OHIPDetects an Ontario health insurance plan number. This 10-digit personal health number is assigned to individuals for health services in Ontario province.
CANADA_PASSPORTDetects a Canadian passport number, an 8-character alphanumeric identifier.
CANADA_PERMANENT_RESIDENT_NUMBERDetects a Canada permanent resident number, a 9-12 alphanumeric token assigned to permanent residents in Canada who are not Canadian citizens.
CANADA_QUEBEC_HINDetects Quebec health insurance numbers. This 12 alphanumeric token is a personal health number assigned to individuals to receive health services in Quebec province.
CANADA_SOCIAL_INSURANCE_NUMBERDetects a Canadian Social Insurance number (SIN). This number is required for accessing government benefits and for employment verification.
DATEA date entity that can be a day of the week or calendar date.
DATE_OF_BIRTHDetects a date associated with a person's birth.
EMAIL_ADDRESSDetects valid e-mail addresses.
FRANCE_CNIDetects a French CNI (carte nationale d’identité) number. A CNI is a national identifier frequently used when opening a bank account.
FRANCE_INSEEDetects a France INSEE (National Institute of Statistics and Economic Studies) number, also known as the National Identification Number. An INSEE is composed of 13 digits + a two-digit key.
FRANCE_PASSPORTDetects a France passport number, typically a 9-character alphanumeric string.
GERMANY_IDENTITY_NUMBERDetects a Germany ID number. The German identity card, Personalausweis, is used as a national identifier.
GERMANY_PASSPORTDetects a German passport number, typically a 9-character alphanumeric string.
INDIA_AADHAAR_INDIVIDUALDetects an India Aadhaar card number, 12 digit number issued to all Indian residents that include an individual's biometric and demographic data.
INDIA_PAN_INDIVIDUALDetects an Indian Permanent Account Number (PAN), a 10-character alphanumeric token.
IRELAND_PASSPORTDetects an Ireland passport number, typically a 10-character alphanumeric string.
IRELAND_PPSNDetects an Ireland Personal Public Service Number (PPSN), an 8-9 alphanumeric code.
LOCATIONDetects a geopolitical place such as a City, State, or Country.
PERSON_NAMEDetects a person's name, including first, middle, and last names.
PHONE_NUMBERDetects a phone number. The number can include an area code and country code.
SCOTLAND_COMMUNITY_HEALTH_INDEX_NUMBERScotland Community Health Index (CHI) number, a 10-digit number used for identification in Scotland's National Health Service (NHS).
STREET_ADDRESSDetects street address, address number, street, city, state, and zip code.
UK_DRIVERS_LICENSE_NUMBERDetects a UK driver's license number..
UK_ELECTORAL_ROLL_NUMBERDetects a UK electoral roll number.
UK_NATIONAL_HEALTH_SERVICE_NUMBERDetects a UK National Health Service number, a 10-digit number used for identification in the British National Health Service (NHS).
UK_NATIONAL_INSURANCE_NUMBERDetects a UK National Insurance Number (NINO), a 9-character alphanumeric string. A NINO may also be used for tax purposes or other identification.
UK_PASSPORTDetects a UK passport, a 9-digit number.
UK_TAXPAYER_REFERENCEDetects a unique taxpayer reference (UTR) for individuals and entities paying taxes in the United Kingdom, typically a 10-digit number.
US_DRIVERS_LICENSE_NUMBERDetects US driver's license number, an alphanumeric string varying in a format unique to the issuing state.
US_INDIVIDUAL_TAXPAYER_IDENTIFICATION_NUMBERDetects a US individual taxpayer identification number (ITIN)
US_PASSPORTDetects a US passport number, typically a 6-9 character alphanumeric string.
US_SOCIAL_SECURITY_NUMBERDetects US social security number (SSN), a 9-digit numeric string often used as a unique identification number for United States citizens and residents.
US_VEHICLE_IDENTIFICATION_NUMBERDetects US vehicle identification number, a 17-character alphanumeric string used to identify a motor vehicle uniquely.

Finance

NameDescription
AMERICAN_BANKERS_CUSIP_IDDetects CUSIP (American Bankers Committee on Uniform Security Identification Procedures) codes, 9-character numeric or alphanumeric codes for identifying North American financial security.
CREDIT_CARD_NUMBERDetects credit card numbers, 12-19 digit number used for payments and other monetary transactions.
IBAN_CODEDetects International Bank Account Number (IBAN) codes defined under the ISO 13616:2007 standard used to identify an individual’s account.
SWIFT_CODEDetects SWIFT (Society for Worldwide Interbank Financial Telecommunication) codes. A SWIFT code is an 8 or 11 alphanumeric identification code for banks used for financial transactions and other communications between banks. It is synonymous with a Bank Identifier Code (BIC).
US_BANK_ROUTING_MICRDetects bank routing numbers, a 9-digit code used to identify a financial institution in monetary transactions. MICR stands for magnetic ink character recognition.
US_EMPLOYER_IDENTIFICATION_NUMBERDetects a US employer identification number (EIN), also known as a Federal Tax ID number. An EIN is a unique identifier for US business entities.

Health

NameDescription
FDA_NATIONAL_DRUG_NAMEDetects brand and non-proprietary FDA drug names.
HIPAA_DEFINED_PIIDetects HIPAA personally identifiable information (PII). HIPAA PII is any health information that allows the patient to be identified.
ICD10_CODEDetects ICD10 codes (International Classification of Diseases, Tenth Revision). ICD10 is a series of codes used by medical practitioners to identify diagnoses and procedures.
ICD10_DIAGNOSIS_DESCRIPTIONDetects ICD10 diagnoses or procedures.
ICD9_CODEDetects ICD9 codes (International Classification of Diseases, Ninth Revision). ICD9 is a series of codes used by medical practitioners to identify diagnoses and procedures.
ICD9_DIAGNOSIS_DESCRIPTIONDetects ICD9 diagnoses or procedures.
PROTECTED_HEALTH_INFORMATIONDetects protected health information (PHI). HIPAA defines PHI as data that uniquely identifies an individual plus a diagnostic indicator such as medication, diagnosis, and procedure.
US_HEALTH_INSURANCE_CLAIM_NUMBERDetects a US healthcare national provider identifiers (NPI), a 10-digit identifier for US Medicare providers; individuals (physicians, dentists, pharmacists, etc.) and organizations (hospitals, clinics, pharmacies, etc.).
US_HEALTHCARE_NPIDetects US health insurance claim number (HCIN), used as a Medicare identifier.
US_MEDICARE_BENEFICIARY_IDENTIFIERDetects a US Medicare Beneficiary Identifier (MBI), an 11-character alphanumeric string given to all Medicare recipients and used in Medicare transactions.

Network

NameDescription
IMEI_HARDWARE_IDDetects an International Mobile Equipment Identity (IMEI) ID, a unique identification number programmed into GSM and UMTS mobile devices.
IP_ADDRESSDetects an internet protocol (IP) network address. An IP address is a numerical label used to identify a device connected to a network. This detector supports both IPv4 and IPv6 addresses.
MAC_ADDRESSDetects a MAC address, a 12-digit hexadecimal value used to identify a network adapter. MAC stands for Media Access Control.

Secrets

NameDescription
API_KEYDetects API keys, credentials needed to authenticate and authorize a cloud provider’s API request. Findings will include the vendor name and active key validation for the most popular services. See Detecting Secrets
CRYPTOGRAPHIC_KEYDetects private cryptographic keys. A cryptographic key is a data string used to lock or unlock cryptographic functions, including authentication, authorization, and encryption
DATABASE_CONNECTION_STRINGDetects a database connection string, an expression that contains the parameters required for the applications to connect to a database server. Supports most popular databases.
GCP_CREDENTIALSDetects Google Cloud Platform credentials.
PASSWORD_IN_CODEDetects passwords written in code. This detector is tuned specifically for detection in code files.