checkOTP response

The checkOTP response returns the status of the request to use a security code to validate a credential even if the credential is locked.
checkOTP
output fields
provides details about the
checkOTP
output fields.
checkOTP
output fields
Output Field
Required?
Type
Purpose
requestId
Y
string
The
requestId
sent with the
checkOTP
request.
status
Y
hex string
Unique status code.
0000=Success
. Any other value is an error.
statusMessage
Y
string
Message corresponding to the status of the request. If the status is not
0000
(success), this is an error message.
credentialId
N
string
Unique identifier of the credential.
credentialType
V
string
Identifies the credential type:
  • STANDARD_OTP (hardware or software VIP credential, including VIP Access for Mobile)
  • CERTIFICATE (Trusted Device credential)
  • EMAIL_OTP (security code sent to user by email)
  • SMS_OTP (security code sent to device by SMS)
  • VOICE_OTP (security code sent to device by a voice call)
  • SERVICE_OTP (security code generated by the VIP Service)
lastAuthnId
N
string
A unique identifier for this authentication sign-in event, if the authentication request was successful.
authContext
N
string
The authentication level used when authenticating the credential, if an authentication level was sent in the request.