The Umbrella User Guide Developer Hub

Welcome to the Umbrella User Guide developer hub. You'll find comprehensive guides and documentation to help you start working with Umbrella User Guide as quickly as possible, as well as support if you get stuck. Let's jump right in!

Get Started    

Built-In Data Identifiers

The built-in data identifiers match specific personal identification information. Add identifiers to a classification to monitor personal identification information in content for data protection rules. For more information, see Add a Classification.

All identifiers must match with a keyword, a specific pattern, or a specific pattern that must be found within 9 terms of at least one keyword or keyword phrase.

Tolerance

Identifiers with an asterisk (*) are available in three different levels of tolerance: lenient, moderate, and strict. Tolerance dictates how accurate a match is made when searching for identifiers in content. For example, a credit card number identifier might be lenient if it only looks for a specific arrangement of numbers, but a moderate identifier might look for the arrangement of numbers within proximity of keywords.

Table of Contents

Australia Identifiers

All Australia identifiers match a specific pattern that must be found within 9 terms of at least one keyword or keyword phrase relative to that identifier.

Bank Account Number (Australia)

An 8-digit Australian bank account number and 3-digit bank state branch number.

Driver's License Number (Australia)

A 9-digit driver’s license number issued by Australia.

Passport Number (Australia)

A 7-digit passport number issued by the Australian government.

Multiple Personal Identifiers – PII (Australia)

Combines a person's name (Australia) with two or more of the following identifiers:

  • Australia Bank Account
  • Australia Driver's License Number
  • Australia Passport Number
  • Australia Tax File Number
  • Credit Card Number
  • Date of Birth
    The tolerance level of the identifier determines the number of matches detected:
    • Lenient (default): One person name + two or more other identifiers
    • Moderate: Three person names + six or more other identifiers
    • Strict: Five person names + ten or more other identifiers

Tax File Number (Australia)

A 9-digit number issued by the Australian Taxation Office (ATO) to identify an individual or organization for tax purposes.

Canada Identifiers

All Canada identifiers match a specific pattern that must be found within 9 terms of at least one keyword or keyword phrase relative to that identifier.

Bank Account Number (Canada)

A 5 and 3-digit bank account number and transit number issued in Canada.

Passport Number (Canada)

A 2-letter and 6-digit passport number issued by the government of Canada.

Personal Health Identification Number – PHIN (Canada)

A 9-digit national insurance number issued by the government of Canada.

Social Insurance Number – SIN (Canada)

A 9-digit identification number issued to individuals who work or receive benefits in Canada.

Credit Card Number

Numbers identified as potentially valid payment cards using the Luhn algorithm.
The tolerance level of the identifier determines the number of matches detected:

  • Lenient: No proximity requirement and common patterns are accepted.
  • Moderate: The same as lenient tolerance but the common patterns are accepted for specific card issuers JCB, VISA, MasterCard, and Discover. Some numbers are excluded as they are not in general use.
  • Strict (default): The same as moderate tolerance and a list of proximity keywords that must be within 10 terms of the credit card number.

Date of Birth

Matches dates identified as potential birth dates based on a 2-digit, 2-digit, and 4-digit pattern and keywords or phrases within 9 terms.

Education Identifiers

Aggressive Behavior

Matches on keywords and phrases of language suggestive of aggressive intent.

Discriminatory Content

Matches on keywords and phrases of language deemed homophobic or racist to be monitored for compliance with the Children's Internet Protection Act (CIPA).

Extreme Inappropriate Language

Matches on keywords and phrases of language deemed extremely inappropriate to be monitored for compliance with the Children's Internet Protection Act (CIPA).

Family Educational Right and Privacy Act – FERPA

FERPA protects the release of and access to records directly related to students. Matches on keywords and phrases of potential FERPA-protected content such as transcripts, disciplinary records, tuition bills, and student IDs.

Individual Education Plan – IEP

Matches on keywords and phrases of IEPs which contain sensitive information. Must contain a US person's name in addition to the keyword or keyword phrase.

