Auto Detected Field Search

Detected PII Search

Canopy allows you to search on the list of all detected Personal Identifiable Information (PII) by system field. All detected PII is stored in text form as it appears in the document. Searching these fields is supported by the field query string syntax.

Query String Syntax

This is the heart of the query_string query. Here’s a summary:

Terms: Individual words or phrases.
Phrases: Enclosed in double quotes (e.g., "quick brown fox").
Fields: Specify the field to search using field_name:term (e.g., title:Elasticsearch).
Boolean Operators: AND, OR, NOT (must be capitalized). You can also use + (for AND) and - (for NOT).
Parentheses: Used for grouping (e.g., (quick OR fast) AND brown).
Wildcards:
- *: Matches any sequence of characters (e.g., el*stic matches “elastic”, “elastics”, etc.).
- ?: Matches any single character (e.g., ex?mple matches “example”, “exmple”, etc.).
Fuzzy Matching: Use ~ after a term to enable fuzzy matching (e.g., aple~ matches “apple”). You can specify the edit distance (e.g., aple~2).
Prefix Queries: Use * at the end of a term (e.g., elasti*).
Boosts: Increase the relevance of a term or clause using ^ (e.g., title:Elasticsearch^2).
Escape Characters: Escape special characters using a backslash (e.g., field_name\:value).

List of PII Fields

Here’s a list of the PII fields available for searching in Canopy. Each field is prefixed with pii.:

