getPreparedSignatureRequest (Command)

Prev Next

Availability: OneSpan Authentication Server 3.17 and later

Scenario: Signature

Support:  full-sdk   auth-sdk 

The getPreparedSignatureRequest command retrieves a prepared signature request for transaction data signing. The respective signature request 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 one application is allowed to retrieve the signature request. The request key is consumed by the first application retrieving the signature transaction message, subsequent attempts to retrieve it will fail with status code STAT_NOT_FOUND.

Parameters

  Table:  getPreparedSignatureRequest input parameters
Parameter nameData typeDescription
componentTypeStringRequired. The client component for which the signature request is to be retrieved.
serialNumberStringRequired. The serial number of the authenticator associated with the push notification identifier.
requestKeyStringRequired. The request key referring to the signature request previously generated using authSignatureRequest.
  Table:  getPreparedSignatureRequest 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.

resultGetPreparedSignatureRequestResultOptional. The result of the command, i.e. the signature request as a secure channel message (see GetPreparedSignatureRequestResult (Data type)).

GetPreparedSignatureRequestResult (Data type)

  Table:  GetPreparedSignatureRequestResult (Data type)
Parameter nameData typeDescription
requestMessagehexBinaryRequired. The signature request as a secure channel message.

Example

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