feat: add Philippines TIN (PH_TIN) recognizer by aaronaco · Pull Request #2016 · microsoft/presidio

aaronaco · 2026-05-02T15:26:31Z

Change Description

This PR introduces the PhTinRecognizer (PH_TIN) to detect the Philippines Taxpayer Identification Number issued by the Bureau of Internal Revenue (BIR), as part of the broader proposal to add Philippines-specific PII recognizers.

Key changes included:

Added regex patterns to correctly identify both 9-digit (individual) and 12-digit (corporate/branch) TIN formats, including hyphenated variations (e.g., XXX-XXX-XXX and XXX-XXX-XXX-XXX).
Implemented the official BIR Weighted Modulo 11 check digit algorithm within validate_result to eliminate false positives and ensure high-confidence matches.
Incorporated Philippine-specific context words (e.g., "TIN", "BIR", "revenue district office").
Added comprehensive unit tests in tests/test_ph_tin_recognizer.py verifying valid/invalid structures, checksums, and context enhancement.
Included the new recognizer in the context enhancer test dataset (tests/data/context_sentences_tests.txt and tests/test_context_support.py).
Registered PhTinRecognizer in default_recognizers.yaml, default_analyzer_full.yaml, slim.yaml, and test configurations, ensuring it is enabled: false by default per project guidelines for country-specific recognizers.
Updated docs/supported_entities.md and CHANGELOG.md to reflect the new feature.

Issue reference

Fixes #2015

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

aaronaco · 2026-05-02T15:26:45Z

@microsoft-github-policy-service agree

Copilot

Pull request overview

Note

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

Introduces a new Philippines-specific PII recognizer (PH_TIN) to detect and validate Philippine Taxpayer Identification Numbers (TIN) using regex + context + checksum validation, and wires it into configuration, tests, and docs.

Changes:

Added PhTinRecognizer with regex patterns, PH-specific context terms, and weighted modulo-11 validation.
Integrated the recognizer into analyzer registries/configs and context-sentence datasets.
Added/updated unit tests and documentation (supported entities + changelog).

Reviewed changes

Copilot reviewed 12 out of 12 changed files in this pull request and generated 5 comments.

Show a summary per file

File	Description
presidio-analyzer/presidio_analyzer/predefined_recognizers/country_specific/philippines/ph_tin_recognizer.py	Adds the `PhTinRecognizer` implementation (patterns, context, checksum validation).
presidio-analyzer/presidio_analyzer/predefined_recognizers/country_specific/philippines/init.py	Exposes Philippines recognizers package exports.
presidio-analyzer/presidio_analyzer/predefined_recognizers/init.py	Registers `PhTinRecognizer` in the predefined recognizers public API.
presidio-analyzer/tests/test_ph_tin_recognizer.py	Adds unit tests for TIN detection + validation.
presidio-analyzer/tests/test_context_support.py	Adds `PH_TIN` to the context enhancer test harness and updates dataset size check.
presidio-analyzer/tests/data/context_sentences_tests.txt	Adds PH TIN context sentences for the context enhancer dataset.
presidio-analyzer/presidio_analyzer/conf/default_recognizers.yaml	Registers recognizer in default recognizers list (disabled by default).
presidio-analyzer/presidio_analyzer/conf/default_analyzer_full.yaml	Registers recognizer in full analyzer config (disabled by default).
presidio-analyzer/presidio_analyzer/conf/slim.yaml	Registers recognizer in slim analyzer config (disabled by default).
e2e-tests/resources/test_ollama_enabled_recognizers.yaml	Registers recognizer in e2e test recognizers config (disabled by default).
docs/supported_entities.md	Documents `PH_TIN` as a supported entity.
CHANGELOG.md	Adds a changelog entry for the new `PH_TIN` recognizer.

omri374 · 2026-05-05T12:58:42Z

+    The 9th digit is a check digit calculated using a weighted modulo 11 algorithm.
+    The last 3 digits (in the 12-digit version) represent the branch code (default 000).
+
+    Format: XXX-XXX-XXX-XXX or XXXXXXXXXXXX


please address

+  - name: PhTinRecognizer
+    supported_languages: 
+    - en
+    type: predefined


 #### Added
 - Canadian SIN (`CA_SIN`) recognizer for the Canadian Social Insurance Number, using regex pattern matching, context words (English and French), and Luhn checksum validation. Disabled by default.

+- Philippines TIN (`PH_TIN`) recognizer for the Philippines Taxpayer Identification Number, using regex pattern matching, context words, and weighted modulo 11 checksum validation.


