national_id grammar

The national_id grammar is found in the sets PII, PHI.

entity	description	examples	components	checksum
id/context/CC	A national identity number with context. For information about the supported ID numbers, see Supported National ID Numbers.	SSN: 111-22-3333	✔️	✓
id/landmark/CC	A national identity number landmark.1 By default, when there are multiple possible matches, post-processing returns only one country, which is the most efficient option. You can enable ambiguous entity matching by setting ambiguous_entities=true in the pii_postprocessing.lua script. This option returns multiple possible country matches.	National insurance number Social security number	❌	❌
id/nocontext/CC	A national identity number without context. For information about the supported ID numbers, see Supported National ID Numbers.2 By default, when there are multiple possible matches, post-processing returns only one country, which is the most efficient option. You can enable ambiguous entity matching by setting ambiguous_entities=true in the pii_postprocessing.lua script. This option returns multiple possible country matches.	111-22-3333	✔️	✓
id/redacted/context/us	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/us	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	❌	❌

The following components are produced by the above entities.

components	description	examples	context
LANDMARK	landmark indicating the entity type	رخصة قيادة	رخصة قيادة: 1234567

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.