README

A PHP package to validate and identify Swedish personal numbers (personnummer), organization numbers (organisationsnummer) and VAT numbers (momsregistreringsnummer).

Usage

Auto-detect identity type

use Rooberthh\Identity\Identity;

$identity = Identity::identify('770604-0016');
// Returns PersonalNumber instance

$identity = Identity::identify('556074-7569');
// Returns OrganizationNumber instance

$identity = Identity::identify('SE556074756901');
// Returns VatNumber instance

Safe identification (no exceptions)

$identity = Identity::tryIdentify('invalid-number');
// Returns null instead of throwing exception

if ($identity = Identity::tryIdentify($input)) {
    // Valid identity
}

Personal number validation

use Rooberthh\Identity\PersonalNumber;

// Validate without creating object
if (PersonalNumber::isValid('770604-0016')) {
    // Valid personal number
}

// Create instance (throws exception if invalid)
$person = new PersonalNumber('770604-0016');

Personal number formatting

use Rooberthh\Identity\Enums\Format;

$person = new PersonalNumber('7706040016');

$person->format(Format::Short);               // "7706040016"
$person->format(Format::ShortWithSeparator);  // "770604-0016"
$person->format(Format::Long);                // "197706040016"
$person->format(Format::LongWithSeparator);   // "19770604-0016"

Extract metadata from personal number

$person = new PersonalNumber('770604-0016');

$person->getBirthDate();  // DateTimeImmutable: 1977-06-04
$person->getAge();        // int (calculated from today)
$person->getGender();     // Gender::Male
$person->isMale();        // true
$person->isFemale();      // false
$person->isOfAge(18);     // true

Centenarians (100+ years old)

// The + separator indicates a person born 100+ years ago
$person = new PersonalNumber('770604+0016');

$person->isCentenarian();                     // true
$person->getBirthDate();                      // DateTimeImmutable: 1877-06-04
$person->format(Format::ShortWithSeparator);  // "770604+0016"

Coordination numbers (samordningsnummer)

// Coordination numbers have day + 60
$person = new PersonalNumber('770664-0005');

$person->isCoordinationNumber(); // true
$person->getBirthDate();  // DateTimeImmutable: 1977-06-04

Organization number validation

use Rooberthh\Identity\OrganizationNumber;

if (OrganizationNumber::isValid('556074-7569')) {
    // Valid organization number
}

$org = new OrganizationNumber('5560747569');
$org->format(Format::ShortWithSeparator);  // "556074-7569"

VAT number (momsregistreringsnummer)

A Swedish VAT number is SE + the 10-digit organization number (or personal number for sole traders) + 01.

use Rooberthh\Identity\VatNumber;

if (VatNumber::isValid('SE556074756901')) {
    // Valid VAT number
}

$vat = new VatNumber('se 556074-7569 01');
$vat->format(Format::Long);  // "SE556074756901"
$vat->getIdentityNumber();   // OrganizationNumber (or PersonalNumber for sole traders)
$vat->isSoleTrader();        // false

// Create from an existing organization or personal number
VatNumber::fromIdentityNumber(new OrganizationNumber('556074-7569'))->format(Format::Long); // "SE556074756901"

Error handling

use Rooberthh\Identity\Exceptions\IdentityException;

try {
    $person = new PersonalNumber('invalid');
} catch (IdentityException $e) {
    // "'invalid' is not valid personal number."
}

Laravel Usage

Validation Rules

<?php

namespace App\Http\Requests;

use Illuminate\Foundation\Http\FormRequest;
use Rooberthh\Identity\Rules\PersonalNumberRule;
use Rooberthh\Identity\Rules\OrganizationNumberRule;
use Rooberthh\Identity\Rules\VatNumberRule;
use Rooberthh\Identity\Rules\IdentityRule;

class StoreCustomerRequest extends FormRequest
{
    public function rules(): array
    {
        return [
            // Validate personal number only
            'personal_number' => ['required', new PersonalNumberRule],

            // Validate organization number only
            'organization_number' => ['required', new OrganizationNumberRule],

            // Validate VAT number only
            'vat_number' => ['required', new VatNumberRule],

            // Validate any type (personal, organization or VAT)
            'identity_number' => ['required', new IdentityRule],
        ];
    }
}

Model Casts

<?php

namespace App\Models;

use Illuminate\Database\Eloquent\Model;
use Rooberthh\Identity\Casts\PersonalNumberCast;
use Rooberthh\Identity\Casts\OrganizationNumberCast;
use Rooberthh\Identity\Casts\VatNumberCast;
use Rooberthh\Identity\Casts\IdentityCast;

class Customer extends Model
{
    protected function casts(): array
    {
        return [
            'personal_number' => PersonalNumberCast::class,
            'organization_number' => OrganizationNumberCast::class,
            'vat_number' => VatNumberCast::class,
            'identity_number' => IdentityCast::class,  // Auto-detects type
        ];
    }
}

Usage with Casted Attributes

$customer = Customer::find(1);

// Personal number - returns PersonalNumber object
$customer->personal_number->format(Format::ShortWithSeparator);  // "770604-0016"
$customer->personal_number->format(Format::Long);                // "197706040016"
$customer->personal_number->getBirthDate();                      // DateTimeImmutable
$customer->personal_number->getAge();                            // 48
$customer->personal_number->getGender();                         // Gender::Male
$customer->personal_number->isMale();                            // true

// Organization number - returns OrganizationNumber object
$customer->organization_number->format(Format::ShortWithSeparator);  // "556074-7569"

// Identity cast - auto-detects and returns appropriate type
if ($customer->identity_number instanceof PersonalNumber) {
    echo $customer->identity_number->getAge();
}

// Setting values - accepts string or object
$customer->personal_number = '770604-0016';
$customer->personal_number = new PersonalNumber('770604-0016');
$customer->save();  // Stored as "197706040016" (long format)

rooberthh / identity

Package info

Security

Statistics