omri374 · 2026-05-05T13:00:54Z

+        ("My TIN is 000-123-456-000", 1, [(10, 25)], [(0.1, 1.0)]),
+        ("BIR TIN: 000123456", 1, [(9, 18)], [(0.1, 1.0)]),
+        ("Tax ID: 000-123-456-001", 1, [(8, 23)], [(0.1, 1.0)]),
+        # Valid 9-digit with hyphens
+        ("TIN 000-123-456", 1, [(4, 15)], [(0.1, 1.0)]),
+        # Invalid TINs (wrong checksum)
+        ("Invalid TIN 000-123-457-000", 0, [], []),
+        ("Not a TIN 123456789", 0, [], []),
+        # Context tests
+        ("TIN: 000-123-456-000", 1, [(5, 20)], [(0.1, 1.0)]),
+        ("Please use 000-123-456-000 as your ID", 1, [(11, 26)], [(0.1, 1.0)]),


omri374 · 2026-05-05T12:58:59Z

+        if not pattern_text.isdigit():
+            return False
+
+        if len(pattern_text) not in [9, 12]:


please address

omri374 · 2026-05-05T12:58:04Z

+        Pattern(
+            "TIN (High)",
+            r"\b(\d{3}-\d{3}-\d{3}(-\d{3})?)\b",
+            0.6,


This is very high for a very common pattern. Consider reducing and boosting score with context and validation. I would suggest to reduce to 0.05

omri374 · 2026-05-05T12:58:13Z

+        Pattern(
+            "TIN (Medium)",
+            r"\b(\d{9}|\d{12})\b",
+            0.3,


Same here. 0.01

omri374 · 2026-05-05T12:58:42Z

+    The 9th digit is a check digit calculated using a weighted modulo 11 algorithm.
+    The last 3 digits (in the 12-digit version) represent the branch code (default 000).
+
+    Format: XXX-XXX-XXX-XXX or XXXXXXXXXXXX


please address

omri374 · 2026-05-05T12:58:59Z

+        if not pattern_text.isdigit():
+            return False
+
+        if len(pattern_text) not in [9, 12]:


please address

omri374 · 2026-05-05T13:00:54Z

+        ("My TIN is 000-123-456-000", 1, [(10, 25)], [(0.1, 1.0)]),
+        ("BIR TIN: 000123456", 1, [(9, 18)], [(0.1, 1.0)]),
+        ("Tax ID: 000-123-456-001", 1, [(8, 23)], [(0.1, 1.0)]),
+        # Valid 9-digit with hyphens
+        ("TIN 000-123-456", 1, [(4, 15)], [(0.1, 1.0)]),
+        # Invalid TINs (wrong checksum)
+        ("Invalid TIN 000-123-457-000", 0, [], []),
+        ("Not a TIN 123456789", 0, [], []),
+        # Context tests
+        ("TIN: 000-123-456-000", 1, [(5, 20)], [(0.1, 1.0)]),
+        ("Please use 000-123-456-000 as your ID", 1, [(11, 26)], [(0.1, 1.0)]),


omri374 · 2026-05-05T13:03:50Z

+
+  - name: PhTinRecognizer
+    supported_languages: 
+    - en


What about Filipino?

Good point. I think adding filipino is broader than this PR since Presidio’s analyzer and registry languages need to match and there isn’t an existing Filipino/Tagalog NLP config.

PH_TIN validation is language-independent, it still works when the analyzer runs under an enabled language like en.

aaronaco · 2026-05-08T17:38:19Z

Ready for another look.

feat: add Philippines TIN recognizer and related tests

0f77cb7

github-actions Bot added the external label May 2, 2026

SharonHart requested a review from Copilot May 4, 2026 09:21

Copilot AI reviewed May 4, 2026

View reviewed changes

Copilot started reviewing on behalf of SharonHart May 4, 2026 09:47 View session

omri374 reviewed May 5, 2026

View reviewed changes

Merge branch 'main' into feat/philippines-tin-number-recognizer

8164de0

omri374 reviewed May 5, 2026

View reviewed changes

aaronaco added 3 commits May 6, 2026 02:01

fix: address PH_TIN review cleanup

4fed892

fix: lower PH_TIN base scores

7b38d7b

test: tighten PH_TIN score expectations

cc5e457

aaronaco requested a review from omri374 May 8, 2026 17:36

fix: restore recognizer config order

737c728

Conversation

aaronaco commented May 2, 2026

Change Description

Issue reference

Checklist

Uh oh!

aaronaco commented May 2, 2026

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

aaronaco commented May 8, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants