cancelAuthSignatureRequest (Command)

  • Published on Jul 7, 2025
  • 1 minute(s) read
Prev Next

Availability: OneSpan Authentication Server 3.17 and later

Scenario: Signature

Support:  full-sdk   auth-sdk 

The cancelAuthSignatureRequest command cancels a pending data signing transaction. The respective data signing transaction is identified by a request key previously received via push notification after a respective authSignatureRequest call (see authSignatureRequest (Command))

This command is typically initiated by a mobile application. Only the application that originally retrieved the prepared signing request using getPreparedSignatureRequest is allowed to cancel the signature request. Attempts by other applications to cancel the request will fail with status code STAT_NOSUPPORT.

Parameters

  Table:  cancelAuthSignatureRequest input parameters
Parameter nameData typeDescription
componentTypeStringRequired. The client component for which the signature request is to be canceled.
serialNumberStringRequired. The serial number of the authenticator associated with the push notification identifier.
requestKeyMessageStringRequired. The request key referring to the signature request previously generated using authSignatureRequest, encoded as encrypted secure channel message.
  Table:  cancelAuthSignatureRequest output parameters
Parameter nameData typeDescription
statusCommandStatusResponse

Required. The error stack, if applicable, which indicates that the command has not completed successfully. This also includes the result and status codes returned by the command.

Example

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
  <soapenv:Header/>
  <soapenv:Body>
    <sig:cancelAuthSignatureRequest xmlns:prov="http://www.vasco.com/IdentikeyServer/IdentikeyTypes/Signature">
      <componentType>Push Notification Client</componentType>
      <serialNumber>12345678</serialNumber>
      <requestKeyMessage>abcdef010203</requestKeyMessage>
    </sig:cancelAuthSignatureRequest>
  </soapenv:Body>
</soapenv:Envelope>