Class SocialSecurityNumber

constructor

• new SocialSecurityNumber(): FRA.SocialSecurityNumber

  Returns FRA.SocialSecurityNumber

Static ReadonlyMETADATA

METADATA

• get METADATA(): IdMetadata

  Metadata for this ID type

  Returns IdMetadata

checksum

• checksum(idNumber: string): boolean

  Calculate checksum (if applicable)

  Parameters

  • idNumber: string

  Returns boolean

parse

• parse(idNumber: string): FranceParseResult | null

  Parse ID number (if applicable)

  Parameters

  • idNumber: string

  Returns FranceParseResult | null

validate

• validate(idNumber: string): boolean

  Validate an ID number

  Parameters

  • idNumber: string

  Returns boolean

Staticchecksum

• checksum(idNumber: string): boolean

  Calculate checksum for French Social Security Number The control key is calculated as 97 - (first 13 digits modulo 97) For Corsica departments, letters must be replaced for calculation

  Parameters

  • idNumber: string

  Returns boolean

Staticparse

• parse(idNumber: string): FranceParseResult | null

  Parse French Social Security Number

  Parameters

  • idNumber: string

  Returns FranceParseResult | null

Staticvalidate

• validate(idNumber: string): boolean

  Validate French Social Security Number Format: SYYMMDDCCCOOKKK S = sex (1=male, 2=female, 3=male temporary, 4=female temporary, 7=male foreign, 8=female foreign) YY = year of birth (last 2 digits) MM = month of birth (01-12 for known, 20-99 for unknown) DD = department of birth (01-99, 2A, 2B for Corsica) CCC = commune code (3 digits) OOO = order number (3 digits) KK = checksum (control key)

  Parameters

  • idNumber: string

  Returns boolean

StaticvalidateBirthDepartment

• validateBirthDepartment(birthDepartment: string): BirthDepartment | null

  Validate birth department according to French rules

  Parameters

  • birthDepartment: string

  Returns BirthDepartment | null