PIIEntityType¶
Enum Class¶
Bases: UnknownEnumMixin, StrEnum
Types of PII entities that can be detected, we will support every types that Guardrails can support
Attributes¶
class-attribute
instance-attribute
¶
ADDRESS = 'ADDRESS'
A physical address, such as '100 Main Street, Anytown, USA' or 'Suite
12, Building 123'¶
class-attribute
instance-attribute
¶
AGE = 'AGE'
An individual's age, including the quantity and unit of time
class-attribute
instance-attribute
¶
AWS_ACCESS_KEY = 'AWS_ACCESS_KEY'
A unique identifier associated with AWS secret access key
class-attribute
instance-attribute
¶
AWS_SECRET_KEY = 'AWS_SECRET_KEY'
A unique identifier associated with AWS access key for signing programmatic requests
class-attribute
instance-attribute
¶
CA_HEALTH_NUMBER = 'CA_HEALTH_NUMBER'
A Canadian Health Service Number - 10-digit unique identifier for healthcare benefits
class-attribute
instance-attribute
¶
CA_SOCIAL_INSURANCE_NUMBER = 'CA_SOCIAL_INSURANCE_NUMBER'
A Canadian Social Insurance Number (SIN) - nine-digit unique identifier
class-attribute
instance-attribute
¶
CREDIT_DEBIT_CARD_CVV = 'CREDIT_DEBIT_CARD_CVV'
A three-digit card verification code (CVV) for VISA, MasterCard, and Discover cards, or four-digit for American Express
class-attribute
instance-attribute
¶
CREDIT_DEBIT_CARD_EXPIRY = 'CREDIT_DEBIT_CARD_EXPIRY'
The expiration date for a credit or debit card
class-attribute
instance-attribute
¶
CREDIT_DEBIT_CARD_NUMBER = 'CREDIT_DEBIT_CARD_NUMBER'
The number for a credit or debit card
class-attribute
instance-attribute
¶
DRIVER_ID = 'DRIVER_ID'
The number assigned to a driver's license
class-attribute
instance-attribute
¶
EMAIL = 'EMAIL'
An email address, such as marymajor@email.com
class-attribute
instance-attribute
¶
INTERNATIONAL_BANK_ACCOUNT_NUMBER = 'INTERNATIONAL_BANK_ACCOUNT_NUMBER'
An International Bank Account Number with specific formats for each country
class-attribute
instance-attribute
¶
IP_ADDRESS = 'IP_ADDRESS'
An IPv4 address, such as 198.51.100.0
class-attribute
instance-attribute
¶
LICENSE_PLATE = 'LICENSE_PLATE'
A license plate for a vehicle issued by the state or country where the vehicle is registered
class-attribute
instance-attribute
¶
MAC_ADDRESS = 'MAC_ADDRESS'
A media access control (MAC) address - unique identifier for network interface controller
class-attribute
instance-attribute
¶
NAME = 'NAME'
An individual's name. Does not include titles such as Dr., Mr., Mrs., or Miss
class-attribute
instance-attribute
¶
PASSWORD = 'PASSWORD'
An alphanumeric string that is used as a password
class-attribute
instance-attribute
¶
PHONE = 'PHONE'
A phone number. Also includes fax and pager numbers
class-attribute
instance-attribute
¶
PIN = 'PIN'
A four-digit personal identification number (PIN)
class-attribute
instance-attribute
¶
SWIFT_CODE = 'SWIFT_CODE'
A SWIFT code - standard format of Bank Identifier Code (BIC)
class-attribute
instance-attribute
¶
UK_NATIONAL_HEALTH_SERVICE_NUMBER = 'UK_NATIONAL_HEALTH_SERVICE_NUMBER'
A UK National Health Service Number - 10-17 digit number
class-attribute
instance-attribute
¶
UK_NATIONAL_INSURANCE_NUMBER = 'UK_NATIONAL_INSURANCE_NUMBER'
A UK National Insurance Number (NINO) for accessing National Insurance benefits
class-attribute
instance-attribute
¶
UK_UNIQUE_TAXPAYER_REFERENCE_NUMBER = 'UK_UNIQUE_TAXPAYER_REFERENCE_NUMBER'
A UK Unique Taxpayer Reference (UTR) - 10-digit number identifying taxpayer or business
class-attribute
instance-attribute
¶
USERNAME = 'USERNAME'
A user name that identifies an account, such as a login name, screen name, nick name, or handle
class-attribute
instance-attribute
¶
US_BANK_ACCOUNT_NUMBER = 'US_BANK_ACCOUNT_NUMBER'
A US bank account number, typically 10 to 12 digits long
class-attribute
instance-attribute
¶
US_BANK_ROUTING_NUMBER = 'US_BANK_ROUTING_NUMBER'
A US bank account routing number, typically nine digits long
class-attribute
instance-attribute
¶
US_INDIVIDUAL_TAX_IDENTIFICATION_NUMBER = 'US_INDIVIDUAL_TAX_IDENTIFICATION_NUMBER'
A US Individual Taxpayer Identification Number (ITIN)
class-attribute
instance-attribute
¶
US_PASSPORT_NUMBER = 'US_PASSPORT_NUMBER'
A US passport number, ranging from six to nine alphanumeric characters
class-attribute
instance-attribute
¶
US_SOCIAL_SECURITY_NUMBER = 'US_SOCIAL_SECURITY_NUMBER'
A US Social Security Number (SSN) - nine-digit number for US citizens and residents
class-attribute
instance-attribute
¶
VEHICLE_IDENTIFICATION_NUMBER = 'VEHICLE_IDENTIFICATION_NUMBER'
A Vehicle Identification Number (VIN) that uniquely identifies a vehicle