Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Finland Identity Number Library
JavaScript
Branch: master

Fetching latest commit…

Cannot retrieve the latest commit at this time

Failed to load latest commit information.
examples
src
tests
.gitignore
.jshintrc
.travis.yml
LICENSE.txt
README.md
lint.json
package.json

README.md

Build Status

Finnish Identity Number Library

Description

This library is a collection of functions dealing with Finnish specific identification numbers.

Features

  • hetu -- Finnish HETU numbers
  • ytunnus -- Finnish corporate IDs
  • refnum -- Invoice reference numbers (viitenumero)
  • pankkiviivakoodi -- Virtual bank transfer numbers (virtuaaliviivakoodi)

Installation for Node.js

Simplest way to install is to use npm, just simply npm install fin-id.

Authors

License

MIT-style license, see INSTALL.txt.

Initializing

Each feature is a property:

var hetu = require('fin-id').hetu;

See examples/ for full examples.

Hetu

The call hetu.check(hetu) returns true if the argument is valid ID:

if(hetu.check('010171-1234')) console.log("valid");
else console.log("invalid");

The call hetu.parse(hetu) returns an object with additional information:

var parsed = hetu.parse('010171-1234');
if(parsed) {
    console.log("birthday is " + parsed.date());  // Fri, 01 Jan 1971
    console.log("sex is " + parsed.sex());        // 'female'
}

Reference number (viitenumero)

var refnum = require('fin-id').refnum;

To create reference number use .create(num)

refnum.create(1234);
=> '12344'

To check reference number use .check(num)

refnum.check('12344');
=> true

To strip the number back to original use .strip(refnum)

refnum.strip('12344');
=> '1234'

Virtual bank transfer number (virtuaaliviivakoodi)

var viivakoodi = require('fin-id').pankkiviivakoodi;

To create number use .create(...)

viivakoodi.create({
    iban: 'FI21 1234 5600 0007 85',
    cents: 1000,
    duedate: '2015-03-01',
    refnum: 13
});
=> '421123456000007850000100000000000000000000000013150301'

To check numbers use .check(num)

viivakoodi.check('421123456000007850000100000000000000000000000013150301');
=> true

TODO

Commercial Support

You can buy commercial support from Sendanor.

Something went wrong with that request. Please try again.