Sensitive information entity types
An entity type is a kind of sensitive information that Arcjet can find in text, such as an email address or a card number. You list entity types in a sensitive information rule or detector to choose what Arcjet allows or denies. This page lists every entity type, grouped by category.
Each entry shows what the type matches, then the following:
- Version is the sensitive information taxonomy version that added the type. As Arcjet supports new types, the version moves forward. For how a detector uses the version, see Sensitive information taxonomy versions.
- Detected in shows where Arcjet detects the type:
- SDK is the SDK-local
sensitiveInforule and the SDK-local detector in an agent guard policy. Both run Rampart in your process. For which types Rampart matches with a validated pattern and which it leaves to its model, see Structured type matching. - Server is the server-side sensitive information detector in an agent guard or coding agent policy. For more information, see Detectors.
- SDK is the SDK-local
In the SDK, each type is an ArcjetSensitiveInfoType in JavaScript, a
SensitiveInfoEntityType in Python, and an arcjet.EntityType in Go. To detect
types that aren’t on this page, use
custom entity detection.
All entity types
Section titled “All entity types”| Entity type | Detected | Version |
|---|---|---|
EMAIL | Local and server | 1 |
PHONE_NUMBER | Local and server | 1 |
IP_ADDRESS | Local and server | 1 |
URL | Local and server | 1 |
CREDIT_CARD_NUMBER | Local and server | 1 |
BANK_ACCOUNT | Local and server | 1 |
ROUTING_NUMBER | Local and server | 1 |
SSN | Local and server | 1 |
TAX_ID | Local and server | 1 |
GOVERNMENT_ID | Local and server | 1 |
PASSPORT | Local and server | 1 |
DRIVERS_LICENSE | Local and server | 1 |
GIVEN_NAME | Local and server | 1 |
SURNAME | Local and server | 1 |
BUILDING_NUMBER | Local and server | 1 |
STREET_NAME | Local and server | 1 |
SECONDARY_ADDRESS | Local and server | 1 |
CITY | Local and server | 1 |
STATE | Local and server | 1 |
ZIP_CODE | Local and server | 1 |
MEDICAL_RECORD_NUMBER | Server | 2 |
HEALTH_PLAN_BENEFICIARY_NUMBER | Server | 2 |
LICENSE_PLATE_NUMBER | Server | 2 |
VEHICLE_IDENTIFICATION_NUMBER | Server | 2 |
DEVICE_IDENTIFIER | Server | 2 |
Local means the SDK detects the type in your process. Server means the server-side detector in a policy detects it. The sections that follow describe each type by category.
Contact
Section titled “Contact”Ways to reach a person directly.
EMAIL: An email address. Version 1. Detected in the SDK and on the server.PHONE_NUMBER: A telephone or fax number. Version 1. Detected in the SDK and on the server.
Network
Section titled “Network”Addresses that identify a host or a resource on a network.
IP_ADDRESS: An IPv4 or IPv6 address. Version 1. Detected in the SDK and on the server.URL: A web address, with or without its scheme. Version 1. Detected in the SDK and on the server.
Financial
Section titled “Financial”Payment and banking details.
CREDIT_CARD_NUMBER: A credit, debit, or prepaid card number. Version 1. Detected in the SDK and on the server.BANK_ACCOUNT: A bank account number, including an IBAN. Version 1. Detected in the SDK and on the server.ROUTING_NUMBER: A bank routing number, such as a US ABA number or a UK sort code. Version 1. Detected in the SDK and on the server.
Government ID
Section titled “Government ID”Identifiers that a government issues to a person or a business.
SSN: A US Social Security number. Version 1. Detected in the SDK and on the server.TAX_ID: A tax ID other than an SSN, such as an employer ID or a VAT number. Version 1. Detected in the SDK and on the server.GOVERNMENT_ID: A national ID or other government-issued ID with no more specific type. Version 1. Detected in the SDK and on the server.PASSPORT: A passport number. Version 1. Detected in the SDK and on the server.DRIVERS_LICENSE: A driver’s license number. Version 1. Detected in the SDK and on the server.
Personal
Section titled “Personal”A person’s name.
GIVEN_NAME: A person’s first or middle name. Version 1. Detected in the SDK and on the server.SURNAME: A person’s family name. Version 1. Detected in the SDK and on the server.
Address
Section titled “Address”The parts of a postal address. Arcjet detects each part separately, so a policy can deny a full address or only some of its parts.
BUILDING_NUMBER: The house or building number in a street address. Version 1. Detected in the SDK and on the server.STREET_NAME: A street name, such as Main Street. Version 1. Detected in the SDK and on the server.SECONDARY_ADDRESS: An apartment, suite, unit, or floor, such as Apt 4B. Version 1. Detected in the SDK and on the server.CITY: A city, town, or village. Version 1. Detected in the SDK and on the server.STATE: A state, province, or region. Version 1. Detected in the SDK and on the server.ZIP_CODE: A postal code. Version 1. Detected in the SDK and on the server.
Health
Section titled “Health”Identifiers that link a record to a patient or a health plan member. These are protected health information (PHI) identifiers. For how to detect them, see Detect protected health information (PHI).
MEDICAL_RECORD_NUMBER: A medical record number assigned by a provider or facility. Version 2. Detected on the server.HEALTH_PLAN_BENEFICIARY_NUMBER: A health plan member, subscriber, or beneficiary number. Version 2. Detected on the server.
Vehicle
Section titled “Vehicle”Identifiers that link a vehicle to its owner. HIPAA treats them as PHI identifiers.
LICENSE_PLATE_NUMBER: A vehicle registration plate number. Version 2. Detected on the server.VEHICLE_IDENTIFICATION_NUMBER: A number that identifies a vehicle, other than its plate, such as a VIN. Version 2. Detected on the server.
Device
Section titled “Device”Identifiers that link a device to its user. HIPAA treats them as PHI identifiers.
DEVICE_IDENTIFIER: A number that identifies a device, such as an IMEI, a MAC address, or a serial number. Version 2. Detected on the server.