@meitner/personnummer.js v2.2.0

personnummer.js

JavaScript script (written in TypeScript) to validate and parse Swedish personal identity numbers. Fixes problems other packages fail to fix, e.g.: leap years, co-ordination numbers (samordningsnummer), parsing, and strict validation. All in one small package without dependencies. Works for Swedish personal numbers of all formats, see example below.

Also works with Swedish organisations numbers.

Installing

Install the module with npm: npm install personnummer.js

Basic usage

var personnummer = require("personnummer.js");

// valid personal number formats: yymmdd-nnnn yyyymmdd-nnnn yymmddnnnn yyyymmddnnnn yymmdd+nnnn yyyymmdd+nnnn
// valid personal number formats ex.: 040506-7356, 9912188324, 19780329-2833, 201005047640, 180604+0448

personnummer.validate("970214-9890");
// true

personnummer.validate("0708089396");
// true

personnummer.validate("123456-7890");
// false

personnummer.normalise("870724-1082");
// '198707241082'

personnummer.parse("19710904-5307");
/*
{
  valid: true,
  type: 'PERSONNUMMER',
  input: '19710904-5307',
  normalised: '197109045307',
  date: 1971-09-04T00:00:00.000Z,
  age: 47,
  gender: 'FEMALE',
  birthplace: 'Göteborgs och bohus län'
}
*/

personnummer.parseCIN("556007-3495");
/*
{
  valid: true,
  type: 'Aktiebolag',
  input: '556007-3495',
  normalised: '165560073495'
}
*/

Functions

Personal Number

Description

Returns

Options

Recommended options are: {strict:true, forgiving:false}. The forgiving option overrides the strict option.

Examples

var personnummer = require("personnummer.js");

personnummer.parse("980417+6320", { strict: false, forgiving: false });
/*
{
  valid: true,
  type: 'PERSONNUMMER',
  input: '980417+6320',
  normalised: '189804176320',
  date: 1898-04-17T00:00:00.000Z,
  age: 121,
  gender: 'FEMALE',
  birthplace: 'Värmlands län'
}
*/

personnummer.parse("980417+6320", { strict: true, forgiving: false });
// { valid: false, reason: 'age is too old', input: '980417+6320' }

personnummer.parse("980417+6320", { strict: true, forgiving: true });
/*
{
  valid: true,
  type: 'PERSONNUMMER',
  input: '980417+6320',
  normalised: '199804176320',
  date: 1998-04-17T00:00:00.000Z,
  age: 21,
  gender: 'FEMALE',
  birthplace: undefined
}
*/

personnummer.parse("0411643844");
/*
{
  valid: true,
  type: 'SAMORDNINGSNUMMER',
  input: '0411643844',
  normalised: '200411643844',
  date: 2004-11-04T00:00:00.000Z,
  age: 14,
  gender: 'FEMALE',
  birthplace: undefined
}
*/

Invalid reasons

Possible reasons the parse function could return if personal number is invalid.

if strict option is enabled:

Corporate Identity Number (CIN)

Note that a CIN in Sweden can be a personal number. This package takes that into account, ex. parsing a valid personal number to this function will return type:'Enskild firma' (along with other properties).

Description

Returns

Invalid reasons

Possible reasons the parse function could return if personal number is invalid.

Examples

var personnummer = require("personnummer.js");

personnummer.parseCIN("556007-3495");
/*
{
  valid: true,
  type: 'Aktiebolag',
  input: '556007-3495',
  normalised: '165560073495'
}
*/

personnummer.parseCIN("19870923-7393");
/*
{
  valid: true,
  type: 'Enskild firma',
  input: '19870923-7393',
  normalised: '198709237393',
  date: 1987-09-23T00:00:00.000Z,
  age: 31,
  gender: 'MALE',
  birthplace: 'Kopparbergs län'
}
*/

personnummer.parseCIN("556339-2279");

/*
{
  valid: false,
  reason: 'CHECKSUM',
  input: '556238-2279'
}
*/

Testing

Run npm test (make sure you have all devDependencies installed)

Contributing

See CONTRIBUTING.md

License

MIT See LICENSE