Supported Personally Identifiable Information (PII) entity categories

Use this article to find the entity categories that can be returned by the PII detection feature. 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.

Entity categories

Note

To detect protected health information (PHI), use the domain=phi parameter and model version 2020-04-01 or later.

For example: https://<your-custom-subdomain>.cognitiveservices.azure.com/text/analytics/v3.1/entities/recognition/pii?domain=phi&model-version=2021-01-15

The following entity categories are returned when you're sending API requests PII feature.

Category: Person

This category contains the following entity:

Entity

Person

Details

Names of people. Returned as both PII and PHI.

To get this entity category, add Person to the pii-categories parameter. Person will be returned in the API response if detected.

Supported document languages

en, es, fr, de, it, zh-hans, ja, ko, pt-pt, pt-br

Category: PersonType

This category contains the following entity:

Entity

PersonType

Details

Job types or roles held by a person.

To get this entity category, add PersonType to the pii-categories parameter. PersonType will be returned in the API response if detected.

Supported document languages

en, es, fr, de, it, zh-hans, ja, ko, pt-pt, pt-br

Category: PhoneNumber

This category 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 pii-categories parameter. PhoneNumber will be returned in the API response if detected.

Supported document languages

en, es, fr, de, it, zh-hans, ja, ko, pt-pt pt-br

Category: Organization

This category 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 pii-categories parameter. Organization will be returned in the API response if detected.

Supported document languages

en, es, fr, de, it, zh-hans, ja, ko, pt-pt, pt-br

Subcategories

The entity in this category can have the following subcategories.

Entity subcategory

Medical

Details

Medical companies and groups.

To get this entity category, add OrganizationMedical to the pii-categories parameter. OrganizationMedical will be returned in the API response if detected.

Supported document languages

en

Stock exchange

Stock exchange groups.

To get this entity category, add OrganizationStockExchange to the pii-categories parameter. OrganizationStockExchange will be returned in the API response if detected.

en

Sports

Sports-related organizations.

To get this entity category, add OrganizationSports to the pii-categories parameter. OrganizationSports will be returned in the API response if detected.

en

Category: Address

This category contains the following entity:

Entity

Address

Details

Full mailing address. Returned as both PII and PHI.

To get this entity category, add Address to the pii-categories parameter. Address will be returned in the API response if detected.

Supported document languages

en, es, fr, de, it, zh-hans, ja, ko, pt-pt, pt-br

Category: Email

This category contains the following entity:

Entity

Email

Details

Email addresses. Returned as both PII and PHI.

To get this entity category, add Email to the pii-categories parameter. Email will be returned in the API response if detected.

Supported document languages

en, es, fr, de, it, zh-hans, ja, ko, pt-pt, pt-br

Category: URL

This category contains the following entity:

Entity

URL

Details

URLs to websites. Returned as both PII and PHI.

To get this entity category, add URL to the pii-categories parameter. URL will be returned in the API response if detected.

Supported document languages

en, es, fr, de, it, zh-hans, ja, ko, pt-pt, pt-br

Category: IP

This category contains the following entity:

Entity

IP

Details

Network IP addresses. Returned as both PII and PHI.

To get this entity category, add IP to the pii-categories parameter. IP will be returned in the API response if detected.

Supported document languages

en, es, fr, de, it, zh-hans, ja, ko, pt-pt, pt-br

Category: DateTime

This category contains the following entities:

Entity

DateTime

Details

Dates and times of day.

To get this entity category, add DateTime to the pii-categories parameter. DateTime will be returned in the API response if detected.

Supported document languages

en, es, fr, de, it, zh-hans, ja, ko, pt-pt, pt-br

Subcategories

The entity in this category can have the following subcategories.

Entity subcategory

Date

Details

Calender dates. Returned as both PII and PHI.

To get this entity category, add Date to the pii-categories parameter. Date will be returned in the API response if detected.

Supported document languages

en, es, fr, de, it, zh-hans, ja, ko, pt-pt, pt-br

Category: Quantity

This category contains the following entities:

Entity

Quantity

Details

Numbers and numeric quantities.

To get this entity category, add Quantity to the pii-categories parameter. Quantity will be returned in the API response if detected.

