checkOTP request

The checkOTP request uses a security code to validate a credential even if the credential is locked.
Send the request to: https://userservices-auth.vip.symantec.com/vipuserservices/AuthenticationService_1_10
checkOTP
input fields
provides details about the
checkOTP
input fields.
checkOTP
input fields
Input Field
Required?
Type
Purpose
requestId
Y
string
A unique identifier of the request for the enterprise application. The request ID accepts from 4 to 40 alphanumeric characters and underscores.
This identifier may be useful for troubleshooting purposes.
userId
Y
string
Unique ID for the user (for example, the user email address, the user’s logon name, or a unique ID that maps to user’s logon name). The user ID accepts 1 to 128 international characters.
The user ID is not case-sensitive in look-up operations.
pin
N
string
Optional user PIN for first-factor authentication. The PIN may be 4 to 128 international characters in length, depending on restrictions of the PIN policy.
otpAuthData
:
otp
N
string
The one-time security code that is generated by the user’s credential.
authContext
N
string
A map containing the parameters that control how the authentication is performed. VIP User Services accepts an authentication level for the authContext field.
The authentication level defines the credential types that can be validated with this request. This level must match an authentication level configured in VIP Manager.
  • Key: Enter
    authLevel.level
  • Value: Enter the authentication level value (as an integer from 1 - 10).