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

Name	Description
BRAZIL_CPF_NUMBER	A Brazilian Natural Person Registry Number (CPF number), an 11 digit number with format 000.000.000-00.
CANADA_BANK_ACCOUNT	A Canadian bank account number, typically 15-20 digits long.
CANADA_BC_PHN	British Columbia Personal Health Number. The 10 digit personal health number is assigned to individuals to receive for health services in the province of British Columbia. This token must pass the checksum validation.
CANADA_DRIVERS_LICENSE_NUMBER	A Canadian driver's license number.
CANADA_GOVERNMENT_ID	This number is assigned to all residents that do not have a driver’s license, used for general identification purposes.
CANADA_OHIP	An Ontario Health Insurance Plan Number. This 10 digit personal health number is assigned to individuals to receive for health services in the province Ontario.
CANADA_PASSPORT	A Canadian passport number.
CANADA_PERMANENT_RESIDENT_NUMBER	A 9 to 12 alphanumeric token that is assigned to permanent residents in Canada who are not Canadian citizens.
CANADA_QUEBEC_HIN	A Quebec Health Insurance Number. This 12 alphanumeric token is a personal health number assigned to individuals to receive for health services in the province Quebec.
CANADA_SOCIAL_INSURANCE_NUMBER	The Canadian Social Insurance Number (SIN) is required for accessing government benefits and for employment verification
DATE	A date entity that can be a day of the week or calendar date.
DATE_OF_BIRTH	The month, day, and year of a person's birth.
EMAIL_ADDRESS	A virtual mailbox address where email is sent to or from. An email address is typically composed of a local component followed by a domain name, separated by an "@" character.
FRANCE_CNI	The French CNI (carte nationale d’identité) is a national identifier frequently used when opening a bank account.
FRANCE_INSEE	The France INSEE is an identifier used for obtaining France's social services.
FRANCE_PASSPORT	A France Passport Number for an individual, typically a 9 character alphanumeric string.
GERMANY_IDENTITY_NUMBER	The German identity card, Personalausweis, is used as a national identifier.
GERMANY_PASSPORT	A German Passport Number for an individual, typically a 9 character alphanumeric string.
INDIA_AADHAAR_INDIVIDUAL	A 12 digit number issued to all Indian residents that records an individual's biometric and demographic data.
INDIA_PAN_INDIVIDUAL	An Indian Permanent Account Number, a 10 character alphanumeric token.
IRELAND_PASSPORT	An Ireland Passport Number for an individual, typically a 10 character alphanumeric string.
IRELAND_PPSN	The Ireland PPSN is an 8-9 alphanumeric code that is used for the Ireland Department of Social Protection.
LOCATION	A geopolitical place such as a City, State, or Country.
PERSON_NAME	A person's name, including first, middle, and last names.
PHONE_NUMBER	A numeric sequence typically between 7 and 11 digits long used for connecting between telephones.
SCOTLAND_COMMUNITY_HEALTH_INDEX_NUMBER	A 10-digit number used for identification in Scotland’s National Health Service (NHS) - also referred to as a Community Health Index (CHI) number.
UK_DRIVERS_LICENSE_NUMBER	A British driver’s license number.
UK_ELECTORAL_ROLL_NUMBER	UK electoral roll number.
UK_NATIONAL_HEALTH_SERVICE_NUMBER	A 10-digit number used for identification in the British National Health Service (NHS).
UK_NATIONAL_INSURANCE_NUMBER	A 9-character alphanumeric string used for the administration of National Insurance, often referred to as NINO. They are sometimes used for tax purposes or other identification.
UK_PASSPORT	A 9-digit number used for a British passport.
UK_TAXPAYER_REFERENCE	A Unique Taxpayer Reference (UTR) for individuals and entities paying taxes in the United Kingdom - typically a 10 digit number.
US_DRIVERS_LICENSE_NUMBER	An alphanumeric string identifying US Driver's License; format varies with the issuing state.
US_INDIVIDUAL_TAXPAYER_IDENTIFICATION_NUMBER	Captures a 9 digit tax identification number assigned by the IRS if an individual does not have a Social Security Number.
US_PASSPORT	A United States Passport Number for an individual, typically a 6 to 9 character alphanumeric string.
US_SOCIAL_SECURITY_NUMBER	A 9 digit numeric string often used as a unique identification number for United States citizens and residents.
US_VEHICLE_IDENTIFICATION_NUMBER	A 17 character alphanumeric vehicle identifier managed by the U.S. Department of Transportation.

Finance

Name	Description
AMERICAN_BANKERS_CUSIP_ID	American Bankers' Committee on Uniform Security Identification Procedures (CUSIP), a 9 character numeric or alphanumeric code for identifying North American financial security.
CREDIT_CARD_NUMBER	A 12 to 19 digit number used for payments and other monetary transactions.
IBAN_CODE	An International Bank Account Number defined under the ISO 13616:2007 standard used to identify an individual’s account.
SWIFT_CODE	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	A 9 digit code used to identify a financial institution in monetary transactions, usually referred to as a routing number or transit number.
US_EMPLOYER_IDENTIFICATION_NUMBER	A U.S. Employer Identification Number (EIN) or Federal Tax ID Number is used as a unique identifier for business entities.

Health

Name	Description
FDA_NATIONAL_DRUG_NAME	The official FDA approved drug name.
HIPAA_DEFINED_PII	Detects Personal Identifiable Information (PII)
ICD10_CODE	International Classification of Diseases, Tenth Revision, ICD10 is a series of codes used by medical practitioners to identify diagnoses and procedures. The list is published by the World Health Organization (WHO).
ICD10_DIAGNOSIS_DESCRIPTION	ICD 10 diagnosis description describes a patient's diagnosis.
ICD9_CODE	International Classification of Diseases, Ninth Revision, ICD9 is a series of codes used by medical practitioners to identify diagnoses and procedures. The list is published by the World Health Organization (WHO).
ICD9_DIAGNOSIS_DESCRIPTION	ICD 9 diagnosis description describes a patient's diagnosis.
PROTECTED_HEALTH_INFORMATION	Detects Protected Health Information (PHI)
US_HEALTH_INSURANCE_CLAIM_NUMBER	A health insurance claim number is used as a Medicare identifier.
US_HEALTHCARE_NPI	10 digit identifier for U.S. medicare providers.
US_MEDICARE_BENEFICIARY_IDENTIFIER	US Medicare Beneficiary Identifier.

Network

Name	Description
IMEI_HARDWARE_ID	An identifier for mobile phones, IMEI stands for International Mobile Equipment Identity.
IP_ADDRESS	A numerical label that can be used to identify a device connected to a network. This detector supports both IPv4 and IPv6.
MAC_ADDRESS	A 12 hexadecimal value used for identification for a network adapter; MAC stands for Media Access Control.

Secrets

Name	Description
API_KEY	A freeform string used for user verification to access online program functions.
CRYPTOGRAPHIC_KEY	A string of characters used by an encryption algorithm to generate seemingly random tokens.
DATABASE_CONNECTION_STRING	Captures a JDBC or ODBC connection string.
GCP_CREDENTIALS	Credentials for your Google service account, it is typically in a JSON format.
PASSWORD_IN_CODE	Captures credentials that are written into code. This detector's main use case and accuracy will be on code-based data.