Supported document languages

en, es, fr, de, it, zh-hans, ja, ko, pt-pt, pt-br

Subcategories

The entity in this category can have the following subcategories.

Entity subcategory

Age

Details

Ages.

To get this entity category, add Age to the pii-categories parameter. Age will be returned in the API response if detected.

Supported document languages

en, es, fr, de, it, zh-hans, ja, ko, pt-pt, pt-br

Azure information

These entity categories includes identifiable Azure information, including 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 category, add AzureDocumentDBAuthKey to the pii-categories parameter. AzureDocumentDBAuthKey will be returned in the API response if detected.

Supported document languages

en

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 category, add AzureIAASDatabaseConnectionAndSQLString to the pii-categories parameter. AzureIAASDatabaseConnectionAndSQLString will be returned in the API response if detected.

en

Azure IoT Connection String

Connection string for Azure IoT.

To get this entity category, add AzureIoTConnectionString to the pii-categories parameter. AzureIoTConnectionString will be returned in the API response if detected.

en

Azure Publish Setting Password

Password for Azure publish settings.

To get this entity category, add AzurePublishSettingPassword to the pii-categories parameter. AzurePublishSettingPassword will be returned in the API response if detected.

en

Azure Redis Cache Connection String

Connection string for a Redis cache.

To get this entity category, add AzureRedisCacheString to the pii-categories parameter. AzureRedisCacheString will be returned in the API response if detected.

en

Azure SAS

Connection string for Azure software as a service (SaaS).

To get this entity category, add AzureSAS to the pii-categories parameter. AzureSAS will be returned in the API response if detected.

en

Azure Service Bus Connection String

Connection string for an Azure service bus.

To get this entity category, add AzureServiceBusString to the pii-categories parameter. AzureServiceBusString will be returned in the API response if detected.

en

Azure Storage Account Key

Account key for an Azure storage account.

To get this entity category, add AzureStorageAccountKey to the pii-categories parameter. AzureStorageAccountKey will be returned in the API response if detected.

en

Azure Storage Account Key (Generic)

Generic account key for an Azure storage account.

To get this entity category, add AzureStorageAccountGeneric to the pii-categories parameter. AzureStorageAccountGeneric will be returned in the API response if detected.

en

SQL Server Connection String

Connection string for a computer running SQL Server.

To get this entity category, add SQLServerConnectionString to the pii-categories parameter. SQLServerConnectionString will be returned in the API response if detected.

en

Identification

Financial account identification

This entity category includes financial information and official forms of identification.

Category: ABA routing number

This category contains the following entity:

Entity

ABA routing number

Details

American Banker Association (ABA) transit routing numbers. Also returned with domain=phi.

To get this entity category, add ABARoutingNumber to the pii-categories parameter. ABARoutingNumber will also be returned in the API response if detected.

Supported document languages

en

Category: SWIFT code

This category contains the following entity:

Entity

SWIFT code

Details

SWIFT codes for payment instruction information. Also returned with domain=phi.

To get this entity category, add SWIFTCode to the pii-categories parameter. SWIFTCode will be returned in the API response if detected.

Supported document languages

en, es, fr, de, it, pt-pt, pt-br, ja

Category: Credit card

This category contains the following entity:

Entity

Credit card

Details

Credit card numbers. Also returned with domain=phi.

To get this entity category, add CreditCardNumber to the pii-categories parameter. CreditCardNumber will be returned in the API response if detected.

Supported document languages

en, es, fr, de, it, pt-pt, pt-br, ja, zh-hans, ja, ko

Category: International Banking Account Number (IBAN)

This category contains the following entity:

Entity

Credit card

Details

IBAN codes for payment instruction information. Also returned with domain=phi.

To get this entity category, add InternationlBankingAccountNumber to the pii-categories parameter. InternationlBankingAccountNumber will be returned in the API response if detected.

Supported document languages

en, es, fr, de, it, pt-pt, pt-br

Government and country/region-specific identification

Note

The following financial and country-specific entities are not returned with the domain=phi parameter:

• Passport numbers
• Tax IDs

The following entities are grouped and listed by country:

Argentina

Entity

Argentina National Identity (DNI) Number

