Checkdigit (Algorithm frameworks)

The checkdigit framework masks values containing digits with a calculated checkdigit.

The framework is purpose built to support a number of built in instances with similar but unique compositions:

  1. Japan Corporate Number

  2. Japan Drivers License

  3. Japan My Number

It has also been extended to support Australian TFN number masking configuration.

The Checkdigit framework contains several flexible options that may support other use cases requiring a modulus calculation and checkdigit. Further custom instances can be built using the algorithm API. The configuration options are also described in the documentation for API management.

Additional options required for similar cases but not currently supported in the framework are a feature request. Masking unsupported input might be achieved by coupling an instance of Checkdigit with frameworks Regex Decompose and String Algorithm Chain.

While the framework may support other use cases, it’s primary purpose is to support masking the above build in Japanese identifier number algorithms, and the creation of Australian TFN instances.

Creating a regex decompose algorithm

Further instances of Checkdigit are created through the API.

Examples

Refer to the examples in the documentation for default instances of the framework:

  1. Japan Corporate Number

  2. Japan Drivers License

  3. Japan My Number