pii.name
pii.address
pii.email
pii.age
pii.date_of_birth
pii.ethnicity
pii.religious
pii.bank_account
pii.credit_card
pii.acc
pii.aba
pii.employee_id
pii.retirement
pii.ip_address
pii.mac_address
pii.url
pii.username
pii.password
pii.pin
pii.former_name
pii.nationality
pii.biological_sex
pii.sexual_orientation
pii.gender_identity
pii.political_affiliation
pii.vin
pii.blood_type
pii.date_of_death
pii.diagnosis_code
pii.insurance_id
pii.icd10
pii.insurance_provider
pii.medical_procedures
pii.mrn
pii.medicare_id
pii.medications
pii.patient_dates
pii.symptoms_diagnosis
pii.au_abn
pii.au_drivers_license
pii.au_license_plate_number
pii.au_medicare_number
pii.au_passport
pii.au_tfn
pii.au_phone_number
pii.au_bank_state_branch
pii.au_bank_account
pii.au_super_fund_number
pii.au_unique_super_annuation_identifier
pii.au_birth_certificate_number
pii.au_centre_link_reference_number
pii.au_super_annuation_product_identification
pii.au_individual_healthcare_identifier
pii.au_aged_care_id_number
pii.au_address
pii.canadian_bank_account_number
pii.canadian_passport
pii.canadian_drivers_licence
pii.canadian_licence_plate_number
pii.canadian_sin
pii.canadian_inac
pii.canadian_health_service_number
pii.canadian_phin
pii.eu_ehic
pii.eu_email
pii.eu_phone
pii.austria_passport
pii.austria_driving_licence
pii.austria_ssn
pii.austria_tin
pii.austria_phone_number
pii.austria_vat
pii.austria_id_card_number
pii.belgian_passport
pii.belgian_national_id_number
pii.belgian_driving_licence
pii.belgian_vat
pii.belgian_phone_number
pii.bulgarian_driving_licence
pii.bulgarian_egn
pii.bulgarian_passport
pii.bulgarian_phone_number
pii.croatia_oib
pii.croatia_passport
pii.croatia_driving_licence
pii.croatia_phone_number
pii.cyprus_id_card
pii.cyprus_passport
pii.cyprus_driving_licence
pii.cyprus_phone_number
pii.cyprus_tin
pii.czech_id_card
pii.czech_passport
pii.czech_driving_licence
pii.czech_phone_number
pii.czech_tin
pii.danish_id_card_number
pii.danish_passport
pii.danish_driving_licence
pii.danish_phone_number
pii.estonia_driving_licence
pii.estonia_id
pii.estonia_passport
pii.estonia_phone
pii.finland_driving_licence
pii.finland_id
pii.finland_passport
pii.finland_phone
pii.french_cni
pii.french_passport
pii.french_driving_licence
pii.french_health_insurance_number
pii.french_insee
pii.french_spi
pii.french_phone_number
pii.german_id_card_number
pii.german_passport
pii.german_driving_licence
pii.german_tax_id_number
pii.german_phone_number
pii.greece_national_id_card
pii.greece_passport
pii.greece_driving_licence
pii.greece_phone_number
pii.greece_amka
pii.greece_afm
pii.hungarian_id_card_number
pii.hungarian_passport
pii.hungarian_driving_licence
pii.hungarian_phone_number
pii.hungarian_tin
pii.hungarian_taj
pii.ireland_driving_licence
pii.ireland_passport
pii.ireland_pps
pii.ireland_phone_number
pii.italian_cie
pii.italian_passport
pii.italian_driving_licence
pii.italian_phone_number
pii.italian_fiscal_code
pii.latvia_driving_licence
pii.latvia_personal_code
pii.latvia_passport
pii.latvia_phone
pii.lithuania_driving_licence
pii.lithuania_personal_code
pii.lithuania_passport
pii.lithuania_phone
pii.luxembourg_driving_licence
pii.luxembourg_nin_np
pii.luxembourg_nin_nnp
pii.luxembourg_passport
pii.luxembourg_phone
pii.malta_driving_licence
pii.malta_id
pii.malta_passport
pii.malta_phone
pii.malta_tin
pii.dutch_id_card_number
pii.dutch_passport
pii.dutch_driving_licence
pii.dutch_bsn
pii.dutch_tin
pii.dutch_phone_number
pii.poland_id
pii.poland_passport
pii.poland_driving_licence
pii.poland_phone_number
pii.poland_pesel
pii.poland_tin
pii.poland_region
pii.portugal_citizen_card
pii.portugal_driving_licence
pii.portugal_passport
pii.portugal_tin
pii.romania_cnp
pii.romania_passport
pii.romania_driving_licence
pii.romania_phone_number
pii.slovakia_driving_licence
pii.slovakia_personal_number
pii.slovakia_passport
pii.slovakia_phone
pii.slovenia_driving_licence
pii.slovenia_citizen_number
pii.slovenia_passport
pii.slovenia_phone
pii.spanish_dni
pii.spanish_passport
pii.spanish_driving_licence
pii.spanish_phone_number
pii.spanish_ssn
pii.spanish_nif
pii.swedish_id_card_number
pii.swedish_passport
pii.swedish_driving_licence
pii.swedish_phone_number
pii.iceland_driving_licence
pii.iceland_passport
pii.iceland_phone
pii.liechtenstein_driving_licence
pii.liechtenstein_passport
pii.liechtenstein_phone
pii.norway_driving_licence
pii.norway_passport
pii.norway_phone
pii.nz_bank_account
pii.nz_drivers_license
pii.nz_firearms_license
pii.nz_ird_number
pii.nz_kiwi_number
pii.nz_ministry_health_number
pii.nz_passport
pii.nz_phone
pii.nz_social_welfare_number
pii.nz_tin
pii.singapore_driving_licence
pii.singapore_nric
pii.singapore_passport
pii.singapore_phone
pii.uk_address
pii.uk_bank_account
pii.uk_chi_number
pii.uk_drivers_licence
pii.uk_nhs_number
pii.uk_nino
pii.uk_passport_number
pii.uk_phone_number
pii.uk_post_code
pii.uk_sort_code
pii.uk_utr
pii.driver_license
pii.itin
pii.mid
pii.passport
pii.phone
pii.social_security_number
pii.german_sin
pii.caqh_id
pii.npi
pii.secret_key
pii.military_address
pii.procedure_codes
pii.medical
pii.vaccine
pii.organization
pii.patient_id