getCredentialInfo request

The getCredentialInfo request obtains information about the credential assigned to a user.
Request endpoint: https://userservices-auth.vip.symantec.com/vipuserservices/QueryService_1_10
getCredentialInfo
input fields
provides details about the
getCredentialInfo
input fields.
getCredentialInfo
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.
credentialId
Y
string
Unique identifier of the credential.
credentialType
Y
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 device 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)
  • BIOMETRIC (biometric-based FIDO authentication)
  • SECURITY_KEY (USB-based or passkey-based FIDO authentication)
includePushAttributes
N
boolean
If this flag is present and set to be true, the response contains all the push attributes in the field
pushAttributes
.
includeTokenInfo
N
boolean
If this flag is present and set to be true, and
credentialType
is set to STANDARD_OTP, the
credentialInfo
section in the response contains the
tokenCategoryDetails
and
tokenInfo
values for that credential.
If this flag is present and set to be true, and
credentialType
is set to any other value, this flag is ignored.
If this value is present and set to be false, the response does not include the
pushEncryptKey
, even if the
includePushEncryptKey
flag is present and set to be true.
includePushEncryptKey
N
boolean
If this flag is present and set to be true, and the credential is a custom app using VIP Mobile SDK version 3.0.2 or later with encryption enabled, the response contains the base64-encoded public key for the credential.
See VIP Software Development Kit (SDK) Developer's Guide for information on the VIP SDK and encrypting transactions.