Optim Data Privacy Providers  11.7.0
 All Data Structures Files Functions Variables Macros Groups Pages
Specific Parameters
Collaboration diagram for Specific Parameters:

United Kingdom National ID Specific Parameters

The following defines are associated with the usParameterID member of DP_INIT_OP_DEF structure.

#define ODPP_OPR_NID_UK_PARTS   NIDOPERANDBASE + 3
 
#define ODPP_OPR_NID_UK_SEP   NIDOPERANDBASE + 9
 
#define ODPP_OPR_NID_UK_FLAGS   NIDOPERANDBASE + 12
 

Values for parameter ODPP_OPR_NID_UK_PARTS

#define ODPP_UK_PARTS_MASK_PREFIX   1
 

Values for parameter ODPP_OPR_NID_UK_FLAGS

#define ODPP_FLAG_UK_FORM_3_PART   1
 
#define ODPP_FLAG_UK_FORM_5_PART   2
 

Detailed Description

Macro Definition Documentation

#define ODPP_OPR_NID_UK_PARTS   NIDOPERANDBASE + 3
  • Use:
    This parameter is used to specify the subfield(s) to be masked.
  • Description:
    This parameter can be used to specify one or more subfields in the source United Kingdom National Insurance Number (NINO) to be masked.

    The following value is valid for this parameter:
  • Optional:
    Yes
  • Exclusive:
    N/A
  • Example:
    • ODPP_OPR_NID_UK_PARTS = ODPP_UK_PARTS_MASK_PREFIX
#define ODPP_OPR_NID_UK_SEP   NIDOPERANDBASE + 9
  • Use:
    This parameter is used to specify the separator to be used for the resultant NINO.
  • Description:
    This parameter specifies the separator to be used for the resultant United Kingdom National Insurance Number (NINO).

    The valid values for this parameter are:
    For the Mask method, the default is to use the same separator as the source for the resultant values. For the Random method, the default is to generate the resultant values without a separator. The separator values are mutually exclusive with each other.
  • Optional:
    Yes
  • Exclusive:
    N/A
  • Inclusive:
    N/A
  • Example:
    • ODPP_OPR_NID_UK_SEP = ODPP_SEP_DASH
#define ODPP_OPR_NID_UK_FLAGS   NIDOPERANDBASE + 12
  • Use:
    This parameter is used to specify flags for the United Kingdom National ID algorithm.
  • Description:
    There are different flags that can be specified using this parameter which will control the behaviour of the masking algorithm.
  • Optional:
    Yes
  • Exclusive:
    N/A
  • Inclusive:
    N/A
  • Example:
    • ODPP_OPR_NID_UK_FLAGS = ODPP_FLAG_UK_FORM_5_PART
#define ODPP_UK_PARTS_MASK_PREFIX   1
  • Use:
    This parameter value is used to mask the prefix of the source NINO.
  • Description:
    When this value is specified for parameter ODPP_OPR_NID_UK_PARTS, the Two letter prefix of the source United Kingdom National Insurance Number (NINO) is masked along with the Six digit serial.
  • Optional:
    Yes
  • Exclusive:
    N/A
  • Inclusive:
    N/A
  • Example:
    • ODPP_OPR_NID_UK_PARTS = ODPP_UK_PARTS_MASK_PREFIX
#define ODPP_FLAG_UK_FORM_3_PART   1
  • Use:
    This flag is used to format the masked NINO into Three parts.
  • Description:
    When this flag is specified the masked United Kingdom National Insurance Number (NINO) will be formatted into Three parts and will have one of the following formats depending on the separator used:
    • AB-123456-C
    • AB-123456
    • AB 123456 C
    • AB 123456
    • AB.123456.C
    • AB.123456

    This flag is mutually exclusive with flag ODPP_FLAG_UK_FORM_5_PART.
  • Optional:
    Yes
  • Example:
    • ODPP_OPR_NID_UK_FLAGS = ODPP_FLAG_UK_FORM_3_PART
#define ODPP_FLAG_UK_FORM_5_PART   2
  • Use:
    This flag is used to format the masked NINO into Five parts.
  • Description:
    When this flag is specified the masked United Kingdom National Insurance Number (NINO) will be formatted into Five parts and will have one of the following formats depending on the separator used:
    • AB-12-34-56-C
    • AB-12-34-56
    • AB 12 34 56 C
    • AB 12 34 56
    • AB.12.34.56.C
    • AB.12.34.56

    This flag is mutually exclusive with flag ODPP_FLAG_UK_FORM_3_PART.
  • Optional:
    Yes
  • Example:
    • ODPP_OPR_NID_UK_FLAGS = ODPP_FLAG_UK_FORM_5_PART