The Personally Identifiable Information (PII) and Protected Health Information (PHI) detection APIs are cloud-based solutions that use artificial intelligence (AI) and machine learning to help you create smart applications with advanced natural language processing. The PII and PHI APIs effectively detect and removes sensitive information from input data by categorizing personal details into specific, predefined entity types. This comprehensive approach not only safeguards sensitive data to ensure full compliance with privacy regulations, but also enables applications to process and utilize information with enhanced security, reliability, and efficiency.
Tip
Try PII detection in text or conversations using the Microsoft Foundry language playground.
Language Support
The PII language support page lists all languages available for the PII entities in this article. Any exceptions are noted for specific named entities.
Supported API versions:
The following entities are currently in preview:
The following entities are currently in preview:
Note
Beginning with the GA API (released 2024-11-01), the Subtype field is no longer supported. All entity classifications now use the type field.
Supported PII entity list
To examine a comprehensive list of all the types of Personally Identifiable Information (PII) entities that are currently supported, see the Supported PII entity list
Personally identifiable information (PII) refers to any single piece of data or combination of data that enables the unique identification, tracking, or differentiation of an individual.
The Azure Language in Foundry Tools PII extraction API uses Natural Language Processing (NLP) technology to detect, recognize, and extract PII entities from written text or spoken conversations. The following entities represent specific types of information that can reveal an individual's identity:
Type: Geolocation
Data that details an individual's physical location that can be used to pinpoint or monitor where a person is or has been. This data is considered PII when it is linked to a specific person.
Type: Airport (preview)
| Details |
Tag |
| To retrieve this entity type, specify Airport in the piiCategories request parameter. If detected, the entity appears in the PII response payloads. |
[Airport] |
Type: City (preview)
| Details |
Tag |
| To retrieve this entity type, specify City in the piiCategories request parameter. If detected, the entity appears in the PII response payloads. |
[City] |
Type: Geopolitical Entity GPE (preview)
| Details |
Tag |
| To retrieve this entity type, specify GPE in the piiCategories request parameter. If detected, the entity appears in the PII response payloads. |
[GPE] |
Type: Location (preview)
| Details |
Tag |
| To retrieve this entity type, specify Location in the piiCategories request parameter. If detected, the entity appears in the PII response payloads. |
[Location] |
Type: State (preview)
| Details |
Tag |
| To retrieve this entity type, specify State in the piiCategories request parameter. If detected, the entity appears in the PII response payloads. |
[State] |
Personal
Any data, collected or stored, that can be used to identify or contact a specific individual is considered personal information. This data may include information that identifies someone directly, such as their name or social security number. It can also refer to data that, when linked with other information, could lead to identification—for example, an address or dates of birth.).
Type: Address
| Details |
Tag |
| To retrieve this entity type, specify Address in the piiCategories request parameter. If detected, the entity appears in the PII and PHI response payloads. |
[Address] |
Type: Age
| Details |
Tag |
| To retrieve this entity type, specify Age in the piiCategories request parameter. If detected, the entity appears in the PII response payload. |
[Age] |
Type: Date Of Birth (preview)
| Details |
Tag |
| To retrieve this entity type, specify DateOfBirth in the piiCategories request parameter. If detected, the entity appears in the PII response payload. |
[DateOfBirth] |
Type: Drivers License Number (preview)
| Details |
Tag |
| To retrieve this entity type, specify DriversLicenseNumber in the piiCategories request parameter. If detected, the entity appears in the PII response payload. |
[DriversLicenseNumber] |
Type: Email
| Details |
Tag |
| To retrieve this entity type, specify Email in the piiCategories request parameter. If detected, the entity appears in the PII and PHI response payloads. |
[Email] |
Type: IP Address
| Details |
Tag |
| To retrieve this entity type, specify IPAddress in the piiCategories request parameter. If detected, the entity appears in the PII and PHI response payloads. |
[IPAddress] |
Type: License Plate (preview)
| Details |
Tag |
| To retrieve this entity type, specify LicensePlate in the piiCategories request parameter. If detected, the entity appears in the PII response payload. |
[LicensePlate] |
Type: Passport Number (preview)
| Details |
Tag |
| To retrieve this entity type, specify PassportNumber in the piiCategories request parameter. If detected, the entity appears in the PII response payload. |
[PassportNumber] |
Type: Password (preview)
| Details |
Tag |
| To retrieve this entity type, specify Password in the piiCategories request parameter. If detected, the entity appears in the PII response payload. |
[Password] |
Type: Person
| Details |
Tag |
| To retrieve this entity type, specify Person in the piiCategories request parameter. If detected, the entity appears in the PII response payloads. |
[Person] |
Type: Phone Number
| Details |
Tag |
| To retrieve this entity type, specify PhoneNumber in the piiCategories request parameter. If detected, the entity appears in the PII and PHI response payloads. |
[PhoneNumber] |
Type: URL
| Details |
Tag |
| To retrieve this entity type, specify URL in the piiCategories request parameter. If detected, the entity appears in the PII and PHI response payloads. |
[URL] |
Type: VIN (preview)
| Details |
Tag |
| To retrieve this entity type, specify VIN (vehicle registration number) in the piiCategories request parameter. If detected, the entity appears in the PII response payload. |
[VIN] |
Financial
Any financial information is connected to a particular individual that can, through identifying details, be traced back to that person.
Type: American Bankers Association Routing Number
| Details |
Tag |
| To retrieve this entity type, specify ABARoutingNumber in the piiCategories request parameter. If detected, the entity appears in the PII response payload. |
[ABARoutingNumber] |
Type: Bank Account Number (preview)
| Details |
Tag |
| To retrieve this entity type, specify BankAccountNumber in the piiCategories request parameter. If detected, the entity appears in the PII response payload. |
[BankAccountNumber] |
Type: Credit Card Number
| Details |
Tag |
| To retrieve this entity type, specify CreditCardNumber in the piiCategories request parameter. If detected, the entity appears in the PII response payload. |
[CreditCardNumber] |
Type: International Banking Account Number
| Details |
Tag |
| To retrieve this entity type, specify InternationalBankingAccountNumber in the piiCategories request parameter. If detected, the entity appears in the PII response payload. |
[InternationalBankingAccountNumber] |
Type: Sort Code (preview)
| Details |
Tag |
| To retrieve this entity type, specify SortCode in the piiCategories request parameter. If detected, the entity appears in the PII response payload. |
[SortCode] |
Type: SWIFT Code
| Details |
Tag |
| To retrieve this entity type, specify SWIFTCode in the piiCategories request parameter. If detected, the entity appears in the PII response payload. |
[SWIFTCode] |
Organization
Any data that an organization collects, stores, or processes that can be used to identify a specific individual, either directly or indirectly.
Type: Organization
| Details |
Tag |
| To retrieve this entity type, specify Organization in the piiCategories request parameter. If detected, the entity appears in the PII and PHI response payloads. |
[Organization] |
DateTime
Data that can be used to identify, distinguish, or trace an individual. While a date or time on its own is often not considered PII, it can become highly sensitive when combined with other data points.
Type: Date
| Details |
Tag |
| To retrieve this entity type, specify Date in the piiCategories request parameter. If detected, the entity appears in the PII and PHI response payloads. |
[Date] |
Type: Expiration Date (preview)
| Details |
Tag |
| To retrieve this entity type, specify ExpirationDate in the piiCategories request parameter. If detected, the entity appears in the PII response payloads. |
[ExpirationDate] |
Any identifiable Azure information like authentication information and connection strings that can be used to distinguish or trace an individual's identity.
Type: Azure Document DB Auth Key
| Details |
Tag |
| To retrieve this entity type, specify AzureDocumentDBAuthKey in the piiCategories request parameter. If detected, the entity appears in the PII response payload. |
[AzureDocumentDBAuthKey] |
Type: Azure IAAS Database Connection And SQL String
| Details |
Tag |
| To retrieve this entity type, specify AzureIAASDatabaseConnectionAndSQLString in the piiCategories request parameter. If detected, the entity appears in the PII response payload. |
[AzureIAASDatabaseConnectionAndSQLString] |
Type: Azure IoT Connection String
| Details |
Tag |
| To retrieve this entity type, specify AzureIoTConnectionString in the piiCategories request parameter. If detected, the entity appears in the PII response payload. |
[AzureIoTConnectionString] |
Type: Azure Publish Setting Password
| Details |
Tag |
| To retrieve this entity type, specify AzurePublishSettingPassword in the piiCategories request parameter. If detected, the entity appears in the PII response payload. |
[AzurePublishSettingPassword] |
Type: Azure Redis Cache String
| Details |
Tag |
| To retrieve this entity type, specify AzureRedisCacheString in the piiCategories request parameter. If detected, the entity appears in the PII response payload. |
[AzureRedisCacheString] |
Type: Azure SAS
| Details |
Tag |
| To retrieve this entity type, specify AzureSAS in the piiCategories request parameter. If detected, the entity appears in the PII response payload. |
[AzureSAS] |
Type: Azure Service Bus String
| Details |
Tag |
| To retrieve this entity type, specify AzureServiceBusString in the piiCategories request parameter. If detected, the entity appears in the PII response payload. |
[AzureServiceBusString] |
Type: Azure Storage Account Generic
| Details |
Tag |
| To retrieve this entity type, specify AzureStorageAccountGeneric in the piiCategories request parameter. If detected, the entity appears in the PII response payload. |
[AzureStorageAccountGeneric] |
Type: Azure Storage Account Key
| Details |
Tag |
| To retrieve this entity type, specify AzureStorageAccountKey in the piiCategories request parameter. If detected, the entity appears in the PII response payload. |
[AzureStorageAccountKey] |
Type: SQL Server Connection String
| Details |
Tag |
| To retrieve this entity type, specify SQLServerConnectionString in the piiCategories request parameter. If detected, the entity appears in the PII response payload. |
[AzureStorageAccountKey] |
Government
Any government-issued identification that can be used along or combined with other data to trace and reveal a specific person's identity.
Type: Argentina National Identity Number
| Details |
Tag |
| To retrieve this entity type, specify ARNationalIdentityNumber in the piiCategories request parameter. If detected, the entity appears in the PII response payload. |
[ARNationalIdentityNumber] |
Type: Australia Bank Account Number
| Details |
Tag |
| To retrieve this entity type, specify AUBankAccountNumber in the piiCategories request parameter. If detected, the entity appears in the PII response payload. |
[AUBankAccountNumber] |
Type: Australia Business Number
| Details |
Tag |
| To retrieve this entity type, specify AUBusinessNumber in the piiCategories request parameter. If detected, the entity appears in the PII response payload. |
[AUBusinessNumber] |
Type: Australia Company Number
| Details |
Tag |
| To retrieve this entity type, specify AUCompanyNumber in the piiCategories request parameter. If detected, the entity appears in the PII response payload. |
[AUCompanyNumber] |
Type: Australia Drivers License Number
| Details |
Tag |
| To retrieve this entity type, specify AUDriversLicenseNumber in the piiCategories request parameter. If detected, the entity appears in the PII response payload. |
[AUDriversLicenseNumber] |
Type: Australia Medical Account Number
| Details |
Tag |
| To retrieve this entity type, specify AUMedicalAccountNumber in the piiCategories request parameter. If detected, the entity appears in the PII response payload. |
[AUMedicalAccountNumber] |
Type: Australia Passport Number
| Details |
Tag |
| To retrieve this entity type, specify AUPassportNumber in the piiCategories request parameter. If detected, the entity appears in the PII response payload. |
[AUPassportNumber] |
Type: Australia Tax File Number
| Details |
Tag |
| To retrieve this entity type, specify AUTaxFileNumber in the piiCategories request parameter. If detected, the entity appears in the PII response payload. |
[AUTaxFileNumber] |
Type: Austria Identity Card
| Details |
Tag |
| To retrieve this entity type, specify ATIdentityCard in the piiCategories request parameter. If detected, the entity appears in the PII response payload. |
[ATIdentityCard] |
Type: Austria Tax Identification Number
| Details |
Tag |
| To retrieve this entity type, specify ATTaxIdentificationNumber in the piiCategories request parameter. If detected, the entity appears in the PII response payload. |
[ATTaxIdentificationNumber] |
Type: Austria Value Added Tax Number
| Details |
Tag |
| To retrieve this entity type, specify ATValueAddedTaxNumber in the piiCategories request parameter. If detected, the entity appears in the PII response payload. |
[ATValueAddedTaxNumber] |
Type: Belgium National Number
| Details |
Tag |
| To retrieve this entity type, specify BENationalNumber in the piiCategories request parameter. If detected, the entity appears in the PII response payload. |
[BENationalNumber] |
Type: Belgium Value Added Tax Number
| Details |
Tag |
| To retrieve this entity type, specify BEValueAddedTaxNumber in the piiCategories request parameter. If detected, the entity appears in the PII response payload. |
[BEValueAddedTaxNumber] |
Type: Brazil CPF Number
| Details |
Tag |
| To retrieve this entity type, specify BRCPFNumber in the piiCategories request parameter. If detected, the entity appears in the PII response payload. |
[BRCPFNumber] |
Type: Brazil Legal Entity Number
| Details |
Tag |
| To retrieve this entity type, specify BRLegalEntityNumber in the piiCategories request parameter. If detected, the entity appears in the PII response payload. |
[BRLegalEntityNumber] |
Type: Brazil National IDRG
| Details |
Tag |
| To retrieve this entity type, specify BRNationalIDRG in the piiCategories request parameter. If detected, the entity appears in the PII response payload. |
[BRNationalIDRG] |
| Details |
Tag |
| To retrieve this entity type, specify BGUniformCivilNumber in the piiCategories request parameter. If detected, the entity appears in the PII response payload. |
[BGUniformCivilNumber] |
Type: Canada Bank Account Number
| Details |
Tag |
| To retrieve this entity type, specify CABankAccountNumber in the piiCategories request parameter. If detected, the entity appears in the PII response payload. |
[CABankAccountNumber] |
Type: Canada Drivers License Number
| Details |
Tag |
| To retrieve this entity type, specify CADriversLicenseNumber in the piiCategories request parameter. If detected, the entity appears in the PII response payload. |
[CADriversLicenseNumber] |
Type: Canada Health Service Number
| Details |
Tag |
| To retrieve this entity type, specify CAHealthServiceNumber in the piiCategories request parameter. If detected, the entity appears in the PII response payload. |
[CAHealthServiceNumber] |
Type: Canada Passport Number
| Details |
Tag |
| To retrieve this entity type, specify CAPassportNumber in the piiCategories request parameter. If detected, the entity appears in the PII response payload. |
[CAPassportNumber] |
Type: Canada Personal Health Identification
| Details |
Tag |
| To retrieve this entity type, specify CAPersonalHealthIdentification in the piiCategories request parameter. If detected, the entity appears in the PII and PHI response payload. |
[CAPersonalHealthIdentification] |
Type: Canada Social Identification Number (preview)
| Details |
Tag |
| To retrieve this entity type, specify CASocialIdentificationNumber in the piiCategories request parameter. If detected, the entity appears in the PII response payload. |
[CASocialIdentificationNumber] |
Type: Canada Social Insurance Number
| Details |
Tag |
| To retrieve this entity type, specify CASocialInsuranceNumber in the piiCategories request parameter. If detected, the entity appears in the PII response payload. |
[CASocialInsuranceNumber] |
Type: Card Verification Value CVV (preview)
| Details |
Tag |
| To retrieve this entity type, specify CVV in the piiCategories request parameter. If detected, the entity appears in the PII response payload. |
[CVV] |
Type: Chile Identity Card Number
| Details |
Tag |
| To retrieve this entity type, specify CLIdentityCardNumber in the piiCategories request parameter. If detected, the entity appears in the PII response payload. |
[CLIdentityCardNumber] |
Type: China Resident Identity Card Number
| Details |
Tag |
| To retrieve this entity type, specify CNResidentIdentityCardNumber in the piiCategories request parameter. If detected, the entity appears in the PII response payload. |
[CNResidentIdentityCardNumber] |
Type: Croatia Identity Card Number
| Details |
Tag |
| To retrieve this entity type, specify HRIdentityCardNumber in the piiCategories request parameter. If detected, the entity appears in the PII response payload. |
[HRIdentityCardNumber] |
Type: Croatia National ID Number
| Details |
Tag |
| To retrieve this entity type, specify HRNationalIDNumber in the piiCategories request parameter. If detected, the entity appears in the PII response payload. |
[HRNationalIDNumber] |
Type: Croatia Personal Identification Number
| Details |
Tag |
| To retrieve this entity type, specify HRPersonalIdentificationNumber in the piiCategories request parameter. If detected, the entity appears in the PII response payload. |
[HRPersonalIdentificationNumber] |
Type: Cyprus Identity Card
| Details |
Tag |
| To retrieve this entity type, specify CYIdentityCard in the piiCategories request parameter. If detected, the entity appears in the PII response payload. |
[CYIdentityCard] |
Type: Cyprus Tax Identification Number
| Details |
Tag |
| To retrieve this entity type, specify CYTaxIdentificationNumber in the piiCategories request parameter. If detected, the entity appears in the PII response payload. |
[CYTaxIdentificationNumber] |
Type: Czech Republic Personal Identity Number
| Details |
Tag |
| To retrieve this entity type, specify CZPersonalIdentityNumber in the piiCategories request parameter. If detected, the entity appears in the PII response payload. |
[CZPersonalIdentityNumber] |
Type: Denmark Personal Identification Number
| Details |
Tag |
| To retrieve this entity type, specify DKPersonalIdentificationNumber in the piiCategories request parameter. If detected, the entity appears in the PII response payload. |
[DKPersonalIdentificationNumber] |
Type: Estonia Personal Identification Code
| Details |
Tag |
| To retrieve this entity type, specify EEPersonalIdentificationCode in the piiCategories request parameter. If detected, the entity appears in the PII response payload. |
[EEPersonalIdentificationCode] |
Type: European Union Debit Card Number
| Details |
Tag |
| To retrieve this entity type, specify EUDebitCardNumber in the piiCategories request parameter. If detected, the entity appears in the PII response payload. |
[EUDebitCardNumber] |
Type: European Union Drivers License Number
| Details |
Tag |
| To retrieve this entity type, specify EUDriversLicenseNumber in the piiCategories request parameter. If detected, the entity appears in the PII response payload. |
[EUDriversLicenseNumber] |
Type: European Union GPS Coordinates
| Details |
Tag |
| To retrieve this entity type, specify EUGPSCoordinates in the piiCategories request parameter. If detected, the entity appears in the PII response payload. |
[EUGPSCoordinates] |
Type: European Union National Identification Number
| Details |
Tag |
| To retrieve this entity type, specify EUNationalIdentificationNumber in the piiCategories request parameter. If detected, the entity appears in the PII response payload. |
[EUNationalIdentificationNumber] |
Type: European Union Passport Number
| Details |
Tag |
| To retrieve this entity type, specify EUPassportNumber in the piiCategories request parameter. If detected, the entity appears in the PII response payload. |
[EUPassportNumber] |
Type: European Union Social Security Number
| Details |
Tag |
| To retrieve this entity type, specify EUSocialSecurityNumber in the piiCategories request parameter. If detected, the entity appears in the PII response payload. |
[EUSocialSecurityNumber] |
Type: European Union Tax Identification Number
| Details |
Tag |
| To retrieve this entity type, specify EUTaxIdentificationNumber in the piiCategories request parameter. If detected, the entity appears in the PII response payload. |
[EUTaxIdentificationNumber] |
Type: Expiration Date (preview)
| Details |
Tag |
| To retrieve this entity type, specify ExpirationDate in the piiCategories request parameter. If detected, the entity appears in the PII response payload. |
[ExpirationDate] |
Type: Finland European Health Number
| Details |
Tag |
| To retrieve this entity type, specify FIEuropeanHealthNumber in the piiCategories request parameter. If detected, the entity appears in the PII response payload. |
[FIEuropeanHealthNumber] |
Type: Finland National ID
| Details |
Tag |
| To retrieve this entity type, specify FINationalID in the piiCategories request parameter. If detected, the entity appears in the PII response payload. |
[FINationalID] |
Type: Finland Passport Number
| Details |
Tag |
| To retrieve this entity type, specify FIPassportNumber in the piiCategories request parameter. If detected, the entity appears in the PII response payload. |
[FIPassportNumber] |
Type: France Drivers License Number
| Details |
Tag |
| To retrieve this entity type, specify FRDriversLicenseNumber in the piiCategories request parameter. If detected, the entity appears in the PII response payload. |
[FRDriversLicenseNumber] |
Type: France Health Insurance Number
| Details |
Tag |
| To retrieve this entity type, specify FRHealthInsuranceNumber in the piiCategories request parameter. If detected, the entity appears in the PII response payload. |
[FRHealthInsuranceNumber] |
Type: France National ID
| Details |
Tag |
| To retrieve this entity type, specify FRNationalID in the piiCategories request parameter. If detected, the entity appears in the PII response payload. |
[FRNationalID] |
Type: France Passport Number
| Details |
Tag |
| To retrieve this entity type, specify FRPassportNumber in the piiCategories request parameter. If detected, the entity appears in the PII response payload. |
[FRPassportNumber] |
Type: France Social Security Number
| Details |
Tag |
| To retrieve this entity type, specify FRSocialSecurityNumber in the piiCategories request parameter. If detected, the entity appears in the PII response payload. |
[FRSocialSecurityNumber] |
Type: France Tax Identification Number
| Details |
Tag |
| To retrieve this entity type, specify FRTaxIdentificationNumber in the piiCategories request parameter. If detected, the entity appears in the PII response payload. |
[FRTaxIdentificationNumber] |
Type: France Value Added Tax Number
| Details |
Tag |
| To retrieve this entity type, specify FRValueAddedTaxNumber in the piiCategories request parameter. If detected, the entity appears in the PII response payload. |
[FRValueAddedTaxNumber] |
Type: Germany Drivers License Number
| Details |
Tag |
| To retrieve this entity type, specify DEDriversLicenseNumber in the piiCategories request parameter. If detected, the entity appears in the PII response payload. |
[DEDriversLicenseNumber] |
Type: Germany Identity Card Number
| Details |
Tag |
| To retrieve this entity type, specify DEIdentityCardNumber in the piiCategories request parameter. If detected, the entity appears in the PII response payload. |
[DEIdentityCardNumber] |
Type: Germany Passport Number
| Details |
Tag |
| To retrieve this entity type, specify DEPassportNumber in the piiCategories request parameter. If detected, the entity appears in the PII response payload. |
[DEPassportNumber] |
Type: Germany Tax Identification Number
| Details |
Tag |
| To retrieve this entity type, specify DETaxIdentificationNumber in the piiCategories request parameter. If detected, the entity appears in the PII response payload. |
[DETaxIdentificationNumber] |
Type: Germany Value Added Number
| Details |
Tag |
| To retrieve this entity type, specify DEValueAddedNumber in the piiCategories request parameter. If detected, the entity appears in the PII response payload. |
[DEValueAddedNumber] |
Type: Greece National ID Card
| Details |
Tag |
| To retrieve this entity type, specify GRNationalIDCard in the piiCategories request parameter. If detected, the entity appears in the PII response payload. |
[GRNationalIDCard] |
Type: Greece Tax Identification Number
| Details |
Tag |
| To retrieve this entity type, specify GRTaxIdentificationNumber in the piiCategories request parameter. If detected, the entity appears in the PII response payload. |
[GRTaxIdentificationNumber] |
Type: Hong Kong SAR Identity Card Number
| Details |
Tag |
| To retrieve this entity type, specify HKIdentityCardNumber in the piiCategories request parameter. If detected, the entity appears in the PII response payload. |
[HKIdentityCardNumber] |
Type: Hungary Personal Identification Number
| Details |
Tag |
| To retrieve this entity type, specify HUPersonalIdentificationNumber in the piiCategories request parameter. If detected, the entity appears in the PII response payload. |
[HUPersonalIdentificationNumber] |
Type: Hungary Tax Identification Number
| Details |
Tag |
| To retrieve this entity type, specify HUTaxIdentificationNumber in the piiCategories request parameter. If detected, the entity appears in the PII response payload. |
[HUTaxIdentificationNumber] |
Type: Hungary Value Added Number
| Details |
Tag |
| To retrieve this entity type, specify HUValueAddedNumber in the piiCategories request parameter. If detected, the entity appears in the PII response payload. |
[HUValueAddedNumber] |
Type: India Permanent Account
| Details |
Tag |
| To retrieve this entity type, specify INPermanentAccount in the piiCategories request parameter. If detected, the entity appears in the PII response payload. |
[INPermanentAccount] |
Type: India Unique Identification Number
| Details |
Tag |
| To retrieve this entity type, specify INUniqueIdentificationNumber in the piiCategories request parameter. If detected, the entity appears in the PII response payload. |
[INUniqueIdentificationNumber] |
Type: Indonesia Identity Card Number
| Details |
Tag |
| To retrieve this entity type, specify IDIdentityCardNumber in the piiCategories request parameter. If detected, the entity appears in the PII response payload. |
[IDIdentityCardNumber] |
Type: Ireland Personal Public Service Number
| Details |
Tag |
| To retrieve this entity type, specify IEPersonalPublicServiceNumber in the piiCategories request parameter. If detected, the entity appears in the PII response payload. |
[IEPersonalPublicServiceNumber] |
Type: Israel Bank Account Number
| Details |
Tag |
| To retrieve this entity type, specify ILBankAccountNumber in the piiCategories request parameter. If detected, the entity appears in the PII response payload. |
[ILBankAccountNumber] |
Type: Israel National ID
| Details |
Tag |
| To retrieve this entity type, specify ILNationalID in the piiCategories request parameter. If detected, the entity appears in the PII response payload. |
[ILNationalID] |
Type: Italy Drivers License Number
| Details |
Tag |
| To retrieve this entity type, specify ITDriversLicenseNumber in the piiCategories request parameter. If detected, the entity appears in the PII response payload. |
[ITDriversLicenseNumber] |
Type: Italy Fiscal Code
| Details |
Tag |
| To retrieve this entity type, specify ITFiscalCode in the piiCategories request parameter. If detected, the entity appears in the PII response payload. |
[ITFiscalCode] |
Type: Italy Value Added Tax Number
| Details |
Tag |
| To retrieve this entity type, specify ITValueAddedTaxNumber in the piiCategories request parameter. If detected, the entity appears in the PII response payload. |
[ITValueAddedTaxNumber] |
Type: Japan Bank Account Number
| Details |
Tag |
| To retrieve this entity type, specify JPBankAccountNumber in the piiCategories request parameter. If detected, the entity appears in the PII response payload. |
[JPBankAccountNumber] |
Type: Japan Drivers License Number
| Details |
Tag |
| To retrieve this entity type, specify JPDriversLicenseNumber in the piiCategories request parameter. If detected, the entity appears in the PII response payload. |
[JPDriversLicenseNumber] |
Type: Japan My Number Corporate
| Details |
Tag |
| To retrieve this entity type, specify JPMyNumberCorporate in the piiCategories request parameter. If detected, the entity appears in the PII response payload. |
[JPMyNumberCorporate] |
Type: Japan My Number Personal
| Details |
Tag |
| To retrieve this entity type, specify JPMyNumberPersonal in the piiCategories request parameter. If detected, the entity appears in the PII response payload. |
[JPMyNumberPersonal] |
Type: Japan Passport Number
| Details |
Tag |
| To retrieve this entity type, specify JPPassportNumber in the piiCategories request parameter. If detected, the entity appears in the PII response payload. |
[JPPassportNumber] |
Type: Japan Residence Card Number
| Details |
Tag |
| To retrieve this entity type, specify JPResidenceCardNumber in the piiCategories request parameter. If detected, the entity appears in the PII response payload. |
[JPResidenceCardNumber] |
Type: Japan Resident Registration Number
| Details |
Tag |
| To retrieve this entity type, specify JPResidentRegistrationNumber in the piiCategories request parameter. If detected, the entity appears in the PII response payload. |
[JPResidentRegistrationNumber] |
Type: Japan Social Insurance Number
| Details |
Tag |
| To retrieve this entity type, specify JPSocialInsuranceNumber in the piiCategories request parameter. If detected, the entity appears in the PII response payload. |
[JPSocialInsuranceNumber] |
Type: Latvia Personal Code
| Details |
Tag |
| To retrieve this entity type, specify LVPersonalCode in the piiCategories request parameter. If detected, the entity appears in the PII response payload. |
[LVPersonalCode] |
Type: Lithuania Personal Code
| Details |
Tag |
| To retrieve this entity type, specify LTPersonalCode in the piiCategories request parameter. If detected, the entity appears in the PII response payload. |
[LTPersonalCode] |
Type: Luxembourg National Identification Number Natural
| Details |
Tag |
| To retrieve this entity type, specify LUNationalIdentificationNumberNatural in the piiCategories request parameter. If detected, the entity appears in the PII response payload. |
[LUNationalIdentificationNumberNatural] |
Type: Luxembourg National Identification Number Non Natural
| Details |
Tag |
| To retrieve this entity type, specify LUNationalIdentificationNumberNonNatural in the piiCategories request parameter. If detected, the entity appears in the PII response payload. |
[LUNationalIdentificationNumberNonNatural] |
Type: Malaysia Identity Card Number
| Details |
Tag |
| To retrieve this entity type, specify MYIdentityCardNumber in the piiCategories request parameter. If detected, the entity appears in the PII response payload. |
[MYIdentityCardNumber] |
Type: Malta Identity Card Number
| Details |
Tag |
| To retrieve this entity type, specify MTIdentityCardNumber in the piiCategories request parameter. If detected, the entity appears in the PII response payload. |
[MTIdentityCardNumber] |
Type: Malta Tax ID Number
| Details |
Tag |
| To retrieve this entity type, specify MTTaxIDNumber in the piiCategories request parameter. If detected, the entity appears in the PII response payload. |
[MTTaxIDNumber] |
Type: Netherlands Citizens Service Number
| Details |
Tag |
| To retrieve this entity type, specify NLCitizensServiceNumber in the piiCategories request parameter. If detected, the entity appears in the PII response payload. |
[NLCitizensServiceNumber] |
Type: Netherlands Tax Identification Number
| Details |
Tag |
| To retrieve this entity type, specify NLTaxIdentificationNumber in the piiCategories request parameter. If detected, the entity appears in the PII response payload. |
[NLTaxIdentificationNumber] |
Type: Netherlands Value Added Tax Number
| Details |
Tag |
| To retrieve this entity type, specify NLValueAddedTaxNumber in the piiCategories request parameter. If detected, the entity appears in the PII response payload. |
[NLValueAddedTaxNumber] |
Type: New Zealand Bank Account Number
| Details |
Tag |
| To retrieve this entity type, specify NZBankAccountNumber in the piiCategories request parameter. If detected, the entity appears in the PII response payload. |
[NZBankAccountNumber] |
Type: New Zealand Drivers License Number
| Details |
Tag |
| To retrieve this entity type, specify NZDriversLicenseNumber in the piiCategories request parameter. If detected, the entity appears in the PII response payload. |
[NZDriversLicenseNumber] |
Type: New Zealand Inland Revenue Number
| Details |
Tag |
| To retrieve this entity type, specify NZInlandRevenueNumber in the piiCategories request parameter. If detected, the entity appears in the PII response payload. |
[NZInlandRevenueNumber] |
Type: New Zealand Ministry Of Health Number
| Details |
Tag |
| To retrieve this entity type, specify NZMinistryOfHealthNumber in the piiCategories request parameter. If detected, the entity appears in the PII response payload. |
[NZMinistryOfHealthNumber] |
Type: New Zealand Social Welfare Number
| Details |
Tag |
| To retrieve this entity type, specify NZSocialWelfareNumber in the piiCategories request parameter. If detected, the entity appears in the PII response payload. |
[NZSocialWelfareNumber] |
Type: Norway Identity Number
| Details |
Tag |
| To retrieve this entity type, specify NOIdentityNumber in the piiCategories request parameter. If detected, the entity appears in the PII response payload. |
[NOIdentityNumber] |
Type: Philippines Unified Multi Purpose ID Number
| Details |
Tag |
| To retrieve this entity type, specify PHUnifiedMultiPurposeIDNumber in the piiCategories request parameter. If detected, the entity appears in the PII response payload. |
[PHUnifiedMultiPurposeIDNumber] |
Type: Poland Identity Card
| Details |
Tag |
| To retrieve this entity type, specify PLIdentityCard in the piiCategories request parameter. If detected, the entity appears in the PII response payload. |
[PLIdentityCard] |
Type: Poland National ID
| Details |
Tag |
| To retrieve this entity type, specify PLNationalID in the piiCategories request parameter. If detected, the entity appears in the PII response payload. |
[PLNationalID] |
Type: Poland Passport Number
| Details |
Tag |
| To retrieve this entity type, specify PLPassportNumber in the piiCategories request parameter. If detected, the entity appears in the PII response payload. |
[PLPassportNumber] |
Type: Poland REGON Number
| Details |
Tag |
| To retrieve this entity type, specify PLREGONNumber in the piiCategories request parameter. If detected, the entity appears in the PII response payload. |
[PLREGONNumber] |
Type: Poland Tax Identification Number
| Details |
Tag |
| To retrieve this entity type, specify PLTaxIdentificationNumber in the piiCategories request parameter. If detected, the entity appears in the PII response payload. |
[PLTaxIdentificationNumber] |
Type: Portugal Citizen Card Number
| Details |
Tag |
| To retrieve this entity type, specify PTCitizenCardNumber in the piiCategories request parameter. If detected, the entity appears in the PII response payload. |
[PTCitizenCardNumber] |
Type: Portugal Tax Identification Number
| Details |
Tag |
| To retrieve this entity type, specify PTTaxIdentificationNumber in the piiCategories request parameter. If detected, the entity appears in the PII response payload. |
[PTTaxIdentificationNumber] |
Type: Romania Personal Numerical Code
| Details |
Tag |
| To retrieve this entity type, specify ROPersonalNumericalCode in the piiCategories request parameter. If detected, the entity appears in the PII response payload. |
[ROPersonalNumericalCode] |
Type: Russia Passport Number Domestic
| Details |
Tag |
| To retrieve this entity type, specify RUPassportNumberDomestic in the piiCategories request parameter. If detected, the entity appears in the PII response payload. |
[RUPassportNumberDomestic] |
Type: Russia Passport Number International
| Details |
Tag |
| To retrieve this entity type, specify RUPassportNumberInternational in the piiCategories request parameter. If detected, the entity appears in the PII response payload. |
[RUPassportNumberInternational] |
Type: Saudi Arabia National ID
| Details |
Tag |
| To retrieve this entity type, specify SANationalID in the piiCategories request parameter. If detected, the entity appears in the PII response payload. |
[SANationalID] |
Type: Singapore National Registration Identity Card Number
| Details |
Tag |
| To retrieve this entity type, specify SGNationalRegistrationIdentityCardNumber in the piiCategories request parameter. If detected, the entity appears in the PII response payload. |
[SGNationalRegistrationIdentityCardNumber] |
Type: Slovakia Personal Number
| Details |
Tag |
| To retrieve this entity type, specify SKPersonalNumber in the piiCategories request parameter. If detected, the entity appears in the PII response payload. |
[SKPersonalNumber] |
Type: Slovenia Tax Identification Number
| Details |
Tag |
| To retrieve this entity type, specify SITaxIdentificationNumber in the piiCategories request parameter. If detected, the entity appears in the PII response payload. |
[SITaxIdentificationNumber] |
Type: Slovenia Unique Master Citizen Number
| Details |
Tag |
| To retrieve this entity type, specify SIUniqueMasterCitizenNumber in the piiCategories request parameter. If detected, the entity appears in the PII response payload. |
[SIUniqueMasterCitizenNumber] |
Type: South Africa Identification Number
| Details |
Tag |
| To retrieve this entity type, specify ZAIdentificationNumber in the piiCategories request parameter. If detected, the entity appears in the PII response payload. |
[ZAIdentificationNumber] |
Type: South Korea Drivers License Number (preview)
| Details |
Tag |
| To retrieve this entity type, specify KRDriversLicenseNumber in the piiCategories request parameter. If detected, the entity appears in the PII response payload. |
[KRDriversLicenseNumber] |
Type: South Korea Passport Number (preview)
| Details |
Tag |
| To retrieve this entity type, specify KRPassportNumber in the piiCategories request parameter. If detected, the entity appears in the PII response payload. |
[KRPassportNumber] |
Type: South Korea Social Security Number (preview)
| Details |
Tag |
| To retrieve this entity type, specify KRSocialSecurityNumber in the piiCategories request parameter. If detected, the entity appears in the PII response payload. |
[KRSocialSecurityNumber] |
Type: South Korea Resident Registration Number
| Details |
Tag |
| To retrieve this entity type, specify KRResidentRegistrationNumber in the piiCategories request parameter. If detected, the entity appears in the PII response payload. |
[KRResidentRegistrationNumber] |
Type: Spain DNI
| Details |
Tag |
| To retrieve this entity type, specify ESDNI in the piiCategories request parameter. If detected, the entity appears in the PII response payload. |
[ESDNI] |
Type: Spain Social Security Number
| Details |
Tag |
| To retrieve this entity type, specify ESSocialSecurityNumber in the piiCategories request parameter. If detected, the entity appears in the PII response payload. |
[ESSocialSecurityNumber] |
Type: Spain Tax Identification Number
| Details |
Tag |
| To retrieve this entity type, specify ESTaxIdentificationNumber in the piiCategories request parameter. If detected, the entity appears in the PII response payload. |
[ESTaxIdentificationNumber] |
Type: Sweden National ID
| Details |
Tag |
| To retrieve this entity type, specify SENationalID in the piiCategories request parameter. If detected, the entity appears in the PII response payload. |
[SENationalID] |
Type: Sweden Passport Number
| Details |
Tag |
| To retrieve this entity type, specify SEPassportNumber in the piiCategories request parameter. If detected, the entity appears in the PII response payload. |
[SEPassportNumber, PassportNumber] |
Type: Sweden Tax Identification Number
| Details |
Tag |
| To retrieve this entity type, specify SETaxIdentificationNumber in the piiCategories request parameter. If detected, the entity appears in the PII response payload. |
[SETaxIdentificationNumber] |
Type: Switzerland Social Security Number
| Details |
Tag |
| To retrieve this entity type, specify CHSocialSecurityNumber in the piiCategories request parameter. If detected, the entity appears in the PII response payload. |
[CHSocialSecurityNumber] |
Type: Taiwanese ID
| Details |
Tag |
| To retrieve this entity type, specify TWNationalID in the piiCategories request parameter. If detected, the entity appears in the PII response payload. |
[TWNationalID] |
Type: Taiwan Passport Number
| Details |
Tag |
| To retrieve this entity type, specify TWPassportNumber in the piiCategories request parameter. If detected, the entity appears in the PII response payload. |
[TWPassportNumber] |
Type: Taiwan Resident Certificate
| Details |
Tag |
| To retrieve this entity type, specify TWResidentCertificate in the piiCategories request parameter. If detected, the entity appears in the PII response payload. |
[TWResidentCertificate] |
Type: Thailand Population Identification Code
| Details |
Tag |
| To retrieve this entity type, specify THPopulationIdentificationCode in the piiCategories request parameter. If detected, the entity appears in the PII response payload. |
[THPopulationIdentificationCode] |
Type: Türkiye National Identification Number
| Details |
Tag |
| To retrieve this entity type, specify TRNationalIdentificationNumber in the piiCategories request parameter. If detected, the entity appears in the PII response payload. |
[TRNationalIdentificationNumber] |
Type: Ukraine Passport Number Domestic
| Details |
Tag |
| To retrieve this entity type, specify UAPassportNumberDomestic in the piiCategories request parameter. If detected, the entity appears in the PII response payload. |
[UAPassportNumberDomestic] |
Type: Ukraine Passport Number International
| Details |
Tag |
| To retrieve this entity type, specify UAPassportNumberInternational in the piiCategories request parameter. If detected, the entity appears in the PII response payload. |
[UAPassportNumberInternational] |
Type: United Kingdom Drivers License Number
| Details |
Tag |
| To retrieve this entity type, specify UKDriversLicenseNumber in the piiCategories request parameter. If detected, the entity appears in the PII response payload. |
[UKDriversLicenseNumber] |
Type: United Kingdom Electoral Roll Number
| Details |
Tag |
| To retrieve this entity type, specify UKElectoralRollNumber in the piiCategories request parameter. If detected, the entity appears in the PII response payload. |
[UKElectoralRollNumber] |
Type: United Kingdom National Health Number
| Details |
Tag |
| To retrieve this entity type, specify UKNationalHealthNumber in the piiCategories request parameter. If detected, the entity appears in the PII response payload. |
[UKNationalHealthNumber] |
Type: United Kingdom National Insurance Number
| Details |
Tag |
| To retrieve this entity type, specify UKNationalInsuranceNumber in the piiCategories request parameter. If detected, the entity appears in the PII response payload. |
[UKNationalInsuranceNumber] |
Type: United Kingdom Unique Taxpayer Number
| Details |
Tag |
| To retrieve this entity type, specify UKUniqueTaxpayerNumber in the piiCategories request parameter. If detected, the entity appears in the PII response payload. |
[UKUniqueTaxpayerNumber] |
Type: United States Bank Account Number
| Details |
Tag |
| To retrieve this entity type, specify USBankAccountNumber in the piiCategories request parameter. If detected, the entity appears in the PII response payload. |
[USBankAccountNumber] |
Type: United States Drivers License Number
| Details |
Tag |
| To retrieve this entity type, specify USDriversLicenseNumber in the piiCategories request parameter. If detected, the entity appears in the PII response payload. |
[USDriversLicenseNumber] |
Type: United States Drug Enforcement Agency Number
| Details |
Tag |
| To retrieve this entity type, specify "DrugEnforcementAgencyNumber in the piiCategories request parameter. If detected, the entity appears in the PII response payload. |
["DrugEnforcementAgencyNumber] |
Type: United States Individual Taxpayer Identification
| Details |
Tag |
| To retrieve this entity type, specify USIndividualTaxpayerIdentification in the piiCategories request parameter. If detected, the entity appears in the PII response payload. |
[USIndividualTaxpayerIdentification] |
Type: United States Medicare Beneficiary Identification (preview)
| Details |
Tag |
| To retrieve this entity type, specify USMedicareBeneficiaryId in the piiCategories request parameter. If detected, the entity appears in the PII response payload. |
[*USMedicareBeneficiaryId] |
Type: United States Social Security Number
| Details |
Tag |
| To retrieve this entity type, specify USSocialSecurityNumber in the piiCategories request parameter. If detected, the entity appears in the PII response payload. |
[USSocialSecurityNumber] |
Type: United States/United Kingdom Passport Number
| Details |
Tag |
| To retrieve this entity type, specify USUKPassportNumber in the piiCategories request parameter. If detected, the entity appears in the PII response payload. |
[USUKPassportNumber] |
Type: ZipCode (preview)
| Details |
Tag |
| To retrieve this entity type, specify ZipCode in the piiCategories request parameter. If detected, the entity appears in the PII response payload. |
[USUKPassportNumber] |
Related content
PII entity categories list