authenticateCredentials response

The authenticateCredentials response returns the status of the request to authenticate a user credential or credentials.
authenticateCredentials
output fields
provides details about the
authenticateCredentials
output fields.
authenticateCredentials
output fields
Output Field
Required?
Type
Purpose
requestId
Y
string
The
requestId
sent with the
authenticateCredentials
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.
transactionID
Y
string
The unique ID for the transaction that is used to call one of the feedback APIs.
credentialId
N
string
Unique identifier of the credential.
Only returned if
otpAuthData
was sent in the request, and the credential was successfully authenticated.
credentialType
V
string
Identifies the credential type:
  • STANDARD_OTP (hardware or software VIP credential, including VIP Access for Mobile)
  • CERTIFICATE (Trusted Device credential)
  • EMAIL (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)
Only returned if
otpAuthData
was sent in the request, and the credential was successfully authenticated.
pushDetail
:
pushCredentialId
Y
string
Unique identifier of the push-enabled credential.
Only returned if
pushAuthData
was sent in the request.
pushDetail
:
pushSent
Y
boolean
Identifies if a push notification was sent:
  • Returns "true" if a push notification was sent.
  • Returns "false if not push notification was sent." Typically, this value is returned if the VIP Service does not have the key required to send the push. In this situation, you must use your own push solution to send the push notification.
Only returned if
pushAuthData
was sent in the request.
numbersChallengeValue
N
boolean
The unique, two-digit challenge number. This field is only returned if
Require Number Challenge
is enabled in VIP Manager.
Provide this challenge number to the user.
authContext
N
string
The authentication level used when authenticating the credential, if an authentication level was sent in the request.
See: