https://github.com/knugihk/hong-kong-id-card-verification-algorithm-multilang

An algorithm for verifying Hong Kong ID Card (HKID) number in different languages
https://github.com/knugihk/hong-kong-id-card-verification-algorithm-multilang

algorithm card-verification-algorithm csharp hkid hkid-verification hong-kong hong-kong-id javascript library python

Last synced: 2 months ago
JSON representation

An algorithm for verifying Hong Kong ID Card (HKID) number in different languages

• Host: GitHub
• URL: https://github.com/knugihk/hong-kong-id-card-verification-algorithm-multilang
• Owner: KnugiHK
• License: mit
• Created: 2018-11-28T11:38:21.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2022-04-04T15:59:50.000Z (about 3 years ago)
• Last Synced: 2024-10-06T13:41:50.089Z (8 months ago)
• Topics: algorithm, card-verification-algorithm, csharp, hkid, hkid-verification, hong-kong, hong-kong-id, javascript, library, python
• Language: C#
• Homepage:
• Size: 48.8 KB
• Stars: 5
• Watchers: 0
• Forks: 5
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Hong-Kong-ID-Card-verification-algorithm

[![Python package](https://github.com/KnugiHK/Hong-Kong-ID-Card-Verification-Algorithm-MultiLang/workflows/Python%20package/badge.svg)](https://github.com/KnugiHK/Hong-Kong-ID-Card-Verification-Algorithm-MultiLang/actions)

An algorithm for verifying Hong Kong ID Card number.

# Features

1. Verify a HKID

1. Calculate check digit for a HKID

# Supported Language

1. Python (Development)

1. JavaScript  (May not up-to-date and higher translation priority)

1. C# (May not up-to-date and lower translation priority)

# Usage

## Python

*This algorithm is now support Python 2 and 3*

**Run in shell**

```shell

python HKID_Verification.py

Please provide your Hong Kong ID Card number including letter and digit in bracket such as "L5555550" (For security reason, value you typed will not be displayed): AY987654A

```

**Run as library**

```python

from HKID_Verification import verify 

ID = "AY987654A"

print(verify(id))

```

## JavaScript

Place .js file in the path you want and add a  tag to link the file to webpage and call function with "HKIDverification(id)" where "(id)" is target HKID Card number

## C#

To-Do....

# To-Do

1. New feature: HKID Card number generator

2. Documentation and usage