Details Also returned with domain=phi.

To get this entity category, add ARNationalIdentityNumber to the pii-categories parameter. ARNationalIdentityNumber will be returned in the API response if detected.

Supported document languages

en, es

Austria

Entity

Austria identity card

Details

To get this entity category, add ATIdentityCard to the pii-categories parameter. ATIdentityCard will be returned in the API response if detected.

Supported document languages

de

Austria tax identification number

To get this entity category, add ATTaxIdentificationNumber to the pii-categories parameter. ATTaxIdentificationNumber will be returned in the API response if detected.

de

Austria Value Added Tax (VAT) number

To get this entity category, add ATValueAddedTaxNumber to the pii-categories parameter. ATValueAddedTaxNumber will be returned in the API response if detected.

de

Australia

Entity

Australia bank account number

Details

To get this entity category, add AUBankAccountNumber to the pii-categories parameter. AUBankAccountNumber will be returned in the API response if detected.

Also returned with domain=phi.

Supported document languages

en

Australian business number

To get this entity category, add AUBusinessNumber to the pii-categories parameter. AUBusinessNumber will be returned in the API response if detected.

en

Australia Company Number

To get this entity category, add AUCompanyNumber to the pii-categories parameter. AUCompanyNumber will be returned in the API response if detected.

en

Australia driver's license

To get this entity category, add AUDriversLicense to the pii-categories parameter. AUDriversLicense will be returned in the API response if detected.

Also returned with domain=phi.

en

Australia medical account number

To get this entity category, add AUMedicalAccountNumber to the pii-categories parameter. AUMedicalAccountNumber will be returned in the API response if detected.

Also returned with domain=phi.

en

Australia passport number

To get this entity category, add ATPassportNumber to the pii-categories parameter. ATPassportNumber will be returned in the API response if detected.

en

Australia tax file number

To get this entity category, add ATTaxIdentificationNumber to the pii-categories parameter. ATTaxIdentificationNumber will be returned in the API response if detected.

en

Belgium

Entity

Belgium national number

Details

To get this entity category, add BENationalNumber to the pii-categories parameter. BENationalNumber will be returned in the API response if detected.

Also returned with domain=phi.

Supported document languages

fr, de

Belgium Value Added Tax (VAT) number

To get this entity category, add BEValueAddedTaxNumber to the pii-categories parameter. BEValueAddedTaxNumber will be returned in the API response if detected.

fr, de

Brazil

Entity

Brazil legal entity number (CNPJ)

Details

To get this entity category, add BRLegalEntityNumber to the pii-categories parameter. BRLegalEntityNumber will be returned in the API response if detected.

Also returned with domain=phi.

Supported document languages

pt-pt, pt-br

Brazil CPF number

To get this entity category, add BRCPFNumber to the pii-categories parameter. BRCPFNumber will be returned in the API response if detected.

Also returned with domain=phi.

pt-pt, pt-br

Brazil National ID Card (RG)

To get this entity category, add BRNationalIDRG to the pii-categories parameter. BRNationalIDRG will be returned in the API response if detected.

Also returned with domain=phi.

pt-pt, pt-br

Canada

Entity

Canada bank account number

Details

To get this entity category, add CABankAccountNumber to the pii-categories parameter. CABankAccountNumber will be returned in the API response if detected.

Also returned with domain=phi.

Supported document languages

en, fr

Canada driver's license number

To get this entity category, add CADriversLicenseNumber to the pii-categories parameter. CADriversLicenseNumber will be returned in the API response if detected.

Also returned with domain=phi.

en, fr

Canada health service number

To get this entity category, add CAHealthServiceNumber to the pii-categories parameter. CAHealthServiceNumber will be returned in the API response if detected.

Also returned with domain=phi.

en, fr

Canada passport number

To get this entity category, add CAPassportNumber to the pii-categories parameter. CAPassportNumber will be returned in the API response if detected.

en, fr

Canada Personal Health Identification Number (PHIN)

To get this entity category, add CAPersonalHealthIdentification to the pii-categories parameter. CAPersonalHealthIdentification will be returned in the API response if detected.

Also returned with domain=phi.

en, fr

Canada social insurance number

