Additional information and configuration for working with the features.
This is the multi-page printable view of this section. Click here to print.
Additional Information
Configuration and usage details.
1 - Policy Definition
Policy configuration used by the AI Developer Edition API Service.
The superuser has all permissions, that is, protect, unprotect, and reprotect operations. Users assigned the admin role will receive protected data when performing an unprotect operation, except in the case of the text data elements, which will return null. All other user roles will receive null as the output for any unprotect operation.
Generic Data Elements
| Data Element | Method | Use Case | UTF Set | LP | PP | eIV | Role | |||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Admin | Finance | Marketing | HR | |||||||||||
| P | U | P | U | P | U | P | U | |||||||
| datetime | Tokenization | A date or datetime string. Formats accepted: YYYY/MM/DD HH:MM:SS and YYYY/MM/DD. Delimiters accepted: /, - This data element is required. | N/A | N/A | N/A | No | ✓ | X | X | X | X | ✓ | X | X |
| datetime_yc | Tokenization | A date or datetime string. Formats accepted: YYYY/MM/DD HH:MM:SS and YYYY/MM/DD. Delimiters accepted: /, - This data element is required. Leaves the year in the clear. | N/A | N/A | N/A | No | ✓ | X | X | X | X | ✓ | X | X |
| int | Tokenization | An integer string (4 bytes). | Numeric | No | No | Yes | ✓ | X | X | X | X | ✓ | X | X |
| number | Tokenization | A numeric string. May produce leading zeroes. | Numeric | Yes | No | Yes | ✓ | X | X | X | X | ✓ | X | X |
| string | Tokenization | An alphanumeric string. | Latin + Numeric | Yes | No | Yes | ✓ | X | X | X | X | ✓ | X | X |
| text | Encryption | A long string, such as a comment field using any character set. Use hex or base64 encoding to utilize. | All | No | No | Yes | ✓ | X | X | X | X | ✓ | X | X |
| fpe_numeric | FPE (Format Preserving Encryption) | Encrypts numeric data using FPE NIST 800-38G standard. Preserves length and uses Numeric (0-9) as plaintext and ciphertext alphabet. | Numeric | Yes | Yes | Yes | ✓ | X | X | X | X | ✓ | X | X |
| fpe_alpha | FPE (Format Preserving Encryption) | Encrypts alphabetic data using FPE NIST 800-38G standard. Preserves length and uses Alpha (a-z, A-Z) as plaintext and ciphertext alphabet. | Alpha | Yes | Yes | Yes | ✓ | X | X | X | X | ✓ | X | X |
| fpe_alphanumeric | FPE (Format Preserving Encryption) | Encrypts alphanumeric data using FPE NIST 800-38G standard. Preserves length and uses Alpha-Numeric (0-9, a-z, A-Z) as plaintext and ciphertext alphabet. | Alpha-Numeric | Yes | Yes | Yes | ✓ | X | X | X | X | ✓ | X | X |
| fpe_latin1_alpha | FPE (Format Preserving Encryption) | Encrypts alphabetic data using FPE NIST 800-38G standard. Preserves length and uses Unicode, such as Basic Latin and Latin-1 Supplement Alpha as plaintext and ciphertext alphabet. | Unicode (Basic Latin + Latin-1 Supplement Alpha) | Yes | Yes | Yes | ✓ | X | X | X | X | ✓ | X | X |
| fpe_latin1_alphanumeric | FPE (Format Preserving Encryption) | Encrypts alphanumeric data using FPE NIST 800-38G standard. Preserves length and uses Unicode, such as Basic Latin and Latin-1 Supplement Alpha-Numeric as plaintext and ciphertext alphabet. | Unicode (Basic Latin + Latin-1 Supplement Alpha-Numeric) | Yes | Yes | Yes | ✓ | X | X | X | X | ✓ | X | X |
| mask | Masking | Mask all the characters in the input; output is configured as the mask. It is set to "mask". | N/A | N/A | N/A | N/A | ✓ | X | X | X | X | ✓ | X | X |
| no_encryption | No Encryption | No encryption applied to the data element. | N/A | N/A | N/A | N/A | ✓ | X | X | X | X | ✓ | X | X |
| short | Tokenization | Protect or unprotect a 2-byte integer string. | Numeric | Yes | Yes | Yes | ✓ | X | X | X | X | ✓ | X | X |
| long | Tokenization | Protect or unprotect an 8-byte integer string. | Numeric | Yes | Yes | Yes | ✓ | X | X | X | X | ✓ | X | X |
PCI DSS Data Elements
| Data Element | Method | Use Case | UTF Set | LP | PP | eIV | Role | |||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Admin | Finance | Marketing | HR | |||||||||||
| P | U | P | U | P | U | P | U | |||||||
| ccn | Tokenization | Credit card numbers. | Numeric | No | No | Yes | ✓ | X | X | ✓ | X | X | X | ✓ |
| ccn_bin | Tokenization | Credit card numbers. Leaves 8-digit BIN in the clear. | Numeric | No | No | Yes | ✓ | X | X | ✓ | X | X | X | ✓ |
| iban | Tokenization | IBAN numbers. Preserves the length, case, and position of the input characters but may create invalid IBAN codes. | Latin + Numeric | Yes | Yes | No | ✓ | X | X | ✓ | X | X | X | ✓ |
| iban_cc | Tokenization | IBAN numbers. Leaves letters in the clear. | Latin + Numeric | No | No | Yes | ✓ | X | X | ✓ | X | X | X | ✓ |
Generic PII Data Elements
| Data Element | Method | Use Case | UTF Set | LP | PP | eIV | Role | |||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Admin | Finance | Marketing | HR | |||||||||||
| P | U | P | U | P | U | P | U | |||||||
| address | Tokenization | Street names | Latin + Numeric | Yes | No | Yes | ✓ | X | X | ✓ | X | X | X | ✓ |
| city | Tokenization | Town or city name | Latin | Yes | No | Yes | ✓ | X | X | ✓ | X | ✓ | X | ✓ |
| Tokenization | Email address. Leaves the domain in the clear. | Latin + Numeric | Yes | No | Yes | ✓ | X | X | ✓ | X | ✓ | X | ✓ | |
| nin | Tokenization | National Insurance Number. Preserves the length, case, and position of the input characters but may create invalid NIN codes. | Latin + Numeric | Yes | Yes | No | ✓ | X | X | X | X | X | X | X |
| name | Tokenization | Person's name | Latin | Yes | No | Yes | ✓ | X | X | ✓ | X | ✓ | X | ✓ |
| passport | Tokenization | Passport codes. Preserves the length, case, and position of the input characters but may create invalid passport numbers. | Latin + Numeric | Yes | Yes | No | ✓ | X | X | X | X | X | X | X |
| phone | Tokenization | Phone number. May produce leading zeroes. | Latin + Numeric | Yes | No | Yes | ✓ | X | X | X | X | X | X | X |
| postcode | Tokenization | Postal codes with digits and characters. Preserves the length, case, and position of the input characters but may create invalid post codes. | Latin + numeric | Yes | Yes | No | ✓ | X | X | ✓ | X | ✓ | X | ✓ |
| ssn | Tokenization | Social Security Number (US) | Latin + Numeric | Yes | No | Yes | ✓ | X | X | X | X | X | X | X |
| zipcode | Tokenization | Zip codes with digits only. May produce leading zeroes. | Numeric | Yes | No | Yes | ✓ | X | X | ✓ | X | ✓ | X | ✓ |
PII Data Elements
| Data Element | Method | Use Case | UTF Set | LP | PP | eIV | Role | |||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Admin | Finance | Marketing | HR | |||||||||||
| P | U | P | U | P | U | P | U | |||||||
| address_de | Tokenization | Street names (German) | Latin + German + Numeric | Yes | No | Yes | ✓ | X | X | ✓ | X | X | X | ✓ |
| address_fr | Tokenization | Street names (French) | Latin + French + Numeric | Yes | No | Yes | ✓ | X | X | ✓ | X | X | X | ✓ |
| city_de | Tokenization | Town or city name (German) | Latin + German | Yes | No | Yes | ✓ | X | X | ✓ | X | ✓ | X | ✓ |
| city_fr | Tokenization | Town or city name (French) | Latin + French | Yes | No | Yes | ✓ | X | X | ✓ | X | ✓ | X | ✓ |
| name_de | Tokenization | Person's name (German) | Latin + German | Yes | No | Yes | ✓ | X | X | ✓ | X | ✓ | X | ✓ |
| name_fr | Tokenization | Person's name (French) | Latin + French | Yes | No | Yes | ✓ | X | X | ✓ | X | ✓ | X | ✓ |
LEGEND
- eIV: External IV
- LP: Length Preservation
- PP: Position Preservation
- P: User group can protect data
- U: User group can unprotect data
2 - Supported Classification Entities
A list of the entities classified by Data Discovery.
Supported Entity Types
PII entities supported by Data Discovery with their Harmonized Categories, mapped to the expected Data Element.
| Harmonized Category | Entity Name | Data Element | Description |
|---|---|---|---|
| ACCOUNT_NAME | ACCOUNTNAME | string | Name associated with a financial account. |
| ACCOUNT_NUMBER | ACCOUNTNUMBER | number | Bank account number used to identify financial accounts. |
| AGE | AGE | number | Age information used to identify individuals. |
| AMOUNT | AMOUNT | number | Specific amount of money, which can be linked to financial transactions. |
| BANK_ACCOUNT | BIC | number | Bank Identifier Code used to identify financial institutions. |
| BANK_ACCOUNT | IBAN | iban | International Bank Account Number used to identify bank accounts globally. |
| BANK_ACCOUNT | IBAN_CODE | iban | International Bank Account Number used to identify bank accounts globally. |
| BANK_ACCOUNT | US_BANK_NUMBER | number | Bank account number used to identify financial accounts in the United States. |
| CREDIT_CARD | CCN | ccn | Credit card number used for financial transactions. |
| CREDIT_CARD | CREDIT_CARD | ccn | Credit card number used for financial transactions. |
| CRYPTO_ADDRESS | BITCOINADDRESS | address | Bitcoin wallet address used for digital transactions. |
| CRYPTO_ADDRESS | CRYPTO | address | Cryptocurrency wallet address used for digital transactions. |
| CRYPTO_ADDRESS | ETHEREUMADDRESS | address | Ethereum wallet address used for digital transactions. |
| CRYPTO_ADDRESS | LITECOINADDRESS | address | Litecoin wallet address used for digital transactions. |
| CURRENCY | CURRENCY | string | Currency information used in financial transactions. |
| CURRENCY_CODE | CURRENCYCODE | string | Code representing currency used in financial transactions. |
| CURRENCY_NAME | CURRENCYNAME | string | Name of currency used in financial transactions. |
| CURRENCY_SYMBOL | CURRENCYSYMBOL | string | Symbol representing currency, sometimes linked to financial transactions. |
| DATETIME | DATE | datetime | Specific date that can be linked to personal activities. |
| DATETIME | DATE_TIME | datetime | Specific date and time that can be linked to personal activities. |
| DATETIME | TIME | datetime | Specific time that can be linked to personal activities. |
| DRIVER_LICENSE | DRIVERLICENSE | number | Driver’s license number used to identify individuals. |
| DRIVER_LICENSE | IT_DRIVER_LICENSE | number | Driver’s license number used to identify individuals in Italy. |
| DRIVER_LICENSE | US_DRIVER_LICENSE | number | Driver’s license number used to identify individuals in the United States. |
| EMAIL_ADDRESS | Email address used for communication and identification. | ||
| EMAIL_ADDRESS | EMAIL_ADDRESS | Email address used for communication and identification. | |
| GENDER | GENDER | string | Gender information used to identify individuals. |
| HEALTH_CARE_ID | AU_MEDICARE | number | Medicare number used to identify individuals for healthcare services in Australia. |
| HEALTH_CARE_ID | MEDICAL_LICENSE | number | License number used to identify medical professionals. |
| HEALTH_CARE_ID | UK_NHS | number | National Health Service number used to identify individuals for healthcare services in the United Kingdom. |
| IN_VEHICLE_REGISTRATION | IN_VEHICLE_REGISTRATION | number | Vehicle registration number used to identify vehicles in India. |
| IN_VOTER | IN_VOTER | number | Voter ID number used to identify registered voters in India. |
| IP_ADDRESS | IP | address | Internet Protocol address used to identify devices on a network. |
| IP_ADDRESS | IP_ADDRESS | address | Internet Protocol address used to identify devices on a network. |
| LOCATION | BUILDING | address | Building information used to identify specific locations. |
| LOCATION | CITY | city | City information used to identify geographic locations. |
| LOCATION | COUNTRY | string | Country information used to identify geographic locations. |
| LOCATION | COUNTY | string | County information used to identify geographic locations. |
| LOCATION | GEOCOORD | address | Geographic coordinates used to identify specific locations. |
| LOCATION | LOCATION | address | Specific location or address that can be linked to an individual. |
| LOCATION | SECADDRESS | address | Additional address information used to identify locations. |
| LOCATION | SECONDARYADDRESS | address | Additional address information used to identify locations. |
| LOCATION | STATE | string | State information used to identify geographic locations. |
| LOCATION | STREET | address | Street address used to identify specific locations. |
| LOCATION | ZIPCODE | zipcode | Postal code used to identify specific geographic areas. |
| MAC_ADDRESS | MAC | address | Media Access Control address used to identify devices on a network. |
| NATIONAL_ID | AU_ACN | number | Australian Company Number used to identify businesses in Australia. |
| NATIONAL_ID | ES_NIE | nin | Foreigner Identification Number used to identify non-residents in Spain. |
| NATIONAL_ID | FI_PERSONAL_IDENTITY_CODE | nin | Personal identity code used to identify individuals in Finland. |
| NATIONAL_ID | IDCARD | nin | Identity card number used to identify individuals. |
| NATIONAL_ID | IN_AADHAAR | nin | Unique identification number used to identify residents in India. |
| NATIONAL_ID | IT_IDENTITY_CARD | nin | Identity card number used to identify individuals in Italy. |
| NATIONAL_ID | PL_PESEL | nin | Personal Identification Number used to identify individuals in Poland. |
| NATIONAL_ID | SG_NRIC_FIN | nin | National Registration Identity Card number used to identify residents in Singapore. |
| NATIONAL_ID | SG_UEN | number | Unique Entity Number used to identify businesses in Singapore. |
| NRP | NRP | number | National Registration Number used to identify individuals. |
| ORGANIZATION | COMPANYNAME | string | Name of a company used to identify businesses. |
| PASSPORT | IN_PASSPORT | passport | Passport number used to identify individuals in India. |
| PASSPORT | IT_PASSPORT | passport | Passport number used to identify individuals in Italy. |
| PASSPORT | PASSPORT | passport | Passport number used to identify individuals. |
| PASSPORT | US_PASSPORT | passport | Passport number used to identify individuals in the United States. |
| PASSWORD | CREDITCARDCVV | number | Card Verification Value used to secure credit card transactions. |
| PASSWORD | PASSWORD | string | Password used to secure access to personal accounts. |
| PASSWORD | PIN | number | Personal Identification Number used to secure access to accounts. |
| PERSON | NAME | string | Name or identifier used to identify an individual. |
| PERSON | PERSON | string | Name or identifier used to identify an individual. |
| PHONE_NUMBER | PHONE | phone | Number used to contact or identify an individual. |
| PHONE_NUMBER | PHONE_NUMBER | phone | Number used to contact or identify an individual. |
| SOCIAL_SECURITY_ID | SSN | ssn | Social Security Number used to identify individuals. |
| SOCIAL_SECURITY_ID | UK_NINO | nin | National Insurance Number used to identify individuals in the United Kingdom. |
| SOCIAL_SECURITY_ID | US_SSN | ssn | Social Security Number used to identify individuals in the United States. |
| TAX_ID | AU_ABN | number | Australian Business Number used to identify businesses in Australia. |
| TAX_ID | AU_TFN | number | Tax File Number used to identify taxpayers in Australia. |
| TAX_ID | ES_NIF | number | Tax Identification Number used to identify taxpayers in Spain. |
| TAX_ID | IN_PAN | number | Permanent Account Number used to identify taxpayers in India. |
| TAX_ID | IT_FISCAL_CODE | nin | Fiscal code used to identify taxpayers in Italy. |
| TAX_ID | IT_VAT_CODE | string | VAT code used to identify taxpayers in Italy. |
| TAX_ID | US_ITIN | number | Individual Taxpayer Identification Number used to identify taxpayers in the United States. |
| TITLE | TITLE | string | Title or honorific used to identify individuals. |
| URL | URL | address | Web address that can sometimes contain personal information. |
| USERNAME | USERNAME | string | Username used to identify individuals in online systems. |
| KR_RRN | KR_RRN | number | The Korean Resident Registration Number (RRN) is a 13-digit number issued to all Korean residents. |
| IN_GSTIN | IN_GSTIN | string | The Indian Goods and Services Tax Identification Number (GSTIN) is a 15-character identifier with state code (01-37), Permanent Account Number (PAN), registration number, “Z”, and checksum. |
| ADDRESS | ADDRESS | address | Address information used to identify locations. |
| DOB | DOB | datetime | Date of Birth. Standard personal-identification detail that specifies the exact day, month, and year a person was born. |
| TH_TNIN | TH_TNIN | nin | The Thai National ID Number (TNIN) is a unique 13-digit number issued to all Thai residents. |