nidx

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

The core library is written in Rust with zero dependencies and provides bindings for Python and JavaScript/WASM.

Supported countries

Installation

Rust

[dependencies]
nidx = "0.2"

Optional serde support:

[dependencies]
nidx = { version = "0.2", features = ["serde"] }

Python

pip install nidx

JavaScript / TypeScript

npm install nidx

Usage

Rust

use nidx::albania;
use nidx::kosovo;
use nidx::Sex;

fn main() {
    // Albania: decode extracts structured data
    let info = albania::decode("J00101999W").unwrap();
    println!("{}", info.birthday);   // 1990-01-01
    println!("{}", info.sex);        // M
    println!("{}", info.is_national); // true

    assert!(albania::is_valid("J00101999W"));

    // Kosovo: validation only
    assert!(kosovo::validate("1234567892").is_ok());
    assert!(kosovo::is_valid("1234567892"));
}

Python

from nidx import albania, kosovo

# Albania: decode extracts structured data
info = albania.decode("J00101999W")
print(info.birthday)    # 1990-01-01
print(info.sex)         # M
print(info.is_national) # True

assert albania.is_valid("J00101999W")

# Kosovo: validation only
kosovo.validate("1234567892")  # raises on invalid input
assert kosovo.is_valid("1234567892")

validate and decode raise ValueError on invalid input.

JavaScript

import { Albania, Kosovo } from "nidx";

// Albania: decode extracts structured data
const info = Albania.decode("J00101999W");
console.log(info.birthday);   // "1990-01-01"
console.log(info.sex);        // "M"
console.log(info.isNational); // true

Albania.validate("J00101999W"); // throws on invalid input
console.log(Albania.isValid("J00101999W")); // true

// Kosovo: validation only
Kosovo.validate("1234567892"); // throws on invalid input
console.log(Kosovo.isValid("1234567892")); // true

validate and decode throw on invalid input.

API

Every country exposes validate(nid) and is_valid(nid). Countries with extractable data also expose decode(nid).

Albania

albania::validate(nid) checks a 10-character Albanian NID. Returns an error (or throws) on invalid input.

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

NidInfo fields:

Kosovo

kosovo::validate(nid) checks a 10-digit Kosovo personal number. Returns an error (or throws) on invalid input.

Contributing

See CONTRIBUTING.md.

License

MIT