To get this entity category, add CASocialInsuranceNumber to the pii-categories parameter. CASocialInsuranceNumber will be returned in the API response if detected.

Also returned with domain=phi.

en, fr

Chile

Entity

Chile identity card number

Details

To get this entity category, add CLIdentityCardNumber to the pii-categories parameter. CLIdentityCardNumber will be returned in the API response if detected.

Also returned with domain=phi.

Supported document languages

es

China

Entity

China Resident Identity Card (PRC) number

Details

To get this entity category, add CNResidentIdentityCardNumber to the pii-categories parameter. CNResidentIdentityCardNumber will be returned in the API response if detected.

Also returned with domain=phi.

Supported document languages

zh-hans

European Union (EU)

Entity

EU debit card number

Details

To get this entity category, add EUDebitCardNumber to the pii-categories parameter. EUDebitCardNumber will be returned in the API response if detected.

Also returned with domain=phi.

Supported document languages

en, es, fr, de, it, pt-pt

EU driver's license number

To get this entity category, add EUDriversLicenseNumber to the pii-categories parameter. EUDriversLicenseNumber will be returned in the API response if detected.

Also returned with domain=phi.

en, es, fr, de, it, pt-pt

EU GPU coordinates

To get this entity category, add EUGPSCoordinates to the pii-categories parameter. EUGPSCoordinates will be returned in the API response if detected.

en, es, fr, de, it, pt-pt

EU national identification number

To get this entity category, add EUNationalIdentificationNumber to the pii-categories parameter. EUNationalIdentificationNumber will be returned in the API response if detected.

Also returned with domain=phi.

en, es, fr, de, it, pt-pt

EU passport number

To get this entity category, add EUPassportNumber to the pii-categories parameter. EUPassportNumber will be returned in the API response if detected.

en, es, fr, de, it, pt-pt

EU Social Security Number (SSN) or equivalent ID

To get this entity category, add EUSocialSecurityNumber to the pii-categories parameter. EUSocialSecurityNumber will be returned in the API response if detected.

Also returned with domain=phi.

en, es, fr, de, it, pt-pt

EU Tax Identification Number (TIN)

To get this entity category, add EUTaxIdentificationNumber to the pii-categories parameter. EUTaxIdentificationNumber will be returned in the API response if detected.

en, es, fr, de, it, pt-pt

France

Entity

France driver's license number

Details

To get this entity category, add FRDriversLicenseNumber to the pii-categories parameter. FRDriversLicenseNumber will be returned in the API response if detected.

Also returned with domain=phi.

Supported document languages

fr

France health insurance number

To get this entity category, add FRHealthInsuranceNumber to the pii-categories parameter. FRHealthInsuranceNumber will be returned in the API response if detected.

fr

France national ID card (CNI)

To get this entity category, add FRNationalID to the pii-categories parameter. FRNationalID will be returned in the API response if detected.

Also returned with domain=phi.

fr

France passport number

To get this entity category, add FRPassportNumber to the pii-categories parameter. FRPassportNumber will be returned in the API response if detected.

fr

France Social Security Number (INSEE)

To get this entity category, add FRSocialSecurityNumber to the pii-categories parameter. FRSocialSecurityNumber will be returned in the API response if detected.

Also returned with domain=phi.

fr

France tax identification number (Numéro SPI)

To get this entity category, add FRTaxIdentificationNumber to the pii-categories parameter. FRTaxIdentificationNumber will be returned in the API response if detected.

fr

France Value Added Tax (VAT) number

To get this entity category, add FRValueAddedTaxNumber to the pii-categories parameter. FRValueAddedTaxNumber will be returned in the API response if detected.

fr

Germany

Entity

German Driver's License Number

Details

To get this entity category, add DEDriversLicenseNumber to the pii-categories parameter. DEDriversLicenseNumber will be returned in the API response if detected.

Also returned with domain=phi.

Supported document languages

de

Germany Identity Card Number

To get this entity category, add DEIdentityCardNumber to the pii-categories parameter. DEIdentityCardNumber will be returned in the API response if detected.

Also returned with domain=phi.

de

Germany passport number

To get this entity category, add DEPassportNumber to the pii-categories parameter. DEPassportNumber will be returned in the API response if detected.

