insertIrreversibleToken()
insertIrreversibleToken() encrypts plaintext value(s), create token(s), insert into the token vault(s), and return the token(s).
Note
Also, the tokens generated using insertIrreversibleToken() method will not return the plaintext values, when passed in the get() method. The method will instead return the string value “Irreversible Token”.
If the plaintext value along with the custom data passed in, has already been tokenized using insert() method, this method simply returns the existing token. Such tokens are not irreversible tokens.
This API supports Unicode (multibyte format) tokens.
Syntax
public TmResult insertIrreversibleToken(string[] values, string[] customData, int format, string table, bool luhnCheck, bool saveExceptions, string[] tokenProperty, string[] customTokenProperty)
Request Parameters
Parameters | Data Types | Descriptions |
---|---|---|
values | string[] | Data to be tokenized. Input data can be no longer than 256 characters. |
format | integer | One of the following token formats or a format created using createNewFormat(). For more information about the available formats, see Token Formats. |
customData | string or string[] | The customer-specific data associated with the plaintext value(s): |
table | string | This is the Token Vault name and it must be in CAPITAL LETTERS. |
luhnCheck | boolean | Indicates if the value must pass a Luhn check (true) or if there is no requirement (false). Token formats created using the createNewFormat() method may have one of three luhnCheck rules (must fail test, no requirement, or must pass test). |
saveExceptions | boolean | When set to true, the Smart Check functionality is enabled. |
tokenProperty | String[] | The tokenProperty associated with the tokens to be created. |
customTokenProperty | string[] | The customTokenProperty associated with the tokens to be created. |
The priority of the luhnCheck boolean in insert() and the luhnCheck integer in createNewFormat() vary depending on their values, as shown in the following figure:
Returned Values
The output tokens, status and error details, if any.
Exception
Passes an exception if:
The format is invalid.
The value is null.
The luhnCheck value is invalid.