authSignature (service)

API version: 2

Availability: DIGIPASS Gateway 5.0 and later

Authentication: Basic HTTP authentication using the front-end API key.

The authSignature service completes a pending data signing transaction. It resumes a transaction the serving OneSpan Authentication Server instance previously suspended during a SOAP call (authSignatureRequest) from the respective application server to OneSpan Authentication Server initiating the signing transaction.

The signature request is retrieved by the client using getPreparedSignatureRequest. The respective signature request is identified by a request key previously received via push notification (see getPreparedSignatureRequest (service)).

URL

https://dpgateway_host:dpgateway_port/rest/v2/signature/push /authSignature

Request

authSignature parameters
Parameter name Data type Description
userID String Required. The unique identifier used by OneSpan Authentication Server to identify a user.
domain String Optional. The unique identifier used by OneSpan Authentication Server to identify a user domain.
requestKey String Required. The request key that refers to the signature request previously generated by OneSpan Authentication Server and received via push notification.
signature String Required. The signature created from the secure channel message, i.e. the actual signature request retrieved using getPreparedSignatureRequest.

Parameter names are case-sensitive.

Example

{
  "userID": "jane.doe",
  "domain": "mydomain.com",
  "requestKey": "8408980524",
  "signature": "3833791"
}

Response

authSignature return values
Return value Description
resultCodes

A JSON object that contains the return and status codes of the service.
result A JSON object that contains the resolved user information and the serial number of the Digipass authenticator that is effectively used to complete the signature request.

Example

{
  "resultCodes":
    {
      "returnCodeEnum": "RET_SUCCESS",
      "statusCodeEnum": "STAT_SUCCESS",
      "returnCode": 0,
      "statusCode": 0
    },
  "result":
    {
      "userID": "jane.doe",
      "domain": "mydomain.com",
      "orgUnit": "",
      "serialNo": "VDS1000120-1"
    }
}