Documentation Index

Fetch the complete documentation index at: https://docs.onespan.com/llms.txt

Use this file to discover all available pages before exploring further.

getPreparedSecureChallenge (Command)

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

Scenario: Authentication

Support:  full-sdk   auth-sdk 

During the Push Notification authentication workflow (push and login), the mobile application must fetch the secure challenge with the getPreparedSecureChallenge command. The command requires the previously received challenge key to continue with the authentication process.

Only one application is allowed to retrieve the secure challenge for the given challenge key.

Parameters

  Table:  getPreparedSecureChallenge input parameters
Parameter nameData typeDescription
componentTypeStringRequired. Specifies the component for which the secure challenge is to be retrieved.
serialNumberStringRequired. Serial number of the authenticator used for the authentication process.
challengeKeyStringRequired. The retrieved challenge key used to refer to the challenge generated during push and login.
  Table:  getPreparedSecureChallenge 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.

resultGetPreparedSecureChallengeResultRequired. The output field for this command, returning information about the upgrade procedure as a Secure Channel message.

GetPreparedSecureChallengeResult (Data type)

  Table:  getPreparedSecureChallengeResult (Data type)
Parameter nameData typeDescription
RequestMessagehexBinaryRequired. The challenge as a Secure Channel message containing the retrieved challenge key used to refer to the challenge generated during push and login.

Example

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
  <soapenv:Header/>
  <soapenv:Body>
    <aut:getPreparedSecureChallenge xmlns:prov="http://www.vasco.com/IdentikeyServer/IdentikeyTypes/Authentication">
      <componentType>Push Notification Client</componentType>
      <serialNumber>12345678</serialNumber>
      <challengeKey>02fa56b3</challengeKey>
    </aut:getPreparedSecureChallenge>
  </soapenv:Body>
</soapenv:Envelope>