Class NationalID

South Africa national ID number format https://en.wikipedia.org/wiki/National_identification_number#South_Africa https://www.westerncape.gov.za/general-publication/decoding-your-south-african-id-number-0

Implements

IdNumberClass

Index

Constructors

Properties

Accessors

Methods

checksum parse validate checksum parse validate

Constructors

constructor

new NationalID(): ZAF.NationalID

Returns ZAF.NationalID

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/zaf/nationalId.ts:52

Methods

checksum

checksum(idNumber: string): CheckDigit
Calculate checksum (if applicable)
Parameters
- idNumber: string
Returns CheckDigit
Implementation of IdNumberClass.checksum
- Defined in countries/zaf/nationalId.ts:133

parse

parse(idNumber: string): ZAF.NationalIdParseResult | null
Parse ID number (if applicable)
Parameters
- idNumber: string
Returns ZAF.NationalIdParseResult | null
Implementation of IdNumberClass.parse
- Defined in countries/zaf/nationalId.ts:111

validate

validate(idNumber: string): boolean
Validate an ID number
Parameters
- idNumber: string
Returns boolean
Implementation of IdNumberClass.validate
- Defined in countries/zaf/nationalId.ts:66

`Static`checksum

checksum(idNumber: string): CheckDigit
Calculate checksum using Luhn algorithm.

Returns null when the input does not match the ID format, as the Python library does (#299).
Parameters
- idNumber: string
Returns CheckDigit
- Defined in countries/zaf/nationalId.ts:121

`Static`parse

parse(idNumber: string): ZAF.NationalIdParseResult | null
Parse South Africa national ID number
Parameters
- idNumber: string
Returns ZAF.NationalIdParseResult | null
- Defined in countries/zaf/nationalId.ts:73

`Static`validate

validate(idNumber: string): boolean
Validate the ZAF ID number
Parameters
- idNumber: string
Returns boolean
- Defined in countries/zaf/nationalId.ts:59