Objectionable Content

Matches on keywords and phrases of language considered offensive.

Self-Harm Content

Matches on keywords and phrases of language suggestive of inflicting self-harm.

Student Loan Application (US)

Personal finance information held by organizations for student loans, credit, and financial aid.

Email Address

Identifies a pattern of possible email addresses with varying formats of letters followed by @, a variety of characters, and the TLD (for example, .com, .net, .org, and so on).

France Identifiers

All France identifiers match a specific pattern that must be found within 9 terms of at least one keyword or keyword phrase relative to that identifier.

Carte national d'identité sécurisée – CNIS (France)

The 12-digit French national identity card number which is used for travel and verification of French nationality.

Driver's License Number (France)

A 12-digit driver’s license number issued by France.

Passport Number (France)

A 9-digit alphanumeric passport number issued by the government of France.

Social Security Number – INSEE (France)

National identification numbers for The National Institute of Statistics and Economic Studies issued at birth to French nationals. The number can be 12 or 15 digits.

Government Identifiers

All Government identifiers match a specific pattern that must be found within 9 terms of at least one keyword or keyword phrase relative to that identifier.

Bank Account number (Israel)

A 13-digit bank account number identifying financial accounts within Israel.

Citizen Card Number — CC (Portugal)

A Citizen's Card number issued to all Portuguese citizens. The number is 12 alphanumeric digits.

Driver's License number (Italy)

A 10-digit alphanumeric driver’s license number issued by Italy.

Fiscal Identification Number – Número de identificación – NIF (Spain)

A 9-digit alphanumeric identity number issued to Spanish nationals.

Identity Card Number (Germany)

A 9-digit alphanumeric personal identification number issued to German citizens.
Note: This identifier currently does not match on the characters ö or ä.

International Bank Account Number – IBAN (Spain)

Identifies the standard Spanish IBAN of 24 alphanumeric characters.

National Identity Number – DNI (Argentina)

An 8-digit national documentation number assigned at birth to natural-born citizens and immigrants.

National Identity Number – OIB (Croatia)

A 9-digit number issued in Croatia to certify individual identity.

National Identity Number (Greece)

An 8-digit alphanumeric number issued by the Hellenic Republic to certify individual identity.

National Identity Number – KTP (Indonesia)

A 16-digit number issued by Indonesia to certify individual identity.

National Identity Number (Israel)

An 9-digit Identity Number issued to Israeli citizens at birth and temporary residents upon resident status.

National Identity Number (Malaysia)

A 12-digit number issued in Malaysia to certify individual identity.

National Identity Number (Philippines)

A 12-digit number issued in the Philippines to certify individual identity.

National Identity Number (Saudi Arabia)

A 10-digit number issued in Saudi Arabia to certify individual identity.

Passport number (Finland)

A 9-digit alphanumeric passport number issued by the government of Finland.

Passport Number (Sweden)

An 8-digit passport number issued by the government of Sweden.

Passport Number (Taiwan)

A 10-digit passport number issued by the Republic of China (Taiwan) to certify individual identity.

Resident Certificate Number – ARC or TARC (Taiwan)

A number issued to individuals in Taiwan to certify residency.

Healthcare Identifiers

Credit Card Number and Drug Name

A credit card number within 30 terms of a drug name. The credit card number must be within 9 terms of the keyword "ccn" (case insensitive).

Credit Card Number and Health Condition

A credit card number within 30 terms of a health condition. The credit card number must be within 9 terms of the keyword "ccn" (not case sensitive).

Drug Name and Person Name (US)

A US person's name within 30 terms of a drug name.

Drug Name and Social Security Number (US)

A US social security number within 30 terms of a drug name. The social security number must be within 9 terms of the keyword "ssn" (not case sensitive).

Health Condition and Person Name (US)

A US person's name within 30 terms of a health condition.

Health Condition and Social Security Number (US)

A US social security number within 30 terms of a health condition. The social security number must be within 9 terms of the keyword "ssn" (not case sensitive).

ICD Code

