Class SocialInsuranceNumber

Canada Social Insurance Number (SIN) format https://en.wikipedia.org/wiki/Social_Insurance_Number https://www.canada.ca/en/employment-social-development/services/sin.html

Implements

IdNumberClass

Index

Constructors

Properties

Accessors

Methods

checksum validate checksum validate

Constructors

constructor

new SocialInsuranceNumber(): SocialInsuranceNumber

Returns SocialInsuranceNumber

Properties

`Static` `Readonly`METADATA

METADATA: IdMetadata = ...

Accessors

METADATA

get METADATA(): IdMetadata
Metadata for this ID type

Returns IdMetadata
Implementation of IdNumberClass.METADATA
- Defined in countries/can/socialInsurance.ts:37

Methods

checksum

checksum(idNumber: string): CheckDigit
Calculate checksum (if applicable)
Parameters
- idNumber: string
Returns CheckDigit
Implementation of IdNumberClass.checksum
- Defined in countries/can/socialInsurance.ts:98

validate

validate(idNumber: string): boolean
Validate an ID number
Parameters
- idNumber: string
Returns boolean
Implementation of IdNumberClass.validate
- Defined in countries/can/socialInsurance.ts:55

`Static`checksum

checksum(idNumber: string): CheckDigit
Calculate checksum for SIN Returns what the 9th digit should be to make the sum divisible by 10
Parameters
- idNumber: string
Returns CheckDigit
- Defined in countries/can/socialInsurance.ts:82

`Static`validate

validate(idNumber: string): boolean
Validate Canada Social Insurance Number Uses Luhn-like algorithm but for all 9 digits
Parameters
- idNumber: string
Returns boolean
- Defined in countries/can/socialInsurance.ts:45