feat(analyzer): add generic VIN and IMEI recognizers by thatomokoena · Pull Request #2070 · data-privacy-stack/presidio

thatomokoena · 2026-06-17T14:02:09Z

Change Description

Adds generic VinRecognizer for VIN (17-character ISO 3779 vehicle identifiers) with pattern matching, context words, and North American mod-11 check-digit validation. Valid check digits boost confidence to MAX_SCORE for any region; invalid check digits are rejected for North American WMIs (prefix 1-5); non-NA mismatches keep the base pattern score.
Adds generic ImeiRecognizer for IMEI (15-digit mobile device identifiers) with a formatted pattern (##-######-######-#), context words, and Luhn checksum invalidation. Bare 15-digit matching is omitted to avoid collisions with other Luhn identifiers such as AMEX credit card numbers.
Registers both recognizers in default_recognizers.yaml (enabled by default), exports them from predefined_recognizers, and documents them in supported_entities.md and CHANGELOG.md.
Adds test_vin_recognizer.py and test_imei_recognizer.py; all pass locally. ruff check passes on new recognizer source files.

Issue reference

N/A

Checklist

I have reviewed the contribution guidelines
I have signed the CLA (if required)
My code includes unit tests
All unit tests and lint checks pass locally
My PR contains documentation updates / additions if required

Add VinRecognizer and ImeiRecognizer as enabled predefined recognizers with pattern matching, context support, and checksum validation for vehicle and mobile device identifiers. Co-authored-by: Cursor <cursoragent@cursor.com>

thatomokoena · 2026-06-17T14:04:05Z

@microsoft-github-policy-service agree

Copilot

Pull request overview

Note

Copilot was unable to run its full agentic suite in this review.

Adds two new generic predefined recognizers (VIN and IMEI) to Presidio Analyzer and wires them into the default registry/config, along with tests and documentation updates.

Changes:

Introduces VinRecognizer with a VIN regex plus check-digit validation logic.
Introduces ImeiRecognizer with IMEI regex patterns plus Luhn checksum invalidation.
Registers both recognizers in package exports, default YAML config, supported entities docs, and changelog.

Reviewed changes

Copilot reviewed 9 out of 9 changed files in this pull request and generated 2 comments.

Show a summary per file

File	Description
presidio-analyzer/presidio_analyzer/predefined_recognizers/generic/vin_recognizer.py	New VIN recognizer implementation with mod-11 check digit logic
presidio-analyzer/presidio_analyzer/predefined_recognizers/generic/imei_recognizer.py	New IMEI recognizer implementation with Luhn validation
presidio-analyzer/presidio_analyzer/predefined_recognizers/generic/init.py	Exposes new recognizers from the `generic` package
presidio-analyzer/presidio_analyzer/predefined_recognizers/init.py	Exposes new recognizers at the top-level predefined module
presidio-analyzer/presidio_analyzer/conf/default_recognizers.yaml	Enables loading the new recognizers by default
presidio-analyzer/tests/test_vin_recognizer.py	Adds unit tests for VIN detection and validation behavior
presidio-analyzer/tests/test_imei_recognizer.py	Adds unit tests for IMEI detection and invalidation behavior
docs/supported_entities.md	Documents newly supported IMEI and VIN entities
CHANGELOG.md	Records the addition of VIN and IMEI recognizers

Copilot

Pull request overview

Copilot reviewed 9 out of 9 changed files in this pull request and generated 2 comments.

Reject invalid North American VIN check digits for WMI prefixes 1-5 while preserving base scores for non-NA VINs. Remove bare 15-digit IMEI pattern to avoid collisions with AMEX and other Luhn identifiers. Co-authored-by: Cursor <cursoragent@cursor.com>

Wire sanitize_value through invalidate_result so custom separator replacement_pairs are honored, matching other pattern recognizers. Co-authored-by: Cursor <cursoragent@cursor.com>

Copilot

Pull request overview

Copilot reviewed 9 out of 9 changed files in this pull request and generated 3 comments.

Align IMEI Luhn description and VIN validate_result return docs with actual behavior per Copilot review feedback. Co-authored-by: Cursor <cursoragent@cursor.com>

thatoisnaked · 2026-06-18T07:50:25Z

Hi @SharonHart @omri374. When you have time, would you be willing to take a look at this PR for adding IMEI and VIN recognizers? Happy to address any feedback. Thanks!

Reflect two new enabled predefined recognizers in the registry test assertion. Co-authored-by: Cursor <cursoragent@cursor.com>

thatomokoena · 2026-06-18T12:36:57Z

Hi @SharonHart. The CI failure on PR #2070 is fixed.

The Test Analyzer job was failing because test_recognizer_registry.py still expected 28 enabled predefined recognizers; adding VinRecognizer and ImeiRecognizer bumped the count to 30. I updated the assertion accordingly and pushed commit b3086be (test(analyzer): update recognizer registry count for VIN and IMEI). The registry, VIN, and IMEI tests all pass locally.

CI should be green on the next run. When you have a moment, could you take another look? Thanks!

Copilot

Pull request overview

Copilot reviewed 10 out of 10 changed files in this pull request and generated 2 comments.

Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>

Copilot

Pull request overview

Copilot reviewed 10 out of 10 changed files in this pull request and generated 1 comment.

…rivacy-stack#2070 Document space-delimited IMEI formats in the changelog and add ImeiRecognizer and VinRecognizer to PREDEFINED_RECOGNIZERS so default engine tests cover the new recognizers. Co-authored-by: Cursor <cursoragent@cursor.com>

Copilot

Pull request overview

Copilot reviewed 10 out of 10 changed files in this pull request and generated 3 comments.

+        ("Vehicle VIN is 1HGCM82633A004352", 1, ((15, 32),), ((0.5, "max"),)),
+        ("chassis number 1HGCM82633A004352 recorded", 1, ((15, 32),), ((0.5, "max"),)),
+        ("vin: 1hgcm82633a004352", 1, ((5, 22),), ((0.5, "max"),)),
+        ("The vehicle identification number is 1HGCM82633A004352", 1, ((37, 54),), ((0.5, "max"),)),


+        if fn_score == "max":
+            fn_score = max_score
+        assert_result_within_score_range(


omri374

Thanks and apologies for the late review! Left a couple of comments. Happy to hear your thoughts on the VIM logic and its robustness

omri374 · 2026-07-12T16:47:30Z

    type: predefined

+  - name: VinRecognizer
+    type: predefined


VIN should be disabled by default. Unlike IMEI (delimiters + Luhn make coincidental matches essentially impossible), VinRecognizer uses a bare pattern at 0.5, and its checksum can't compensate: the mod-11 check digit is only mandated in North America (49 CFR 565 / China GB 16735), not by ISO 3779. So validate_result returns None (keeping 0.5) for any non-NA token with a bad check digit, and True (→ MAX 1.0) for the ~1/11 of random 17-char tokens that coincidentally match. That means order IDs, tracking numbers, hex/base32 substrings and SKUs surface for every user by default. Every other checksum-preserving recognizer that uses this None-on-mismatch idiom (de_vat_id, uk_driving_licence, uk_vehicle_registration, kr_rrn, …) is a country recognizer disabled by default.
Please add enabled: false here (or gate detection on a context word). IMEI is fine to keep enabled.

omri374 · 2026-07-12T16:48:33Z

+    "text, expected_len, expected_positions, expected_score_ranges",
+    [
+        # fmt: off
+        ("Vehicle VIN is 1HGCM82633A004352", 1, ((15, 32),), ((0.5, "max"),)),


These valid-VIN cases assert the score range (0.5, "max"), so if the MAX-promotion in validate_result ever broke, the tests would still pass. Assert exact MAX for verified NA VINs instead.

More importantly, please add a negative case proving a random 17-char non-VIN token (e.g. a 17-char order ID/hex string with no I/O/Q) is not flagged. That's the actual false-positive surface and a context-scoring test, since no test currently exercises context enhancement.

feat(analyzer): add generic VIN and IMEI recognizers

fd53dc8

Add VinRecognizer and ImeiRecognizer as enabled predefined recognizers with pattern matching, context support, and checksum validation for vehicle and mobile device identifiers. Co-authored-by: Cursor <cursoragent@cursor.com>

Copilot AI review requested due to automatic review settings June 17, 2026 14:02

github-actions Bot added the external label Jun 17, 2026

Copilot AI reviewed Jun 17, 2026

View reviewed changes

Comment thread presidio-analyzer/presidio_analyzer/predefined_recognizers/generic/vin_recognizer.py

Comment thread presidio-analyzer/presidio_analyzer/predefined_recognizers/generic/imei_recognizer.py

thatomokoena added 2 commits June 18, 2026 08:15

Merge branch 'main' into feature/generic-vin-imei-recognizers

b0ddf80

Merge branch 'main' into feature/generic-vin-imei-recognizers

7b9f290

Copilot AI review requested due to automatic review settings June 18, 2026 06:22

Copilot started reviewing on behalf of thatomokoena June 18, 2026 06:23 View session

Copilot AI reviewed Jun 18, 2026

View reviewed changes

Comment thread presidio-analyzer/presidio_analyzer/predefined_recognizers/generic/imei_recognizer.py Outdated

Comment thread presidio-analyzer/presidio_analyzer/predefined_recognizers/generic/vin_recognizer.py Outdated

thatomokoena and others added 2 commits June 18, 2026 08:39

fix(analyzer): use replacement_pairs in ImeiRecognizer validation

d68f04c

Wire sanitize_value through invalidate_result so custom separator replacement_pairs are honored, matching other pattern recognizers. Co-authored-by: Cursor <cursoragent@cursor.com>

Copilot AI review requested due to automatic review settings June 18, 2026 06:44

Copilot started reviewing on behalf of thatomokoena June 18, 2026 06:45 View session

Copilot AI reviewed Jun 18, 2026

View reviewed changes

docs(analyzer): clarify VIN and IMEI recognizer docstrings

9b32f4e

Align IMEI Luhn description and VIN validate_result return docs with actual behavior per Copilot review feedback. Co-authored-by: Cursor <cursoragent@cursor.com>

test(analyzer): update recognizer registry count for VIN and IMEI

b3086be

Reflect two new enabled predefined recognizers in the registry test assertion. Co-authored-by: Cursor <cursoragent@cursor.com>

Copilot AI review requested due to automatic review settings June 18, 2026 12:32

Copilot started reviewing on behalf of thatomokoena June 18, 2026 12:34 View session

Copilot AI reviewed Jun 18, 2026

View reviewed changes

Comment thread presidio-analyzer/presidio_analyzer/predefined_recognizers/generic/imei_recognizer.py

Comment thread CHANGELOG.md Outdated

update doc string to match regex implementation

79ec215

Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>

Copilot AI review requested due to automatic review settings June 18, 2026 13:27

Copilot started reviewing on behalf of thatomokoena June 18, 2026 13:28 View session

Copilot AI reviewed Jun 18, 2026

View reviewed changes

Comment thread presidio-analyzer/presidio_analyzer/predefined_recognizers/__init__.py

thatomokoena and others added 2 commits June 18, 2026 15:38

Merge branch 'main' into feature/generic-vin-imei-recognizers

d3556de

Copilot AI review requested due to automatic review settings June 22, 2026 06:36

Copilot started reviewing on behalf of thatomokoena June 22, 2026 06:36 View session

Copilot AI reviewed Jun 22, 2026

View reviewed changes

omri374 reviewed Jul 12, 2026

View reviewed changes

Merge branch 'main' into feature/generic-vin-imei-recognizers

701945b

Uh oh!

Conversation

thatomokoena commented Jun 17, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Change Description

Issue reference

Checklist

Uh oh!

thatomokoena commented Jun 17, 2026

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Uh oh!

Uh oh!

thatoisnaked commented Jun 18, 2026

Uh oh!

thatomokoena commented Jun 18, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

omri374 left a comment

Choose a reason for hiding this comment

Uh oh!

omri374 Jul 12, 2026

Choose a reason for hiding this comment

Uh oh!

omri374 Jul 12, 2026

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

thatomokoena commented Jun 17, 2026 •

edited

Loading

thatomokoena commented Jun 18, 2026 •

edited

Loading