Entities supported for the country us
The following entities are supported for the country us (United States)
| entity | description | example |
|---|---|---|
| account/bank/account_number/context | A bank account number (without routing number), with context. | Bank account no: 123456789 |
| account/bank/account_number/landmark | A bank account number landmark. | Bank account no |
| account/bank/account_number/nocontext | A bank account number (without routing number), without context. | 123456789 |
| account/bank/context | A US bank account number (including the routing number), with context. | Bank Account Number: 622356789 123456789 |
| account/bank/landmark | A bank account landmark. | Bank Account Number |
| account/bank/nocontext | A US bank account number (including the routing number), without context. | 622356789 123456789 |
| account/bank/routing_number/context | A bank routing number (without account number), with context. | Routing no: 622356789 |
| account/bank/routing_number/landmark | A bank routing number landmark. | Routing no |
| account/bank/routing_number/nocontext | A bank routing number (without account number), without context. | 622356789 |
| address | A postal address. In general, a score of one is given to an address that includes a numbered, common format street address (for example "23 North Road"), a known city (for example "London"), and a postal code in a viable format for the country (for example "SW1A 2AA"). Deviations from this form lead to score penalties. The ordering of these elements varies by country. OpenText recommends that you use prefiltering to improve the performance for this grammar. See Configure Prefiltering. This entity returns the addresses in a normalized format by default. The normalized form standardizes apartment and house numbers, expands shortened forms of region names, removes additional punctuation, and converts the text to uppercase. For example "ABIDEI HURRIYET CD TANER PALAS APT 9, KAT:7, D:9, 34437 ISTANBUL". The exact order depends on the country. You can turn off normalization by setting normalize_addresses=false in the address_stoplist.lua script. This option can improve performance when you do not need normalization. |
455 Larkspur Dr. Apt 23, Baton Rouge, LA, 70825 455 Larkspur Dr. apt 23, L.A., CA 92808 Mountain View Building, 1019 East Main Street, Suite 201, Bozeman MT 59715-3890 One Penn Plaza, 36th Floor, New York City, NY 10119 PO Box 34, DULUTH MN 55803-0034, USA |
| address/city/context | A city or town, with context. | City: L.A. city: Denver |
| address/city/landmark | A city or town landmark. | City city |
| address/city/nocontext | A city or town, without context. | Denver L.A. |
| address/country/context | A country, with context. | Country: USA country: USA |
| address/country/landmark | A country landmark. | Country country |
| address/country/nocontext | A country, without context. | USA |
| address/landmark | A postal address landmark. | Address address |
| address/postcode/context | A postal code, with context. | ZIP: 94070 Zip code: 92808 |
| address/postcode/landmark | A postal code landmark. | ZIP Zip code |
| address/postcode/nocontext | A postal code, without context. | 92808 94070 |
| address/streetlocation/context | A street location (house number and street name), with context. | Address: 455 Larkspur Drive address: 455 Larkspur Drive address: Mountain View Building, 1019 East Main Street, Suite 201 address: One Penn Plaza, 36th Floor address: PO Box 34 |
| address/streetlocation/landmark | A street location landmark. | Address address |
| address/streetlocation/nocontext | A street location (house number and street name), without context. | 455 Larkspur Drive Mountain View Building, 1019 East Main Street, Suite 201 One Penn Plaza, 36th Floor PO Box 34 |
| age/landmark | A US age landmark. | Age |
| age/over89/context | A US age statement with context. This entity finds ages over 89 years old. | Age: 99 years old |
| age/over89/nocontext | A US age statement without context. This entity finds ages over 89 years old. | 99 years old |
| banking/account_number/context | An individual bank account number, with context. | Bank account number: 123456789 |
| banking/account_number/landmark | An individual bank account number landmark. | Bank account number |
| banking/account_number/nocontext | An individual bank account number, without context. | 123456789 |
| banking/context | Bank account numbers sufficient to identify an individual account, with context. | Checking Account No.: 12-3456/78 123456789 |
| banking/landmark | A bank account landmark. | Checking Account No. |
| banking/nocontext | Bank account numbers sufficient to identify an individual account, without context. | 12-3456/78 123456789 |
| banking/routing_number/context | A routing number, usually used to identify a bank branch, with context. | Routing Number: 622356789 |
| banking/routing_number/landmark | A routing number landmark. | Routing Number |
| banking/routing_number/nocontext | A routing number, usually used to identify a bank branch, without context. | 622356789 |
| banking/swiftcode/context | A SWIFT/BIC code, with context. | SWIFT code: XXXXUS00BBB |
| banking/swiftcode/nocontext | A SWIFT/BIC code, without context. | XXXXUS00BBB |
| certificate/birth/context | A US birth certificate number with context. | Birth Certificate: 160 99 123456 |
| certificate/birth/landmark | A US birth certificate landmark. | Birth Certificate |
| certificate/birth/nocontext | A US birth certificate number without context. | 160 99 123456 |
| certificate/generic/context | A US generic certificate number with context. | Certificate No: MX-123-456/78 |
| certificate/generic/landmark | A US generic certificate landmark. | Certificate No |
| certificate/generic/nocontext | A US generic certificate number without context. This option is available only for the certificate user extension. See Generic Certificate Numbers. | |
| dea/context | A US DEA (Drug Enforcement Agency) registration number with context. | DEA Registration Number: BE1234563 |
| dea/landmark | A US DEA registration number landmark. | DEA Registration Number |
| dea/ndc/context | A US National Drug Code (NDC) with context. | NDC: 66467-2220-1 |
| dea/ndc/landmark | A US National Drug Code landmark. | NDC |
| dea/ndc/nocontext | A US National Drug Code without context. | 66467-2220-1 |
| dea/ndc_billing/context | A US National Drug Code billing derivative with context. | NDC: 12345-6789-10 |
| dea/ndc_billing/landmark | A US National Drug Code billing derivative landmark. | NDC |
| dea/ndc_billing/nocontext | A US National Drug Code billing derivative without context. | 12345-6789-10 |
| dea/nocontext | A US DEA registration number without context. | BE1234563 |
| document_markings/us_cui/basic/nocontext | The basic CUI (Controlled Unclassified Information) marking.1 | CONTROLLED//TSCA//NOFORN |
| document_markings/us_cui/controlled_by/nocontext | The name of the department that a document is controlled by, marked by a landmark. The entity is normalized to remove the landmark.2 | Controlled by: Department of Good Works, Security and Inspection Division, 2025554567. |
| document_markings/us_cui/dissemination_list/nocontext | The list of dissemination targets, marked by a landmark. The entity is normalized to remove the landmark.3 | Dissemination List: Office of Intelligence and Analysis, Department of Homeland Security Counterterrorism Division, Federal Bureau of Investigation. |
| document_markings/us_cui/specified/nocontext | The specified CUI marking.4 | CUI//SP-INTEL/SP-CTI/IFNC/AG//FEDCON/REL TO USA, GBR |
| document_markings/us_dod/banner_line/nocontext | Banner lines in US DoD (Department of Defense) documents. These banner lines appear in the header and footer of every page in the document.5 | //COSMIC TOP SECRET //JOINT SECRET CAN GBR USA SECRET//ACCM-FICTITIOUS EFFORT/TEA LEAF SECRET//FGI SECRET//RD-SIGMA 1 2 TOP SECRET//SI/TK//RELIDO TOP SECRET//SPECIAL ACCESS REQUIRED-BUTTERED POPCORN |
| document_markings/us_dod/classification_authority_block/classified_by_header/nocontext | The 'Classified by' header in the classification authority block in US DoD documents.6 | Classified By: |
| document_markings/us_dod/classification_authority_block/declassify/nocontext | The 'Declassify on' directive in the classification authority block in US DoD documents.7 | Declassify On: 25X 20320109 |
| document_markings/us_dod/classification_authority_block/derived_from_header/nocontext | The 'Derived from' header in the classification authority block in US DoD documents.8 | Derived From: |
| document_markings/us_dod/classification_authority_block/downgrade/nocontext | The 'Downgrade to' directive in the classification authority block in US DoD documents.9 | Downgrade To: CONFIDENTIAL on 20121231 |
| document_markings/us_dod/classification_authority_block/reason/nocontext | The 'Reason' directive in the classification authority block in US DoD documents.10 | Reason: 1.4(a)(b)(c) |
| document_markings/us_dod/portion_marking/nocontext | Portion markings in US DoD documents. Portion markings are used to mark individual sentence, sections and paragraphs.11 | (//JOINT S GBR USA//REL) (//NS-A) (S//ACCM-PINE CONE/TEA LEAF) (S//RD-SG 12) (S//REL TO USA, GBR/DISPLAY ONLY AFG) (TS//SAR-TB//WAIVED) (TS//SI-G//OC/NF) |
| driving/context | A driving license number with context. This entity matches both the driving license number, and the personal number or driver number, if present. On the standard European driving license, these are fields 5 and 4d.12 | Driving license: 012AB3456 |
| driving/landmark | A driving license landmark. | Driving license |
| driving/nocontext | A driving license number, without context.13 | 012AB3456 |
| health/id/context | A US health insurance number with context. | Health Insurance Claim Number: 123-45-6789A Medicare ID: 1EG4-TE5-MK72 |
| health/id/landmark | A health number landmark. | Health Insurance Claim Number Medicare ID |
| health/id/nocontext | A health number, such as a British NHS number, French Carte Vitale number or Japanese Health Insurance Card number, without context. | 123-45-6789A 1EG4-TE5-MK72 |
| healthplan/context | A PHI health plan beneficiary number. These numbers consist of fourteen alphanumeric characters, preceded by a suitable landmark. | Health Plan Number: 12345678LMNOP9 |
| healthplan/hcpcs_i/context | A US Healthcare Common Procedure Code (HCPCS) level I with context. | CPT Code: 3006F |
| healthplan/hcpcs_i/landmark | A US Healthcare Common Procedure Code level I landmark. | CPT Code |
| healthplan/hcpcs_i/nocontext | A US Healthcare Common Procedure Code level I without context. | 3006F |
| healthplan/hcpcs_ii/context | A US Healthcare Common Procedure Code level II with context. | Healthcare Common Procedure Code: C1300 |
| healthplan/hcpcs_ii/landmark | A US Healthcare Common Procedure Code level II landmark. | Healthcare Common Procedure Code |
| healthplan/hcpcs_ii/nocontext | A US Healthcare Common Procedure Code level II without context. | C1300 |
| healthplan/hicn/context | A US Health Insurance Claim Number (HICN) with context. | Health Insurance Claim Number: 123-45-6789-A |
| healthplan/hicn/landmark | A US Health Insurance Claim Number landmark. | Health Insurance Claim Number |
| healthplan/hicn/nocontext | A US Health Insurance Claim Number without context. | 123-45-6789-A |
| healthplan/landmark | A health plan number landmark. | Health Plan Number |
| healthplan/mbi/context | A US Medicare Beneficiary Identifier (MBI) with context. | Medicare Beneficiary Identifier: 1EG4-TE5-MK73 |
| healthplan/mbi/landmark | A US Medicare Beneficiary Identifier landmark. | Medicare Beneficiary Identifier |
| healthplan/mbi/nocontext | A US Medicare Beneficiary Identifier without context. | 1EG4-TE5-MK73 |
| healthplan/nocontext | A PHI health plan beneficiary number without context. | 12345678LMNOP9 |
| healthplan/npi/context | A US National Provider Identifier (NPI) with context. | National Provider Identifier: 3728482340 |
| healthplan/npi/landmark | A US National Provider Identifier landmark. | National Provider Identifier |
| healthplan/npi/nocontext | A US National Provider Identifier without context. | 3728482340 |
| id/context | A national identity number with context. For information about the supported ID numbers, see Supported National ID Numbers. | Social Security Number: 111 22 3333 Social Security Number: 111-22-3333 |
| id/landmark | A national identity number landmark.14 | Social Security Number |
| id/nocontext | A national identity number without context. For information about the supported ID numbers, see Supported National ID Numbers.15 | 111 22 3333 111-22-3333 |
| id/redacted/context | A redacted or partially redacted US social security number, with context. At least one masking character, x, X, or *, must be present. | SSN: 111-xx-xxxx |
| id/redacted/nocontext | A redacted or partially redacted US social security number, without context. At least one masking character, x, X, or *, must be present. | 111-xx-xxxx |
| internet/email/context | An email address, with context. | email: jsmith@mailserver.com |
| internet/email/landmark | An email address landmark. | |
| internet/email/nocontext | An email address, without context. | jsmith@mailserver.com |
| laboratory/context | A US laboratory number with context. | CLIA No: 01D1234567 |
| laboratory/landmark | A US laboratory number landmark. | CLIA No |
| laboratory/nocontext | A US laboratory number without context. | 01D1234567 |
| license/driving/context | A US driving license number with context. | Driving License: 012AB3456 |
| license/driving/landmark | A US driving license landmark. | Driving License |
| license/driving/nocontext | A US driving license number without context. | 012AB3456 |
| license/generic/context | A US generic license number with context. | License: MX-123-456/78 |
| license/generic/landmark | A US generic license landmark. | License |
| license/generic/nocontext | A US generic license number without context. This option is available only for the license user extension. See Generic License Numbers. MX-123-456/78 | |
| location | A US subdivision smaller than a state, such as towns, cities, and counties. Scores are boosted by the presence of a state, a zipcode, or a nearby landmark value. For example, "Houston" scores 0.4, while "Houston, Texas" scores 0.65 and "city of Houston, Texas" scores 1. State names are normalized in the results to the fullest form (for example, TX to TEXAS). | Bozeman MT 59715-3890 town of Alamo in the state of Indiana |
| mrn/context | A Medical Record Number. See Medical Record Numbers. | MRN: MR-123-456/78 |
| mrn/landmark | A Medical Record Number landmark. | MRN |
| mrn/nocontext | A Medical Record Number without context. This option is available only for the healthplan user extension. See Medical Record Numbers. | |
| name | A full personal name. Romanized names can be in title case or upper case, and can be in the order given name surname or surname given name. CJKVT native script names must be surname given name. For Japanese, either form can include honorifics.16 | Michael Smith Michael White Mrs M. Smith Zachary de Henson Sr |
| name/given_name/context | A given name with context. For CJKVT the context landmark should be in CJKVT native script. | First names: Michael Forename: Michael |
| name/given_name/landmark | A given name landmark. For CJKVT it will be in native script. | First names Forename |
| name/given_name/nocontext | A given name, without context. | Michael |
| name/landmark | A full name landmark. | Name |
| name/post_title | A title that follows a name. | Junior Sr |
| name/pre_title | A title that precedes a name. | Mrs |
| name/surname/context | A surname with context. For CJKVT the landmark will be in native script | Surname: Smith |
| name/surname/landmark | A surname landmark. | Surname |
| name/surname/nocontext | A surname without context. | Smith |
| name/title_surname | A title and surname. | Dr Smith Mrs de Smith |
| nationality/adj/context | A nationality adjective with context. | nationality: American |
| nationality/adj/landmark | A nationality adjective landmark. | nationality |
| nationality/adj/nocontext | A nationality adjective without context. | American |
| nationality/any/context | Any combination of nationality adjective and noun landmark and value. | nationality: American |
| nationality/any/landmark | Any nationality adjective or landmark. | nationality |
| nationality/any/nocontext | Any nationality adjective or noun. | American |
| nationality/noun/context | A nationality noun with context. | country: America |
| nationality/noun/landmark | A nationality noun landmark. | country |
| nationality/noun/nocontext | A nationality noun without context. | America |
| number/export/ccats/context | A Commodity Classification Automated Tracking System (CCATS) code, with context. | CCAT: G144401 |
| number/export/ccats/landmark | A CCATS code landmark. | CCAT |
| number/export/ccats/nocontext | A CCATS code, without context. | G144401 |
| number/export/ccl/context | The Commerce Control List (CCL) designation, with context. (The CCL is a superset of the ECCN.) | CCL: Annex to Cat 1 List of Explosives 45 |
| number/export/ccl/landmark | A CCL landmark. | CCL |
| number/export/ccl/nocontext | The CCL designantion, without context. | Annex to Cat 1 List of Explosives 45 |
| number/export/ear_exception_enc/context | An Export Administration Regulations (EAR) exceptions for encryption (ENC) number, with context. | License Exception: 740.17(b)(2) |
| number/export/ear_exception_enc/landmark | An EAR exceptions for ENC landmark. | License Exception |
| number/export/ear_exception_enc/nocontext | An EAR exceptions for ENC number, without context. | 740.17(b)(2) |
| number/export/eccn/context | The Export Control Classification Number (ECCN), with context. | ECCN: 5A002.a.1 |
| number/export/eccn/landmark | An ECCN landmark. | ECCN |
| number/export/eccn/nocontext | The ECCN, without context. | 5A002.a.1 |
| number/export/hts/context | A Harmonized Tariff Schedule (HTS) code, with context. | Harmonized Tariff: 8542.31.0000 |
| number/export/hts/landmark | An HTS code landmark. | Harmonized Tariff |
| number/export/hts/nocontext | An HTS code, without context. | 8542.31.0000 |
| number/export/schedule_b/context | A Schedule B code, with context. | U.S. Schedule B: 8542.31.0000 |
| number/export/schedule_b/landmark | A Schedule B code landmark. | U.S. Schedule B |
| number/export/schedule_b/nocontext | A Schedule B code, without context. | 8542.31.0000 |
| passport/context | A passport number with context. | passport #: 123456789 |
| passport/landmark | A passport landmark. For information about cases where the landmark and passport number do not match or have an ambiguous match, see Ambiguous Entities. | passport # |
| passport/nocontext | A passport number without context. | 123456789 |
| postcode/context | A postal code with context. | ZIP: 94070 |
| postcode/landmark | A postal code landmark. | ZIP |
| postcode/nocontext | A postal code without context. | 94070 |
| profession/context | A profession or occupation with context. | Occupation: Landscape Designer |
| profession/landmark | A profession or occupation landmark. | Occupation |
| profession/nocontext | A profession or occupation without context. | Landscape Designer |
| regulation_references/cfr | Code of Federal Regulations reference. | 18 C.F.R. pt. 157 (2020) 21 CFR 10.115 36 CFR 242.1-242.28 47 C.F.R. Part 101 Subpart A 47 C.F.R. Parts 101-103 |
| regulation_references/fed_court_rule | US Federal Court Rule reference (including Federal Rules of Appellate Procedure, Federal Rules of Civil Procedure, Federal Rules of Criminal Procedure, Federal Rules of Evidence, Federal Rules of Bankruptcy Procedure, and U.S. Supreme Court Rules). | Fed. R. App. P. 15(d) Fed. R. Civ. P. 23 (C)(4)(A)-(B) Fed. R. Civ. P. 23 (C)(4)(A)-(B) to 15(d) |
| regulation_references/fed_reg | US Federal Register reference. | 71 Fed. Reg. 42,928 (July 28, 2006) 84 Fed. Reg. 45,900 - 45,901 (Sept. 3, 2019) (revising 20 C.F.R. § 401.85) 84 Fed. Reg. 45,900 - 45,901 (Sept. 3, 2019) (revising 36 CFR 242.1-242.28) 84 Fed. Reg. 45,900 - 45,901 (Sept. 3, 2019) (revising 47 C.F.R. Part 101 Subpart A) 84 Fed. Reg. 45,900 - 45,901 (Sept. 3, 2019) (revising 47 C.F.R. Parts 101-103) Federal Register 84, no. 122 (June 25, 2019) |
| regulation_references/ferc/docket_nbr/context | Federal Energy Regulatory Commission (FERC) Docket number with context. | Docket Number: RP19-1523-000 |
| regulation_references/ferc/docket_nbr/landmark | Federal Energy Regulatory Commission (FERC) Docket number landmark. | Docket Number |
| regulation_references/ferc/docket_nbr/nocontext | Federal Energy Regulatory Commission (FERC) Docket number without context. | RP19-1523-000 |
| regulation_references/ferc/order | Federal Energy Regulatory Commission (FERC) Order number reference. | 106 FERC 61,220 at P 744 (2004) (codified at 18 CFR pt 101) 106 FERC 61,220 at P 744 (2004) (codified at 21 CFR 10.115) 106 FERC 61,220 at P 744 (2004) (codified at 36 CFR 242.1-242.28) 106 FERC 61,220 at P 744 (2004) (codified at 47 C.F.R. Part 101 Subpart A) 106 FERC 61,220 at P 744 (2004) (codified at 47 C.F.R. Parts 101-103) 166 FERC ¶ 61,032 at P 1 (2019) 166 FERC ¶ 61,032-33 at P 1 (2019) 31 FERC ¶ 63,062 at 65,213-14 (1985) |
| regulation_references/usc | US Code reference. | 15 U.S.C. § 717f(c) (2018) 15 USC 78k(a)(1)-(2) (1970) |
| telephone/context | A telephone number with context. For the telephone_cjkvt grammar, numbers can be ASCII or full-width numbers. This entity returns the telephone number in the normalized format +NNNNN, starting with the country code. For example +12012224344.17 | Cell: +1 (202) 437-4707 TELEPHONE: (415)-243-9955 |
| telephone/landmark | A telephone number landmark. For the telephone_cjkvt grammar, landmarks are available only in CJKVT native script. | Cell TELEPHONE |
| telephone/nocontext | A telephone number without context. For the telephone_cjkvt grammar, numbers can be ASCII or full-width numbers. This entity returns the telephone number in the normalized format +NNNNN, starting with the country code. For example +12042439955.18 | (415)-243-9955 +1 (202) 437-4707 +1 415 243 9955 |
| tin/context | A tax identification number with context. For more examples, see Example Tax Identification Numbers.19 | ITIN: 911-92-3333 Social Security Number: 123456789 |
| tin/landmark | A tax identification number landmark. | ITIN Social Security Number |
| tin/nocontext | A tax identification number without context. For more examples, see Example Tax Identification Numbers.20 | 123456789 911-92-3333 |
| travel/context | A US passport card number with context. | passport card: C12345678 |
| travel/landmark | A US passport card number landmark. | passport card |
| travel/nocontext | A US passport card number without context. | C12345678 |
| vehicle/licenseplate/context | A vehicle license place number with context. | License Plate Number: ABC 123 |
| vehicle/licenseplate/landmark | A vehicle license plate number landmark. | License Plate Number |
| vehicle/licenseplate/nocontext | A vehicle license place number without context. | ABC 123 |
In the tables, ✔️ indicates that the item is always used, and ❌ that the item is never used. The ✓ symbol indicates that the item is only used for some entities (that is, for some but not all countries or languages). For details, refer to the relevant entity page.