The International Statistical Classification of Diseases and Related Health Problems (ICD) is a classification list compiled by the World Health Organization (WHO) for the purpose of coding diseases, signs and symptoms, abnormal findings, complaints, social circumstances, and external causes of injury or diseases. This matches a pattern from content in the 10th revision of ICD.

ICD Code and Person Name (US)

A US person's name within 30 terms of an ICD-10 code.

ICD Code and Social Security Number (US)

A US social security number within 30 terms of an ICD-10 code. The social security number must be within 9 terms of the keyword "ssn" (not case sensitive).

Medical Prescriptions

Matches a pattern and keywords relevant to a drug prescription, such as drug name, person name, and dosage information.

National Drug Code Number

Identifies segments of the National Drug Code (NDC), which is used in the United States to identify drugs for human use.

Japan Identifiers

All Japan identifiers match a specific pattern that must be found within 9 terms of at least one keyword or keyword phrase relative to that identifier.

Bank Account Number (Japan)

An 8-digit bank account number or a 4-digit account number with a 3-digit branch number issued in Japan.

Driver's License Number (Japan)

A 12-digit driver’s license number issued in Japan.

My Number (Japan)

A 12-digit individual number issued to citizens and residents of Japan since 2015.

Passport Number (Japan)

A 9-digit alphanumeric passport number issued by the government of Japan.

Resident Registration Number (Japan)

An 11-digit identification number issued to foreigners residing in Japan.

Social Insurance Number (Japan)

A 12-digit number issued to all registered residents of Japan to enroll in one of the appropriate social health care and pension insurance systems.

IP Address

Identifies IPv4 addresses from a pattern.

SWIFT Code

Matches an alphanumeric pattern used internationally for the transfer of funds within 9 terms of a keyword or phrase.

Multiple Personal Identifiers – PII (European Union)

Matches personal identifiers from the twenty-six countries of the European Union. The combined identifier monitors individual common identifiers associated with GDPR to better assist customers with compliance in their own organizations. Individual countries cannot be selected or exempted from the identifier; all countries within the EU are included in the identifier.

individual identifiers included:

Country
Person Name
Driver's License Number
IBAN
License Plate Number
Passport Number
Phone number
VAT ID Number
TAX ID Number
National ID

Austria

Yes

Yes

Yes

Yes

Yes

Yes

Yes

Social Security Number

Belgium

Yes

Yes

Yes

Yes

Yes

Yes

Yes

Yes

National Register Number

Bulgaria

Yes

Yes

Yes

Yes

Yes

Yes

Uniform Civil Number (EGN)

Croatia

Yes

Yes

Yes

Yes

Yes

Yes

Personal Identification Number (OIB)

Republic of Cyprus

Yes

Yes

Yes

Yes

Yes

Yes

Yes

Czech Republic

Yes

Yes

Yes

Yes

Yes

Yes

Yes

Birth Number

Denmark

Yes

Yes

Yes

Yes

Yes

Yes

Personal Identification Number

Estonia

Yes

Yes

Yes

Yes

Yes

Yes

Personal Identification Code (IK)

Finland

Yes

Yes

Yes

Yes

Yes

Yes

Personal Identity Code (HETU)

France

Yes

Yes

Yes

Yes

Yes

Yes

Yes

Yes

INSEE
Health Insurance Number
Social Security Number

Germany

Yes

Yes

Yes

Yes

Yes

Yes

Yes

Yes

Personal ID Number

Greece

Yes

Yes

Yes

Yes

Yes

Yes

Social Security Number (AMKA)

Hungary

Yes

Yes

Yes

Yes

Yes

Yes

Personal ID Number
Social Security Number

Ireland

Yes

Yes

Yes

Yes

Yes

Yes

Personal Public Service Number

Italy

Yes

Yes

Yes

Yes

Yes

Yes

Yes

Yes

Fiscal Code

Latvia

Yes

Yes

Yes

Yes

Yes

Yes

Personal Code

Lithuania

Yes

Yes

Yes

Yes

Yes

Yes

Yes

