authenticateCredentials response

authenticateCredentials output fields provides details about the
authenticateCredentials
output fields.
authenticateCredentials output fields
Input Field
Required?
Type
Purpose
requestId
Y
String
The
requestId
sent with the
authenticateCredential
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), the message 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
Y
String
Identifies the credential type:
  • STANDARD_OTP (hardware or software
    VIP
    credential, including
    VIP
    Access for Mobile)
  • CERTIFICATE
  • SMS_OTP
  • VOICE_OTP
  • SERVICE_OTP
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 no push notification was sent. Typically, this value is returned if
    VIP
    Services 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.
authContext
N
String
The authentication level that is used to authenticate the credential, if an authentication level was sent in the request.
Example authenticateCredentials response
<S:Body> <AuthenticateCredentialsResponse xmlns="https://schemas.vip.symantec.com"> <requestId>AUTHCRED_87263487236<requestId> <status>6040</status> <statusMessage>Mobile push request sent</statusMessage> <transactionId>734b6f661ed9ed2b</transactionId> <pushDetail> <pushCredentialId>0123456789</pushCredentialId> <pushSent>true</pushSent> </pushDetail> <authContext> <params> <Key>authLevel.level</Key> <Value>1</Value> </params> </authContext> </AuthenticateCredentialsResponse> </S:Body>