Simple validator for identification numbers based on the Luhn algorithm

# luhn-validator

A Python package to validate identification numbers using Luhn algorithm with additional optional checks.

## Overview

The Luhn algorithm or Luhn formula, also known as the "modulus 10" or "mod 10" algorithm, named after its creator, IBM scientist Hans Peter Luhn, is a simple checksum formula used to validate a variety of identification numbers, such as:

• US National Provider Identifier numbers.
• Canadian Social Insurance Numbers.
• Saudi Arabia National and Resident ID numbers.
• South African ID numbers.
• Swedish National identification numbers.
• Swedish Corporate Identity Numbers (OrgNr).
• Greek Social Security Numbers (ΑΜΚΑ).
• Credit card numbers.
• IMEI numbers.

The algorithm is in the public domain and is in wide use today. It was designed to protect against accidental errors. Most credit cards and many government identification numbers use the algorithm as a simple method of distinguishing valid numbers from mistyped or otherwise incorrect numbers.

## Features

• Simple API to validate numbers based on the Luhn algorithm.
• Extended validation to cover number length and/or prefix(es).
• Can validate numbers containing hyphens or spaces.
• Works on Python 3.6+ with zero dependencies.
• Thoroughly tested with 100% test coverage.

## Installation

To install using `pip`, run:

```pip install luhn-validator
```

## Usage Examples

```>>> from luhn_validator import validate

>>> # Simple checksum validation
>>> validate("1101798278")
True

>>> # Additional check for length (9 digits)
>>> validate("1101798278", 9)
False

>>> # Additional checks for prefix (either 1 or 2)
>>> validate("1101798278", 10, ["1", "2"])
True

>>> # Validate numbers containing hyphens
>>> validate("01-055102-109831-4", None, "01")
True
```

## API Reference

### function`validate`

```validate(
number: str,
length: int | None = None,
prefix: str | list[str] | None = None
) -> bool
```

Validate checksum and format of an identification number based on the Luhn algorithm.

Args:

• `number`: Identification number to validate.
• `length`: How many digits the number must contain. (The default is `None`, which implies skipping the length check).
• `prefix`: Exact digit(s) the number must start with. When a list of digits is provided, one of the values must match. (The default is `None`, which implies skipping the prefix check).

Returns:

• `True` when the number is valid, otherwise `False`.

## Release history Release notifications | RSS feed

Uploaded `source`
Uploaded `py3`