Personal Code

Luxembourg

Yes

Yes

Yes

Yes

Yes

Yes

National Register Number

Malta

Yes

Yes

Yes

Yes

Yes

Yes

Yes

Netherlands

Yes

Yes

Yes

Yes

Yes

Yes

Yes

Yes

Burgerservicenummer

Poland

Yes

Yes

Yes

Yes

Yes

Yes

PESEL
Social Security Number

Portugal

Yes

Yes

Yes

Yes

Yes

Yes

Yes

Citizen Card Number

Romania

Yes

Yes

Yes

Yes

Yes

Yes

Yes

Personal Numerical Code (CNP)

Slovakia

Yes

Yes

Yes

Yes

Yes

Yes

Yes

Birth Number

Slovenia

Yes

Yes

Yes

Yes

Yes

Yes

Yes

Yes

National ID Number

Spain

Yes

Yes

Yes

Yes

Yes

Yes

Yes

Yes

National Identity Card Number (DNI)
Social Security Number

Sweden

Yes

Yes

Yes

Yes

Yes

Yes

Yes

Personal ID Number

United Kingdom Identifiers

All UK identifiers match a specific pattern that must be found within 9 terms of at least one keyword or keyword phrase relative to that identifier.

International Bank Account Number – IBAN (UK)

A 22-digit alphanumeric international bank account number for the UK.

Multiple Personal Identifiers – PII (UK)

Person Name or National Insurance Number (NINO) with two or more of the following identifiers:

  • UK Driver's License Number
  • UK Passport Number
  • UK Bank Account Number
  • UK Postcode
  • UK IBAN
  • Date of Birth
  • Credit Card Number
    The number of matches required depends on the tolerance of the policy:
    • Lenient (default): One person name or NINO and two or more other identifiers required
    • Moderate: Three person names or NINOs and six or more other identifiers
    • Strict: Five person names or NINOs and 10 or more other identifiers

National Insurance Number – NINO (UK)

A 9-digit alphanumeric identification number issued to individuals by the United Kingdom Department for Work and Pensions.

Passport Number (UK)

An identification number serves as proof of nationality or immigration status within the United Kingdom.

Postcode (UK)

Identifies the 6-digit alphanumeric UK postal code.

United States Identifiers

All US identifiers match a specific pattern that must be found within 9 terms of at least one keyword or keyword phrase relative to that identifier.

ABA Routing Number (US)

A 9-digit number used by banks to identify specific financial institutions within the United States.

Bank Account Number (US)

A 5-digit bank account number issued in the United States.

Driver's License (US)

The identification number on a US driver's license, varying by state.

Date of Birth and Person Name (US)

A US person's name within X terms of date of birth.

Individual Tax Identification Number – ITIN (US)

A 9-digit United States tax processing number issued by the Internal Revenue Service (IRS).

Multiple Personal Identifiers – PII (US)

A US person's name with two or more of the following identifiers:

  • US Bank Account Number
  • US Driver's License Number
  • US Passport Number
  • US Social Security Number
  • Credit Card Number
  • Date of Birth
    The number of matches required depends on the tolerance of the policy:
    • Lenient (default): One person name and two or more other identifiers required
    • Moderate: Three person names and six or more other identifiers
    • Strict: Five person names and 10 or more other identifiers

Passport Number (US)

An identification number issued to citizens and non-citizen nationals of the United States.

Social Security Number (US)

An identification number issued in the United States to citizens, permanent residents, and temporary working residents.

The tolerance level of the identifier determines the number of matches detected:

  • Lenient (default): Matches a 9-digit number following the social security pattern (3 digits + 2 digits + 4 digits), where digit groups are separated by a space, no space, or specific characters.
  • Moderate: Same as lenient tolerance but digit groups are separated by space or specific characters.
  • Strict: Same as moderate tolerance but the number must be within 10 terms of a list of keywords.

Exact Data Match Field Types < Built-in Data Identifiers > Exact Data Match Data Indexer

Updated a day ago

Built-In Data Identifiers


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.