Finnish SSN validation and creation
- A micro Javascript library for validating and creating Finnish social security numbers
- Zero dependencies
- This is a fork of vkomulai/finnish-ssn.
- adds support for new formats of Finnish personal identity codes (valid from 2023)
Installation
npm install finnish-ssn-2Usage
ES6 / TypeScript
import { FinnishSSN } from 'finnish-ssn-2'
const isValid = FinnishSSN.validate('010101C100X')
console.log(isValid) // Yields trueExamples
Validate an SSN
// This is a valid SSN
console.log('valid ssn returns ' + FinnishSSN.validate('290296-7808'))
// 'valid ssn returns true'
// This is an invalid SSN
console.log('invalid ssn returns ' + FinnishSSN.validate('010198Y1000'))
// 'invalid ssn returns false'Parse SSN
// This is a valid SSN
var parsedSsn = FinnishSSN.parse('290296W7808')
console.log(parsedSsn)
//
// {
// valid: true,
// sex: 'female',
// ageInYears: 19,
// dateOfBirth: Thu Feb 29 1996 00:00:00 GMT+0200 (EET)
//}Create an SSN for person that is 20 years old.
console.log('SSN for person that is 20 years old ' + FinnishSSN.createWithAge(20))
// SSN for person that is 20 years old 010195-XXXXFunctions
#validate(ssn)
- Validates parameter given SSN. Returns true if SSN is valid, otherwise false
#parse(ssn)
- Parses parameter given SSN. Returns object
{valid: boolean, sex: "male|female", ageInYears: Number, dateOfBirth: Date }
{
valid: false,
sex: null,
ageInYears: null,
dateOfBirth: null
}
{
valid: true,
sex: 'male',
ageInYears: 15,
dateOfBirth: Tue Feb 29 2000 00:00:00 GMT+0200 (EET)
}
{
valid: true,
sex: 'female',
ageInYears: 15,
dateOfBirth: Mon Feb 28 2000 00:00:00 GMT+0200 (EET)
}#createWithAge(age)
- Creates a valid SSN using the given age (Integer). Generates randomly male and female SSN's.
Building
npm run dist
# Run tests
npm run test
# Run tests in watch-mode
npm run test:watchChangelog
1.0.1
- Update of README.md
1.0.0
- Support for new formats of Finnish personal identity code (valid from 2023)
0.9.0
- Initial release (forked from vkomulai/finnish-ssn)