Skip to main content

Validate and decode national ID numbers — extract structured data from government-issued personal IDs

Project description

nidx

PyPI CI License: MIT

Validate and extract information from national ID numbers across multiple countries.

Also available for Rust and JavaScript.

Installation

pip install nidx

Requires Python 3.9+.

Supported countries

Country Module Extracted fields
Albania albania Date of birth, sex, national status
Kosovo kosovo Validation only

Usage

Albania

from nidx import albania

info = albania.decode("J00101999W")
print(info.birthday)    # 1990-01-01
print(info.sex)         # M
print(info.is_national) # True
print(info.year)        # 1990
print(info.month)       # 1
print(info.day)         # 1

albania.validate("J00101999W")  # raises on invalid input
assert albania.is_valid("J00101999W")
assert not albania.is_valid("invalid")

validate and decode raise NidFormatError, NidChecksumError, or NidInvalidDateError on invalid input (all subclasses of NidError, which is a ValueError).

Kosovo

from nidx import kosovo

kosovo.validate("1234567892")  # raises on invalid input

assert kosovo.is_valid("1234567892")
assert not kosovo.is_valid("invalid")

API

Albania

albania.validate(nid: str) -> None — validates a 10-character Albanian NID. Raises on invalid input.

albania.decode(nid: str) -> NidInfo — validates and decodes a 10-character Albanian NID. Input is case-insensitive.

Field Type Description
birthday str Date of birth (ISO 8601)
year int Birth year
month int Birth month
day int Birth day
sex str "M" or "F"
is_national bool Whether the person is an Albanian national

albania.is_valid(nid: str) -> bool — returns True if the NID is valid.

Kosovo

kosovo.validate(nid: str) -> None — validates a 10-digit Kosovo personal number. Raises on invalid input.

kosovo.is_valid(nid: str) -> bool — returns True if the personal number is valid.

Exceptions

Exception Parent Raised when
NidError ValueError Base exception for all NID errors
NidFormatError NidError Input has wrong length or characters
NidChecksumError NidError Checksum digit doesn't match
NidInvalidDateError NidError Encoded date is not a valid calendar date

License

MIT

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distributions

If you're not sure about the file name format, learn more about wheel file names.

nidx-0.2.6-cp312-cp312-win_amd64.whl (132.0 kB view details)

Uploaded CPython 3.12Windows x86-64

nidx-0.2.6-cp312-cp312-manylinux_2_34_x86_64.whl (275.2 kB view details)

Uploaded CPython 3.12manylinux: glibc 2.34+ x86-64

nidx-0.2.6-cp312-cp312-macosx_11_0_arm64.whl (243.2 kB view details)

Uploaded CPython 3.12macOS 11.0+ ARM64

File details

Details for the file nidx-0.2.6-cp312-cp312-win_amd64.whl.

File metadata

  • Download URL: nidx-0.2.6-cp312-cp312-win_amd64.whl
  • Upload date:
  • Size: 132.0 kB
  • Tags: CPython 3.12, Windows x86-64
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for nidx-0.2.6-cp312-cp312-win_amd64.whl
Algorithm Hash digest
SHA256 d66a3a3678e001de3e6bacc8ae504f23a480db49747f4af55092478925d2e228
MD5 6884628b01cca0c926fcadf719860cee
BLAKE2b-256 370c61dfbc3c87a128f2c2eeff77c85a6b219b70598805d9b6c9db93df8b9412

See more details on using hashes here.

Provenance

The following attestation bundles were made for nidx-0.2.6-cp312-cp312-win_amd64.whl:

Publisher: release.yml on dedal-io/nidx

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file nidx-0.2.6-cp312-cp312-manylinux_2_34_x86_64.whl.

File metadata

File hashes

Hashes for nidx-0.2.6-cp312-cp312-manylinux_2_34_x86_64.whl
Algorithm Hash digest
SHA256 45a831e4d2915a8a506b13fbbc3710df4957b4152dff8c2b618eaf231e8956ba
MD5 ab3fd297db6689a18dc95c75e0d74843
BLAKE2b-256 e27248376d277ce21328766bb2d208dd3e5742df01e99c3625ab41773ab302e5

See more details on using hashes here.

Provenance

The following attestation bundles were made for nidx-0.2.6-cp312-cp312-manylinux_2_34_x86_64.whl:

Publisher: release.yml on dedal-io/nidx

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file nidx-0.2.6-cp312-cp312-macosx_11_0_arm64.whl.

File metadata

File hashes

Hashes for nidx-0.2.6-cp312-cp312-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 f4183dc4017e2fda6cee946b27991b97cd658face7f622766823bba2737d1244
MD5 69db929d4e36de357ff7b177901e63b1
BLAKE2b-256 a34f88f3d01143ab1f51a6dee2c0aa086174f1768269af60d611c079eb16c7c0

See more details on using hashes here.

Provenance

The following attestation bundles were made for nidx-0.2.6-cp312-cp312-macosx_11_0_arm64.whl:

Publisher: release.yml on dedal-io/nidx

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page