Skip to content

Latest commit

 

History

History
252 lines (247 loc) · 5.9 KB

field_types.md

File metadata and controls

252 lines (247 loc) · 5.9 KB
Raw

Supported Fields

Presidio contains predefined recognizers for PII entities (fields). This page describes the different entities Presidio can detect and the method Presidio employs to detect those.

In addition, Presidio allows you to add custom fields by API or code. For more information, refer to the custom fields documentation.

Global

FieldType Description Detection Method
CREDIT_CARD

A credit card number is between 12 to 19 digits. https://en.wikipedia.org/wiki/Payment_card_number

 Pattern match and checksum
CRYPTO

A Crypto wallet number. Currently only Bitcoin address is supported

 Pattern match and checksum
DATE_TIME

Absolute or relative dates or periods or times smaller than a day.

 Pattern match and context
DOMAIN_NAME

A domain name as defined by the DNS standard.

 Pattern match and top level domain validation
EMAIL_ADDRESS

An email address identifies an email box to which email messages are delivered

 Pattern match and RFC-822 validation
IBAN_CODE

The International Bank Account Number (IBAN) is an internationally agreed system of identifying bank accounts across national borders to facilitate the communication and processing of cross border transactions with a reduced risk of transcription errors.

 Pattern match and checksum
IP_ADDRESS

An Internet Protocol (IP) address (either IPv4 or IPv6).

 Pattern match and checksum
NRP

A person’s Nationality, religious or political group.

 Word and phrase list
LOCATION

Name of politically or geographically defined location (cities, provinces, countries, international regions, bodies of water, mountains

 Custom logic and context
PERSON

A full person name, which can include first names, middle names or initials, and last names.

 Custom logic and context
PHONE_NUMBER

A telephone number

Custom logic, pattern match and context

USA

FieldType Description Detection Method
US_BANK_NUMBER

A US bank account number is between 8 to 17 digits.

 Pattern match and context
US_DRIVER_LICENSE

A US driver license. according to https://ntsi.com/drivers-license-format/

 Pattern match and context
US_ITIN

US Individual Taxpayer Identification Number (ITIN). Nine digits that start with a "9" and contain a "7" or "8" as the 4 digit.

 Pattern match and context
US_PASSPORT

A US passport number with 9 digits.

 Pattern match and context
US_SSN

An US Social Security Number (SSN) with 9 digits.

Pattern match and context

UK

FieldType Description Detection Method
UK_NHS

A UK NHS number is 10 digits.

 Pattern match and checksum

All fields

In case you need Presidio to return all possible PII entities, in your Presidio deployment, you need to set the `allFields` flag to `true`.

For example:

"analyzeTemplate":{"allFields":true}

Custom fields

Presidio supports custom fields. Refer to the custom fields documentation to learn more.