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

assert albania.is_valid("J00101999W")
assert not albania.is_valid("invalid")

decode raises 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.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.0-cp312-cp312-win_amd64.whl (131.7 kB view details)

Uploaded CPython 3.12Windows x86-64

nidx-0.2.0-cp312-cp312-manylinux_2_34_x86_64.whl (274.6 kB view details)

Uploaded CPython 3.12manylinux: glibc 2.34+ x86-64

nidx-0.2.0-cp312-cp312-macosx_11_0_arm64.whl (242.5 kB view details)

Uploaded CPython 3.12macOS 11.0+ ARM64

File details

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

File metadata

  • Download URL: nidx-0.2.0-cp312-cp312-win_amd64.whl
  • Upload date:
  • Size: 131.7 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.0-cp312-cp312-win_amd64.whl
Algorithm Hash digest
SHA256 706d4d51762dbf476e91052222f72f2e62ecf88b9b22303440831b1fb34a9212
MD5 9b5f12f38bbcac1e6f72b2ddc02ff24f
BLAKE2b-256 83e5aa1ac8e14c5fa009496ebc9f1d3db084749dba9f8b98479ebd02cf242257

See more details on using hashes here.

Provenance

The following attestation bundles were made for nidx-0.2.0-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.0-cp312-cp312-manylinux_2_34_x86_64.whl.

File metadata

File hashes

Hashes for nidx-0.2.0-cp312-cp312-manylinux_2_34_x86_64.whl
Algorithm Hash digest
SHA256 cc351a53e7fe59ffc903bf312b11dd78a3e3a8a932c841026ebf767ffb90ab5f
MD5 0738a0a0d789a7ac079ea3c875fd43fd
BLAKE2b-256 66ae4a42d247dc625d14ec22a104af7b0bc059f1ac13ab26cd29bfdc3d94e869

See more details on using hashes here.

Provenance

The following attestation bundles were made for nidx-0.2.0-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.0-cp312-cp312-macosx_11_0_arm64.whl.

File metadata

File hashes

Hashes for nidx-0.2.0-cp312-cp312-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 95422b986d97520f791fa12f6a7a15f9ae5e79a62a8f8b5eec735be58e7dd325
MD5 d6b84e6ac105ac7366fbcb048d1ebee5
BLAKE2b-256 a30c8836adeda473f801aa8a81cab12af6e1151f9349867cea0482aa5ff37289

See more details on using hashes here.

Provenance

The following attestation bundles were made for nidx-0.2.0-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