PIN attributes

The
pin
element of the registration policy defines how the VIP PIN is supported. You can set the following values:
  • enabled
  • formatRestriction
  • minLength
  • expiration
  • reuseHistory
The following table lists the
pin
attributes available to the registration policy. The table also lists the default
pin
values.
Attributes of the
pin
element of
registrationPolicy
Attribute
Type
Description
Default Policy Value
enabled
String
Whether a user can enter a VIP PIN for first factor authentication (
Y
) or not (
N
).
You must send
"enabled": "Y"
when updating any
pin
attributes.
"enabled": "N"
expiration
String
The maximum number of days that a VIP PIN is valid before the user is prompted to reset it. A value of
0
indicates that the VIP PIN does not expire.
"expiration": 0
formatRestriction
String
The character configuration of the PIN. Set one of the following values:
  • numberOnly
    : The VIP PIN can only include numbers.
  • anyAlphaNum
    : The VIP PIN can include any combination of letters or numbers.
  • atLeastOneAlphaNum
    : The VIP PIN must include at least one number and one letter.
For letters, international characters are allowed, and letters are always case-sensitive.
"formatRestriction": "anyAlphaNum"
minLength
String
The minimum number of characters that are allowed in the VIP PIN. Value must be from 4 to 12, inclusive.
"minLength": 4
reuseHistory
String
The number of unique PINs the user must enter before the user can use a previous PIN again. Value must be from 0 through 15, inclusive.
VIP PINs set by the administrator for a user in VIP Manager can be reused and do not count towards the user’s unique PIN history.
"reuseHistory": 0