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.

Common Entities

To avoid non-sensitive violation counts, Nightfall recommends that common entity detectors be combined with one or more other detectors OR can be used singularly with minimum findings count greater than or equal to 10.

For example, you can add rigor to a US Social Security Number detection rule by including Person Name and configuring the rule to trigger a finding when both data types are found

Name	Description
DATE_OF_BIRTH	Detects a date associated with a person's birth.
EMAIL_ADDRESS	Detects valid e-mail addresses.
PERSON_NAME	Detects a person's name, including first, middle, and last names.
PHONE_NUMBER	Detects a phone number. The number can include an area code and country code.
STREET_ADDRESS	Detects street address, address number, street, city, state, and zip code.

Standard PII - AMERICAS

Name	Description
BRAZIL_CPF_NUMBER	Detects a Brazilian Natural Person Registry number (CPF number), an 11-digit number with format 000.000.000-00.
CANADA_BANK_ACCOUNT	Detects a Canadian bank account number, typically a 15-20 digit number.
CANADA_BC_PHN	Detects 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_NUMBER	Detects Canadian driver's license numbers.
CANADA_GOVERNMENT_ID	Detects 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_OHIP	Detects an Ontario health insurance plan number. This 10-digit personal health number is assigned to individuals for health services in Ontario province.
CANADA_PASSPORT	Detects a Canadian passport number, an 8-character alphanumeric identifier.
CANADA_PERMANENT_RESIDENT_NUMBER	Detects a Canada permanent resident number, a 9-12 alphanumeric token assigned to permanent residents in Canada who are not Canadian citizens.
CANADA_QUEBEC_HIN	Detects 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_NUMBER	Detects a Canadian Social Insurance number (SIN). This number is required for accessing government benefits and for employment verification.
US_DRIVERS_LICENSE_NUMBER	Detects US driver's license number, an alphanumeric string varying in a format unique to the issuing state.
US_INDIVIDUAL_TAXPAYER_IDENTIFICATION_NUMBER	Detects a US individual taxpayer identification number (ITIN)
US_PASSPORT	Detects a US passport number, typically a 6-9 character alphanumeric string.
US_SOCIAL_SECURITY_NUMBER	Detects 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_NUMBER	Detects US vehicle identification number, a 17-character alphanumeric string used to identify a motor vehicle uniquely.

Standard PII - EMEA / AP

Name	Description
AUSTRALIA_DRIVERS_LICENSE_NUMBER	Detects an Australian driver''s license number: A 8-, 9-, or 10-digit number, or a 6-digit alphanumeric pattern depending on the issuing state or territory.
AUSTRALIA_MEDICARE_NUMBER	Detects an Australian Medicare number: A 10- or 11-digit alphanumeric code with a specific format and check algorithm used to uniquely identify individuals eligible for healthcare services under the Australian Medicare system. The 11th digit is the Individual Reference Number (IRN) and it’s optional.
AUSTRALIA_PASSPORT	Detects an Australian passport number, an 8- to 10-character alphanumeric string. Begins with one of these single letters (N,E,D,F,A,C,U,X) or one of these 2 letter combinations (RA,PA,PB,PC,PD,PE,PF,PU,PW,PX,PZ).
AUSTRALIA_TAX_FILE_NUMBER	Detects an Australian tax file number (TFN), a 9-digit numeric string with a specific format and check algorithm issued to identify individuals for AU tax purposes uniquely.
FRANCE_CNI	Detects a French CNI (carte nationale d’identité) number. A CNI is a national identifier frequently used when opening a bank account.
FRANCE_INSEE	Detects 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_PASSPORT	Detects a France passport number, typically a 9-character alphanumeric string.
GERMANY_IDENTITY_NUMBER	Detects a Germany ID number. The German identity card, Personalausweis, is used as a national identifier.
GERMANY_PASSPORT	Detects a German passport number, typically a 9-character alphanumeric string.
INDIA_AADHAAR_INDIVIDUAL	Detects an India Aadhaar card number, 12 digit number issued to all Indian residents that include an individual's biometric and demographic data.
INDIA_PAN_INDIVIDUAL	Detects an Indian Permanent Account Number (PAN), a 10-character alphanumeric token.
IRELAND_PASSPORT	Detects an Ireland passport number, typically a 10-character alphanumeric string.
IRELAND_PPSN	Detects an Ireland Personal Public Service Number (PPSN), an 8-9 alphanumeric code.
SCOTLAND_COMMUNITY_HEALTH_INDEX_NUMBER	Scotland Community Health Index (CHI) number, a 10-digit number used for identification in Scotland's National Health Service (NHS).
UK_DRIVERS_LICENSE_NUMBER	Detects a UK driver's license number..
UK_ELECTORAL_ROLL_NUMBER	Detects a UK electoral roll number.
UK_NATIONAL_HEALTH_SERVICE_NUMBER	Detects a UK National Health Service number, a 10-digit number used for identification in the British National Health Service (NHS).
UK_NATIONAL_INSURANCE_NUMBER	Detects a UK National Insurance Number (NINO), a 9-character alphanumeric string. A NINO may also be used for tax purposes or other identification.
UK_PASSPORT	Detects a UK passport, a 9-digit number.
UK_TAXPAYER_REFERENCE	Detects a unique taxpayer reference (UTR) for individuals and entities paying taxes in the United Kingdom, typically a 10-digit number.