de

Germany Tax Identification Number

To get this entity category, add DETaxIdentificationNumber to the pii-categories parameter. DETaxIdentificationNumber will be returned in the API response if detected.

de

Germany Value Added Tax Number

Details

To get this entity category, add DEValueAddedNumber to the pii-categories parameter. DEValueAddedNumber will be returned in the API response if detected.

de

Hong Kong

Entity

Hong Kong Identity Card (HKID) Number

Details

To get this entity category, add HKIdentityCardNumber to the pii-categories parameter. HKIdentityCardNumber will be returned in the API response if detected.

Also returned with domain=phi.

Supported document languages

en

Hungary

Entity

Hungary Personal Identification Number

Details

To get this entity category, add HUPersonalIdentificationNumber to the pii-categories parameter. HUPersonalIdentificationNumber will be returned in the API response if detected.

Supported document languages

en

Hungary Tax identification Number

To get this entity category, add HUTaxIdentificationNumber to the pii-categories parameter. HUTaxIdentificationNumber will be returned in the API response if detected.

en

Hungary Value Added Tax Number

To get this entity category, add HUValueAddedNumber to the pii-categories parameter. HUValueAddedNumber will be returned in the API response if detected.

en

India

Entity

India Permanent Account Number (PAN)

Details

To get this entity category, add INPermanentAccount to the pii-categories parameter. INPermanentAccount will be returned in the API response if detected.

Also returned with domain=phi.

Supported document languages

en

India Unique Identification (Aadhaar) Number

Details

To get this entity category, add INUniqueIdentificationNumber to the pii-categories parameter. INUniqueIdentificationNumber will be returned in the API response if detected.

Also returned with domain=phi.

en

Indonesia

Entity

Indonesia Identity Card (KTP) Number

Details

To get this entity category, add IDIdentityCardNumber to the pii-categories parameter. IDIdentityCardNumber will be returned in the API response if detected.

Also returned with domain=phi.

Supported document languages

en

Ireland

Entity

Ireland Personal Public Service (PPS) Number

Details

To get this entity category, add IEPersonalPublicServiceNumber to the pii-categories parameter. IEPersonalPublicServiceNumber will be returned in the API response if detected.

Also returned with domain=phi.

Supported document languages

en

Ireland Personal Public Service (PPS) Number v2

To get this entity category, add IEPersonalPublicServiceNumberV2 to the pii-categories parameter. IEPersonalPublicServiceNumberV2 will be returned in the API response if detected.

Supported document languages

en

Israel

Entity

Israel National ID

Details

To get this entity category, add ILNationalID to the pii-categories parameter. ILNationalID will be returned in the API response if detected.

Supported document languages

en

Israel Bank Account Number

To get this entity category, add ILBankAccountNumber to the pii-categories parameter. ILBankAccountNumber will be returned in the API response if detected.

Also returned with domain=phi.

en

Italy

Entity

Italy Driver's License ID

Details

To get this entity category, add ITDriversLicenseNumber to the pii-categories parameter. ITDriversLicenseNumber will be returned in the API response if detected.

Also returned with domain=phi.

Supported document languages

it

Italy Fiscal Code

To get this entity category, add ITFiscalCode to the pii-categories parameter. ITFiscalCode will be returned in the API response if detected.

it

Italy Value Added Tax Number

To get this entity category, add ITValueAddedTaxNumber to the pii-categories parameter. ITValueAddedTaxNumber will be returned in the API response if detected.

it

Japan

Entity

Japan Bank Account Number

Details

To get this entity category, add JPBankAccountNumber to the pii-categories parameter. JPBankAccountNumber will be returned in the API response if detected.

Also returned with domain=phi.

Supported document languages

ja

Japan Driver's License Number

To get this entity category, add JPDriversLicenseNumber to the pii-categories parameter. JPDriversLicenseNumber will be returned in the API response if detected.

Also returned with domain=phi.

ja

Japan "My Number" (personal)

To get this entity category, add JPMyNumberPersonal to the pii-categories parameter. JPMyNumberPersonal will be returned in the API response if detected.

ja

Japan "My Number" (Corporate)

