Note
Access to this page requires authorization. You can try signing in or changing directories.
Access to this page requires authorization. You can try changing directories.
Use this article to find the entity categories that the personally identifiable information (PII) detection feature returns. This feature runs a predictive model to identify, categorize, and redact sensitive information from an input document.
The PII feature includes the ability to detect personal (PII) and health (PHI) information.
Supported entities
Note
- To detect protected health information (PHI), use the
domain=phiparameter and model version2020-04-01or later. - The
TypeandSubtypeare new designations introduced in the2025-05-15-previewversion.
The following entity categories are returned when you're sending API requests PII feature:
Type: Person
This type contains the following entity:
Entity
Person
Details
Names of people. Returned as both PII and PHI.
To get this entity type, add Person to the piiCategories parameter. Person is returned in the API response if detected.
Supported languages
en, es, fr, de, it, pt-pt, pt-br, zh, ja, ko, nl, sv, tr, hi, af, ca, da, el, ga, gl, ku, nl, no, ss, ro, sq, ur, ar, bg, bs, cy, fa, hr, id, mg, mk, ms, ps, ru, sl, so, sr, sw, am, as, cs, et, eu, fi, he, hu, km, lo, lt, lv, mr, my, ne, or, pa, pl, sk, th, uk, az, bn, gu, hy, ka, kk, kn, ky, ml, mn, ta, te, ug, uz, vi
Type: PersonType
This type contains the following entity:
Entity
PersonType
Details
Job types or roles held by a person.
To get this entity category, add PersonType to the piiCategories parameter. PersonType is returned in the API response if detected.
Supported languages
en, es, fr, de, it, pt-pt, pt-br, zh, ja, ko, nl, sv, tr, hi, af, ca, da, el, ga, gl, ku, nl, no, ss, ro, sq, ur, ar, bg, bs, cy, fa, hr, id, mg, mk, ms, ps, ru, sl, so, sr, sw, am, as, cs, et, eu, fi, he, hu, km, lo, lt, lv, mr, my, ne, or, pa, pl, sk, th, uk, az, bn, gu, hy, ka, kk, kn, ky, ml, mn, ta, te, ug, uz, vi
Type: PhoneNumber
This type contains the following entity:
Entity
PhoneNumber
Details
Phone numbers (US and EU phone numbers only). Returned as both PII and PHI.
To get this entity category, add PhoneNumber to the piiCategories parameter. PhoneNumber is returned in the API response if detected.
Supported languages
en, es, fr, de, it, zh-hans, ja, ko, pt-pt pt-br
Type: Organization
This type contains the following entity:
Entity
Organization
Details
Companies, political groups, musical bands, sport clubs, government bodies, and public organizations. Nationalities and religions are not included in this entity type. Returned as both PII and PHI.
To get this entity category, add Organization to the piiCategories parameter. Organization is returned in the API response if detected.
Supported languages
en, es, fr, de, it, pt-pt, pt-br, zh, ja, ko, nl, sv, tr, hi, af, ca, da, el, ga, gl, ku, nl, no, ss, ro, sq, ur, ar, bg, bs, cy, fa, hr, id, mg, mk, ms, ps, ru, sl, so, sr, sw, am, as, cs, et, eu, fi, he, hu, km, lo, lt, lv, mr, my, ne, or, pa, pl, sk, th, uk, az, bn, gu, hy, ka, kk, kn, ky, ml, mn, ta, te, ug, uz, vi
Subtype
The entity in this type can have the following subcategories:
Entity subtype
Medical
Details
Medical companies and groups.
To get this entity category, add OrganizationMedical to the piiCategories parameter. OrganizationMedical is returned in the API response if detected.
Supported languages
en
Stock exchange
Stock exchange groups.
To get this entity category, add OrganizationStockExchange to the piiCategories parameter. OrganizationStockExchange is returned in the API response if detected.
en
Sports
Sports-related organizations.
To get this entity category, add OrganizationSports to the piiCategories parameter. OrganizationSports is returned in the API response if detected.
en
Type: Address
This type contains the following entity:
Entity
Address
Details
Full mailing address. Returned as both PII and PHI.
To get this entity type, add Address to the piiCategories parameter. Address is returned in the API response if detected.
Supported languages
en, es, fr, de, it, pt-pt, pt-br, zh, ja, ko, nl, sv, tr, hi, af, ca, da, el, ga, gl, ku, nl, no, ss, ro, sq, ur, ar, bg, bs, cy, fa, hr, id, mg, mk, ms, ps, ru, sl, so, sr, sw, am, as, cs, et, eu, fi, he, hu, km, lo, lt, lv, mr, my, ne, or, pa, pl, sk, th, uk, az, bn, gu, hy, ka, kk, kn, ky, ml, mn, ta, te, ug, uz, vi
Type: Email
This category contains the following entity:
Entity
Details
Email addresses. Returned as both PII and PHI.
To get this entity type, add Email to the piiCategories parameter. Email is returned in the API response if detected.
Supported languages
en, es, fr, de, it, zh, ja, ko, pt-pt, pt-br, nl, sv, tr, hi
Type: URL
This type contains the following entity:
Entity
URL
Details
URLs to websites. Returned as both PII and PHI.
To get this entity type, add URL to the piiCategories parameter. URL is returned in the API response if detected.
Supported languages
en, es, fr, de, it, zh, ja, ko, pt-pt, pt-br, nl, sv, tr, hi
Type: IP Address
This category contains the following entity:
Entity
IPAddress
Details
Network IP addresses. Returned as both PII and PHI.
To get this entity type, add IPAddress to the piiCategories parameter. IPAddress is returned in the API response if detected.
Supported languages
en, es, fr, de, it, zh, ja, ko, pt-pt, pt-br, nl, sv, tr, hi
Type: DateTime
This type contains the following entities:
Entity
DateTime
Details
Dates and times of day.
To get this entity type, add DateTime to the piiCategories parameter. DateTime is returned in the API response if detected.
Supported languages
en, es, fr, de, it, pt-pt, pt-br, zh, ja, ko, nl, sv, tr, hi, af, ca, da, el, ga, gl, ku, nl, no, ss, ro, sq, ur, ar, bg, bs, cy, fa, hr, id, mg, mk, ms, ps, ru, sl, so, sr, sw, am, as, cs, et, eu, fi, he, hu, km, lo, lt, lv, mr, my, ne, or, pa, pl, sk, th, uk, az, bn, gu, hy, ka, kk, kn, ky, ml, mn, ta, te, ug, uz, vi
Subtypes
The entity in this type can have the following subtypes:
Entity subtypes
Date
Details
Calendar dates. Returned as both PII and PHI.
To get this entity type, add Date to the piiCategories parameter. Date is returned in the API response if detected.
Supported languages
en, es, fr, de, it, pt-pt, pt-br, zh, ja, ko, nl, sv, tr, hi, af, ca, da, el, ga, gl, ku, nl, no, ss, ro, sq, ur, ar, bg, bs, cy, fa, hr, id, mg, mk, ms, ps, ru, sl, so, sr, sw, am, as, cs, et, eu, fi, he, hu, km, lo, lt, lv, mr, my, ne, or, pa, pl, sk, th, uk, az, bn, gu, hy, ka, kk, kn, ky, ml, mn, ta, te, ug, uz, vi
DateAndTime
Dates and times of day.
To get this entity category, add DateAndTime to the piiCategories parameter. DateAndTime is returned in the API response if detected.
Supported languages
en, es, fr, de, it, pt-pt, pt-br, zh, ja, ko, nl, sv, tr, hi, af, ca, da, el, ga, gl, ku, nl, no, ss, ro, sq, ur, ar, bg, bs, cy, fa, hr, id, mg, mk, ms, ps, ru, sl, so, sr, sw, am, as, cs, et, eu, fi, he, hu, km, lo, lt, lv, mr, my, ne, or, pa, pl, sk, th, uk, az, bn, gu, hy, ka, kk, kn, ky, ml, mn, ta, te, ug, uz, vi
Subtype: Age
The PII service supports the Age subtype within the broader Quantity type (since Age is the personally identifiable piece of information).
Entity subtype
Age
Details
Ages.
Supported languages
en, es, fr, de, it, pt-pt, pt-br, zh, ja, ko, nl, sv, tr, hi, af, ca, da, el, ga, gl, ku, nl, no, ss, ro, sq, ur, ar, bg, bs, cy, fa, hr, id, mg, mk, ms, ps, ru, sl, so, sr, sw, am, as, cs, et, eu, fi, he, hu, km, lo, lt, lv, mr, my, ne, or, pa, pl, sk, th, uk, az, bn, gu, hy, ka, kk, kn, ky, ml, mn, ta, te, ug, uz, vi
Subtype: DateOfBirth
Entity subtype
Date of birth.
Details
Date
To get this entity type, add DateOfBirth to the piiCategories parameter. DateOfBirth is returned in the API response if detected.
Supported languages
en
Identification
Type: BankAccountNumber
Entity
Details
To get this entity type, add BankAccountNumber to the piiCategories parameter. BankAccountNumber is returned in the API response if detected.
Supported languages
en, es, fr, de, it, pt-pt, pt-br, zh, ja, ko, nl, sv, tr, hi, af, ca, da, el, ga, gl, ku, nl, no, ss, ro, sq, ur, ar, bg, bs, cy, fa, hr, id, mg, mk, ms, ps, ru, sl, so, sr, sw, am, as, cs, et, eu, fi, he, hu, km, lo, lt, lv, mr, my, ne, or, pa, pl, sk, th, uk, az, bn, gu, hy, ka, kk, kn, ky, ml, mn, ta, te, ug, uz, vi
Type: DriversLicenseNumber
Entity
Details
To get this entity type, add DriversLicenseNumber to the piiCategories parameter. DriversLicenseNumber is returned in the API response if detected.
Supported languages
en, es, fr, de, it, pt-pt, pt-br, zh, ja, ko, nl, sv, tr, hi, da, nl, no, ro, ar, bg, hr, ms, ru, sl, cs, et, fi, he, hu, km, lo, lt, lv, sk, th, uk
Type: PassportNumber
Entity
Details
To get this entity type, add PassportNumber to the piiCategories parameter. PassportNumber is returned in the API response if detected.
Supported languages
en, es, fr, de, it, pt-pt, pt-br, zh, ja, ko, nl, sv, tr, hi, da, nl, no, ro, ar, bg, hr, ms, ru, sl, cs, et, fi, he, hu, km, lo, lt, lv, sk, th, uk
Azure information
These entity types include identifiable Azure information like authentication information and connection strings. Not returned as PHI.
Entity
Azure DocumentDB Auth Key
Details
Authorization key for an Azure Cosmos DB server.
To get this entity type, add AzureDocumentDBAuthKey to the piiCategories parameter. AzureDocumentDBAuthKey is returned in the API response if detected.
Supported languages
en, es, fr, de, it, pt-pt, pt-br, zh, ja, ko, nl, sv, tr, hi, da, nl, no, ro, ar, bg, hr, ms, ru, sl, cs, et, fi, he, hu, lv, sk, th, uk
Azure IAAS Database Connection String and Azure SQL Connection String.
Connection string for an Azure infrastructure as a service (IaaS) database, and SQL connection string.
To get this entity type, add AzureIAASDatabaseConnectionAndSQLString to the piiCategories parameter. AzureIAASDatabaseConnectionAndSQLString is returned in the API response if detected.
en, es, fr, de, it, pt-pt, pt-br, zh, ja, ko, nl, sv, tr, hi, da, nl, no, ro, ar, bg, hr, ms, ru, sl, cs, et, fi, he, hu, lv, sk, th, uk
Azure IoT Connection String
Connection string for Azure IoT.
To get this entity type, add AzureIoTConnectionString to the piiCategories parameter. AzureIoTConnectionString is returned in the API response if detected.
en, es, fr, de, it, pt-pt, pt-br, zh, ja, ko, nl, sv, tr, hi, da, nl, no, ro, ar, bg, hr, ms, ru, sl, cs, et, fi, he, hu, lv, sk, th, uk
Azure Publish Setting Password
Password for Azure publish settings.
To get this entity type, add AzurePublishSettingPassword to the piiCategories parameter. AzurePublishSettingPassword is returned in the API response if detected.
en, es, fr, de, it, pt-pt, pt-br, zh, ja, ko, nl, sv, tr, hi, da, nl, no, ro, ar, bg, hr, ms, ru, sl, cs, et, fi, he, hu, lv, sk, th, uk
Azure Redis Cache Connection String
Connection string for a Redis cache.
To get this entity type, add AzureRedisCacheString to the piiCategories parameter. AzureRedisCacheString is returned in the API response if detected.
en, es, fr, de, it, pt-pt, pt-br, zh, ja, ko, nl, sv, tr, hi, da, nl, no, ro, ar, bg, hr, ms, ru, sl, cs, et, fi, he, hu, lv, sk, th, uk
Azure SAS
Connection string for Azure software as a service (SaaS).
To get this entity type, add AzureSAS to the piiCategories parameter. AzureSAS is returned in the API response if detected.
en, es, fr, de, it, pt-pt, pt-br, zh, ja, ko, nl, sv, tr, hi, da, nl, no, ro, ar, bg, hr, ms, ru, sl, cs, et, fi, he, hu, lv, sk, th, uk
Azure Service Bus Connection String
Connection string for an Azure service bus.
To get this entity type, add AzureServiceBusString to the piiCategories parameter. AzureServiceBusString is returned in the API response if detected.
en, es, fr, de, it, pt-pt, pt-br, zh, ja, ko, nl, sv, tr, hi, da, nl, no, ro, ar, bg, hr, ms, ru, sl, cs, et, fi, he, hu, lv, sk, th, uk
Azure Storage Account Key
Account key for an Azure storage account.
To get this entity type, add AzureStorageAccountKey to the piiCategories parameter. AzureStorageAccountKey is returned in the API response if detected.
en, es, fr, de, it, pt-pt, pt-br, zh, ja, ko, nl, sv, tr, hi, da, nl, no, ro, ar, bg, hr, ms, ru, sl, cs, et, fi, he, hu, lv, sk, th, uk
Azure Storage Account Key (Generic)
Generic account key for an Azure storage account.
To get this entity type, add AzureStorageAccountGeneric to the piiCategories parameter. AzureStorageAccountGeneric is returned in the API response if detected.
en, es, fr, de, it, pt-pt, pt-br, zh, ja, ko, nl, sv, tr, hi, da, nl, no, ro, ar, bg, hr, ms, ru, sl, cs, et, fi, he, hu, lv, sk, th, uk
SQL Server Connection String
Connection string for a computer running SQL Server.
To get this entity type, add SQLServerConnectionString to the piiCategories parameter. SQLServerConnectionString is returned in the API response if detected.
en