retrieveLogin (service)
This command is deprecated! Use getPreparedSecureChallenge (service) [v2] instead!
API version: 1
Availability: DIGIPASS Gateway 4.1 and later
Authentication: Basic HTTP authentication using the front-end API key.
The retrieveLogin service retrieves a prepared authentication request. The respective authentication request is identified by a challenge key previously received via push notification.
URL
https://dpgateway_host:dpgateway_port/rest/push/retrieveLogin
Request
retrieveLogin parameters
| Parameter name |
Data type |
Description |
| digipassInstanceID
|
String |
Required. The unique identifier of the Digipass instance. This is the concatenation of the Digipass serial number and the Digipass sequence number, separated by a dash. |
| challengeKey
|
String |
Required. The unique identifier used by OneSpan Authentication Server to identify a login request. |
Example
{
"digipassInstanceID": "VDS1000000-1",
"challengeKey": "1234567890"
}
Response
retrieveLogin return values
| Return value |
Data type |
Description |
| errorCode
|
Integer |
The return code provided by OneSpan Authentication Server. 0 is returned in case of success. |
| errorMessage
|
String |
The error message provided by OneSpan Authentication Server. STAT_SUCCESS is returned in case of success. |
| encryptedLoginDetails
|
String |
The login details protected by a Secure Channel message, which must be decrypted with the Digipass SDK. |
Example
{
"errorCode": 0,
"errorMessage": "STAT_SUCCESS",
"encryptedLoginDetails": "903A1166C89C82F3ED1DB920666E4370..."
}