To get this entity category, add JPMyNumberCorporate to the pii-categories parameter. JPMyNumberCorporate will be returned in the API response if detected.

ja

Japan Resident Registration Number

To get this entity category, add ITValueAddedTaxNumber to the pii-categories parameter. ITValueAddedTaxNumber will be returned in the API response if detected.

Also returned with domain=phi.

ja

Japan Residence Card Number

To get this entity category, add JPResidenceCardNumber to the pii-categories parameter. JPResidenceCardNumber will be returned in the API response if detected.

Also returned with domain=phi.

ja

Japan Social Insurance Number (SIN)

To get this entity category, add JPSocialInsuranceNumber to the pii-categories parameter. JPSocialInsuranceNumber will be returned in the API response if detected.

Also returned with domain=phi.

ja

Japan Passport Number

To get this entity category, add JPPassportNumber to the pii-categories parameter. JPPassportNumber will be returned in the API response if detected.

ja

Luxembourg

Entity

Luxembourg National Identification Number (Natural persons)

Details

To get this entity category, add LUNationalIdentificationNumberNatural to the pii-categories parameter. LUNationalIdentificationNumberNatural will be returned in the API response if detected.

Supported document languages

fr, de

Luxembourg National Identification Number (Non-natural persons)

To get this entity category, add LUNationalIdentificationNumberNonNatural to the pii-categories parameter. LUNationalIdentificationNumberNonNatural will be returned in the API response if detected.

fr, de

Malta

Entity

Malta Identity Card Number

Details

To get this entity category, add MTIdentityCardNumber to the pii-categories parameter. MTIdentityCardNumber will be returned in the API response if detected.

Supported document languages

en

Malta Tax Identification Number

To get this entity category, add MTTaxIDNumber to the pii-categories parameter. MTTaxIDNumber will be returned in the API response if detected.

en

New Zealand

Entity

New Zealand Bank Account Number

Details

To get this entity category, add NZBankAccountNumber to the pii-categories parameter. NZBankAccountNumber will be returned in the API response if detected.

Supported document languages

en

New Zealand Driver's License Number

To get this entity category, add NZDriversLicenseNumber to the pii-categories parameter. NZDriversLicenseNumber will be returned in the API response if detected.

en

New Zealand Inland Revenue Number

To get this entity category, add NZInlandRevenueNumber to the pii-categories parameter. NZInlandRevenueNumber will be returned in the API response if detected.

en

New Zealand Ministry of Health Number

To get this entity category, add NZMinistryOfHealthNumber to the pii-categories parameter. NZMinistryOfHealthNumber will be returned in the API response if detected.

Also returned with domain=phi.

en

New Zealand Social Welfare Number

To get this entity category, add NZSocialWelfareNumber to the pii-categories parameter. NZSocialWelfareNumber will be returned in the API response if detected.

en

Philippines

Entity

Philippines Unified Multi-Purpose ID Number

Details

To get this entity category, add PHUnifiedMultiPurposeIDNumber to the pii-categories parameter. PHUnifiedMultiPurposeIDNumber will be returned in the API response if detected.

Also returned with domain=phi.

Supported document languages

en

Portugal

Entity

Portugal Citizen Card Number

Details

To get this entity category, add PTCitizenCardNumber to the pii-categories parameter. PTCitizenCardNumber will be returned in the API response if detected.

Also returned with domain=phi.

Supported document languages

pt-pt

Portugal Tax Identification Number

To get this entity category, add PTTaxIdentificationNumber to the pii-categories parameter. PTTaxIdentificationNumber will be returned in the API response if detected.

Also returned with domain=phi.

pt-pt

Singapore

Entity

Singapore National Registration ID Card (NRIC) Number

Details

To get this entity category, add PTTaxIdentificationNumber to the pii-categories parameter. PTTaxIdentificationNumber will be returned in the API response if detected.

Supported document languages

en, zh-hans

South Africa

Entity

South Africa Identification Number

Details

To get this entity category, add ZAIdentificationNumber to the pii-categories parameter. ZAIdentificationNumber will be returned in the API response if detected.

Also returned with domain=phi.

Supported document languages

en

South Korea

Entity

South Korea Resident Registration Number

Details