Finance - Banking & PCI

Name	Description
AMERICAN_BANKERS_CUSIP_ID	Detects CUSIP (American Bankers Committee on Uniform Security Identification Procedures) codes, 9-character numeric or alphanumeric codes for identifying North American financial security.
CREDIT_CARD_NUMBER	Detects credit card numbers, 12-19 digit number used for payments and other monetary transactions.
IBAN_CODE	Detects International Bank Account Number (IBAN) codes defined under the ISO 13616:2007 standard used to identify an individual’s account.
SWIFT_CODE	Detects 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_MICR	Detects 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_NUMBER	Detects 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

Name	Description
PROTECTED_HEALTH_INFORMATION	Detects protected health information (PHI). HIPAA defines PHI as data that uniquely identifies an individual plus a diagnostic indicator such as medication, diagnosis, and procedure.
FDA_NATIONAL_DRUG_NAME	Detects brand and non-proprietary FDA drug names.
ICD10_CODE	Detects 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_DESCRIPTION	Detects ICD10 diagnoses or procedures.
US_HEALTH_INSURANCE_CLAIM_NUMBER	Detects 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_NPI	Detects US health insurance claim number (HCIN), used as a Medicare identifier.
US_MEDICARE_BENEFICIARY_IDENTIFIER	Detects a US Medicare Beneficiary Identifier (MBI), an 11-character alphanumeric string given to all Medicare recipients and used in Medicare transactions.

Network

Name	Description
IMEI_HARDWARE_ID	Detects an International Mobile Equipment Identity (IMEI) ID, a unique identification number programmed into GSM and UMTS mobile devices.
IP_ADDRESS	Detects 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_ADDRESS	Detects a MAC address, a 12-digit hexadecimal value used to identify a network adapter. MAC stands for Media Access Control.

Secrets

Name	Description
API_KEY	Detects 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_KEY	Detects private cryptographic keys. A cryptographic key is a data string used to lock or unlock cryptographic functions, including authentication, authorization, and encryption.
DATABASE_CONNECTION_STRING	Detects a database connection string, an expression that contains the parameters required for the applications to connect to a database server. Supports most popular databases.
PASSWORD_IN_CODE	Detects passwords written in code and has been extended to include passwords shared in natural language contexts such as messages, sentences, and paragraphs. This detector targets user access or login access to a system

Image Documents

Name	Description
CREDIT_CARD_IMAGE	Detects an image of a credit, debit, or gift card from any institution.
DRIVERS_LICENSE_IMAGE	Detects an image of a driver's license and government-issued identification card from any nation.
PASSPORT_IMAGE	Detects an image of a passport or visa from any nation.
US_SOCIAL_SECURITY_CARD_IMAGE	Detects an image of a US social security card.