SSN (SsnGenerator)

The SSN generator generates a new valid United States Social Security number.

Link object structure

The SSN generator does not support linking. It can be self-consistent or consistent with another column. You cannot configure differential privacy.

The metadata object is populated from the RatioMetadata object.

For the SSN generator, ratio indicates the percentage of values to format with dashes (123-45-6789). The percentage is provided as a decimal value between 0 and 1.0.

The remaining values are formatted as 123456789.

{
  "schema": "string",
  "table": "string",
  "column": "string",
  "dataType": "string",  //MongoDB only
  "metadata": {
    "presetId": "string",
    "generatorId": "SsnGenerator",
    "ratio": numeric,
    "isConsistent": boolean,
    "consistencyColumn": "string",
    "encryptionProcessor": "x-on", //To use configured Structural data encryption
    "customValueProcessor": "string"  //If custom value processor applied
  }
}

Example replacement

In the following example replacement for the SSN generator, the generator is consistent with the name column.

None of the values are configured with dashes.

{
  "name": "employee-number",
  "schema": "public",
  "table": "employees",
  "links": [
    {
      "schema": "public",
      "table": "employees",
      "column": "employee-number",
      "metadata": {
        "presetId": "SsnGenerator",
        "generatorId": "SsnGenerator",
        "ratio": 0,
        "isConsistent": true,
        "consistencyColumn": "name"
      }
    }
  ]
}