- 22 Oct 2024
- 1 Minute à lire
- SombreLumière
- PDF
cancelAuthSignatureRequest (Service)
- Mis à jour le 22 Oct 2024
- 1 Minute à lire
- SombreLumière
- PDF
API version: 2
Availability: DIGIPASS Gateway 5.0 and later
Authentication: Basic HTTP authentication using the front-end API key.
The cancelAuthSignatureRequest service cancels a pending data signing transaction. The respective data signing transaction is identified by a request key previously received via push notification.
Only the application that originally retrieved the prepared signature request using getPreparedSignatureRequest is allowed to cancel the signature request. Attempts by other applications to cancel the request will fail with the STAT_NOSUPPORT status code (see getPreparedSignatureRequest (service)).
URL
https://dpgateway_host:dpgateway_port/rest/v2/signature/push /cancelAuthSignatureRequest
Request
cancelAuthSignatureRequest parameters | ||
Parameter name | Data type | Description |
---|---|---|
requestKey | String | Required. The request key referring to the signature request previously generated by OneSpan Authentication Server and received via push notification. |
serialNumber | String | Required. The Digipass authenticator serial number, e.g. VDS1000120-1. |
Parameter names are case-sensitive.
Example
{
"requestKey": "77FA6E11F09FE817A7D5E3CC51DE680F...",
"serialNumber": "VDS1000120-1"
}
Response
cancelAuthSignatureRequest return values | |
Return value | Description |
---|---|
resultCodes | A JSON object that contains the return and status codes of the service. |
Example
{
"resultCodes":
{
"returnCodeEnum": "RET_SUCCESS",
"statusCodeEnum": "STAT_SUCCESS",
"returnCode": 0,
"statusCode": 0
}
}