Sample RegistrationStatus response

The RegistrationStatus API returns the status of the VIP Access for Mobile QR code registration process.
The
RegistrationStatus
output fields
provides details about the
RegistrationStatus
output fields.
RegistrationStatus
output fields
Output Field
Required?
Type
Purpose
registrationStatus
Y
string
The status of the registration process:
  • PENDING
  • REGISTERED
  • FAILED
registrationId
Y
string
The
registrationId
sent with the
RegistrationQrCode
request.
credentialDetail
N
string
Information about the credential that is registered to the user by this operation:
  • credentialType
    : The credential type is always
    STANDARD_OTP
  • credentialID
    : The unique ID for the credential.
The
RegistrationStatus
response returns one of the following responses, depending upon the status of the VIP Access QR code registration process:

Sample response for a pending QR code registration request

{ "RequestStatusResponse": { "registrationStatus": "PENDING", "registrationId": "cd5c9b02-casf-4701-465t-c202lib9eb18" } }

Sample response for a successful QR code registration request

{ "RequestStatusResponse": { "registrationStatus": "REGISTERED", "registrationId": "cd5c9b02-casf-4701-465t-c202lib9eb18", "credentialDetail": { "credentialType": "STANDARD_OTP", "credentialId": "SYMC14736451", } } }

Sample response for a failed QR code registration request

{ "RequestStatusResponse": { "registrationStatus": "FAILED", "registrationId": "cd5c9b02-casf-4701-465t-c202lib9eb18" } }
See Troubleshooting the VIP REST APIs and the
End User > Transaction Report
in VIP Manager for more information about this response.