https://github.com/dale-french/south-african-id-validator
Dead simple validator for South African ID numbers 🇿🇦
https://github.com/dale-french/south-african-id-validator
Last synced: 15 days ago
JSON representation
Dead simple validator for South African ID numbers 🇿🇦
- Host: GitHub
- URL: https://github.com/dale-french/south-african-id-validator
- Owner: dale-french
- License: mit
- Created: 2020-02-28T15:17:11.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2023-01-05T08:35:48.000Z (over 2 years ago)
- Last Synced: 2025-04-19T04:13:56.950Z (about 1 month ago)
- Language: JavaScript
- Size: 1.34 MB
- Stars: 5
- Watchers: 1
- Forks: 4
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# 🇿🇦 south-african-id-validator 🇿🇦
Dead simple validator for South African ID numbers. Takes eligibility age into account (16 years).
This validator returns the following if the ID Number is valid
- Gender
- Date of birth
- Citizenship
## Usage
Install using NPM / Yarn
```bash
npm i south-african-id-validator
```
```bash
yarn add south-african-id-validator
```
```js
import { parseDOB, parseCitizenship, parseGender, validateIdNumber } from "south-african-id-validator";
// all functions take ID number string as input eg:
validateIdNumber(
ID_NUMBER_TO_VALIDATE // string
);
// examples
console.log(parseDOB('7311190013080'));
// Date -> Mon Nov 19 1973 00:00:00 GMT+0200 (South Africa Standard Time)
console.log(parseCitizenship('7311190013080'));
// true
console.log(parseGender('7311190013080'));
// "female"
console.log(validateIdNumber('7311190013080'));
// { DOB: Mon Nov 19 1973 00:00:00 GMT+0200 (South Africa Standard Time), gender: "female", isCitizen: true, valid: true }
```
### Demo
[https://codesandbox.io/s/compassionate-northcutt-ft0o8](https://codesandbox.io/s/compassionate-northcutt-ft0o8)