# stdnum.in_.aadhaar

Aadhaar (Indian digital resident personal identity number)

Aadhaar is a 12 digit unique identity number issued to all Indian residents. The number is assigned by the Unique Identification Authority of India (UIDAI).

More information:

- https://en.wikipedia.org/wiki/Aadhaar

    >>> validate('234123412346')
    '234123412346'
    >>> validate('234123412347')
    Traceback (most recent call last):
        ...
    InvalidChecksum: ...
    >>> validate('123412341234')  # number should not start with 0 or 1
    Traceback (most recent call last):
        ...
    InvalidFormat: ...
    >>> validate('643343121')
    Traceback (most recent call last):
        ...
    InvalidLength: ...
    >>> format('234123412346')
    '2341 2341 2346'
    >>> mask('234123412346')
    'XXXX XXXX 2346'

`stdnum.in_.aadhaar.``aadhaar_re` = re.compile('^[2-9][0-9]{11}$')

  Regular expression used to check syntax of Aadhaar numbers.

`stdnum.in_.aadhaar.``compact`(number)

  Convert the number to the minimal representation. This strips the number of any valid separators and removes surrounding whitespace.

`stdnum.in_.aadhaar.``format`(number)

  Reformat the number to the standard presentation format.

`stdnum.in_.aadhaar.``is_valid`(number)

  Check if the number provided is a valid Aadhaar number. This checks the length, formatting and check digit.

`stdnum.in_.aadhaar.``mask`(number)

  Masks the first 8 digits as per MeitY guidelines for securing identity information and Sensitive personal data.

`stdnum.in_.aadhaar.``validate`(number)

  Check if the number provided is a valid Aadhaar number. This checks the length, formatting and check digit.