To get this entity category, add KRResidentRegistrationNumber to the pii-categories parameter. KRResidentRegistrationNumber will be returned in the API response if detected.

Also returned with domain=phi.

Supported document languages

ko

Spain

Entity

Spain DNI

Details

To get this entity category, add ESDNI to the pii-categories parameter. ESDNI will be returned in the API response if detected.

Supported document languages

es

Spain Social Security Number (SSN)

To get this entity category, add ESSocialSecurityNumber to the pii-categories parameter. ESSocialSecurityNumber will be returned in the API response if detected.

Also returned with domain=phi.

es

Spain Tax Identification Number

To get this entity category, add ESTaxIdentificationNumber to the pii-categories parameter. ESTaxIdentificationNumber will be returned in the API response if detected.

es

Switzerland

Entity

Swiss Social Security Number AHV

Details

To get this entity category, add CHSocialSecurityNumber to the pii-categories parameter. CHSocialSecurityNumber will be returned in the API response if detected.

Supported document languages

fr, de, it

Taiwan

Entity

Taiwan National ID

Details

To get this entity category, add TWNationalID to the pii-categories parameter. TWNationalID will be returned in the API response if detected.

Also returned with domain=phi.

Supported document languages

en

Taiwan Resident Certificate (ARC/TARC)

To get this entity category, add TWResidentCertificate to the pii-categories parameter. TWResidentCertificate will be returned in the API response if detected.

Also returned with domain=phi.

en

Taiwan Passport Number

To get this entity category, add TWPassportNumber to the pii-categories parameter. TWPassportNumber will be returned in the API response if detected.

en

United Kingdom

Entity

U.K. Driver's License Number

Details

To get this entity category, add UKDriversLicenseNumber to the pii-categories parameter. UKDriversLicenseNumber will be returned in the API response if detected.

Also returned with domain=phi.

Supported document languages

en

U.K. Electoral Roll Number

To get this entity category, add UKNationalInsuranceNumber to the pii-categories parameter. UKNationalInsuranceNumber will be returned in the API response if detected.

Also returned with domain=phi.

en

U.K. National Health Service (NHS) Number

To get this entity category, add UKNationalHealthNumber to the pii-categories parameter. UKNationalHealthNumber will be returned in the API response if detected.

Also returned with domain=phi.

en

U.K. National Insurance Number (NINO)

To get this entity category, add UKNationalInsuranceNumber to the pii-categories parameter. UKNationalInsuranceNumber will be returned in the API response if detected.

Also returned with domain=phi.

en

U.K. or U.S. Passport Number

To get this entity category, add USUKPassportNumber to the pii-categories parameter. USUKPassportNumber will be returned in the API response if detected.

en

U.K. Unique Taxpayer Reference Number

To get this entity category, add UKUniqueTaxpayerNumber to the pii-categories parameter. UKUniqueTaxpayerNumber will be returned in the API response if detected.

en

United States

Entity

U.S. Social Security Number (SSN)

Details

To get this entity category, add USSocialSecurityNumber to the pii-categories parameter. USSocialSecurityNumber will be returned in the API response if detected.

Also returned with domain=phi.

Supported document languages

en

U.S. Driver's License Number

To get this entity category, add USDriversLicenseNumber to the pii-categories parameter. USDriversLicenseNumber will be returned in the API response if detected.

Also returned with domain=phi.

en

U.S. or U.K. Passport Number

To get this entity category, add USUKPassportNumber to the pii-categories parameter. USUKPassportNumber will be returned in the API response if detected.

en

U.S. Individual Taxpayer Identification Number (ITIN)

To get this entity category, add USIndividualTaxpayerIdentification to the pii-categories parameter. USIndividualTaxpayerIdentification will be returned in the API response if detected.

en

U.S. Drug Enforcement Agency (DEA) Number

To get this entity category, add DrugEnforcementAgencyNumber to the pii-categories parameter. DrugEnforcementAgencyNumber will be returned in the API response if detected.

Also returned with domain=phi.

en

U.S. Bank Account Number

To get this entity category, add USBankAccountNumber to the pii-categories parameter. USBankAccountNumber will be returned in the API response if detected.

Also returned with domain=phi.

en

Next steps

• NER overview