SendTemporaryPassword for SMS OTP request
SendTemporaryPassword for SMS OTP input fields provides details about the SendTemporaryPassword for SMS OTP input fields. Send the request to:
Input Field | Required? | Type | Purpose |
|---|---|---|---|
TokenId | Y | String | Specifies the credential ID that identifies the credential to the VIP Web Services. |
PhoneNumber | Y for SMS OTP | String | The phone number to receive the password if using SMS OTP only. Do not use spaces or dashes. Include the country code (1 for US numbers). For example:
To specify a phone number, set the attribute type for the PhoneNumber element to SMS. For example:
|
ExpirationDate | N | dateTime | The temporary security code expiration date (maximum of seven days). If no date is provided, the default expiration period is used to calculate the password expiration. |
SMSFrom | N | String | This input field is deprecated and values provided are ignored. |
Message | N | String | Specifies the SMS message template that is sent to a phone number. Messages must be fewer than 160 characters. Messages support UTF-8 characters. If no Message template supplied, then the default message template that is configured in VIP Manager is used. |
includeBadAttemptsCount | N | String | Enter true to return the number of authentication attempts that have failed for this credential since the last successful authentication. This count includes attempts across all VIP member accounts to which this credential is registered. |