VGSSSNTokenizationParameters

@MainActor
public struct VGSSSNTokenizationParameters : VGSTokenizationParametersProtocol

VGSSSNTokenizationParameters - parameters required for tokenization api.

Summary: Defines how US Social Security Number input (FieldType .ssn) is transformed into an alias when using Vault tokenization or alias creation APIs.

Properties:

  • storage: Vault storage type (persistent by default for reuse on backend workflows).
  • format: Alias format representation (default .UUID ensures fully opaque alias value).

Usage:

var ssnParams = VGSSSNTokenizationParameters()
ssnParams.format = VGSVaultAliasFormat.UUID.rawValue // or another supported alias format
let ssnCfg = VGSSSNTokenizationConfiguration(collector: collector, fieldName: "user_ssn")
ssnCfg.tokenizationParameters = ssnParams
ssnField.configuration = ssnCfg

Notes:

  • Changing format impacts only alias output, not validation or masking.
  • Keep SSN input formatting & validation in formatPattern and rule set (VGSValidationRulePattern).