Cancel Signature

Using this API, transaction can be cancelled for the given user.

Resource Informations

Name	Value
Requires authentication?	Yes
Rate limited?	No

Request

Request headers

Key	Value
Authorization	Bearer token
Content-Type	application/json

HTTP request URL for SSMS

DELETE https://{tenantId}.{hostname}/digitanium/v4/users/signature/{userId}

HTTP request URL for SHIFT

DELETE https://{hostname}/auth/realms/{tenantId}/v3_user/cancelsignature/{userId}

note

At this moment, this API is applicable only for SSMS based installations.

note

API requests must be made over https. Calls made over plain http will fail.

Parameters

No parameter fields are required.

Request body(*Required)

Field Name	Type	Description
*deviceId	String	DeviceId of the user in which transaction has to be cancelled.
*transactionId	String	Unique UUID, which characterizes this transaction.

Sample Request

{
    "deviceId": [
        "-1"
    ],
    "transactionId": "demo"
}

Response

Field Name	Type	Description
message	String	Message explains result of the API call. Refer Response status Information for details.
status	String	The status of the API call. Refer Response status Information for details.
subSystem	Integer	subSystem categorizes the type of API that has been called. Refer Subsystem details for details.
data	Array	List of all details for the given userId.
deviceId	String	Device Id of the device created the signature
transactionId	String	Transaction UUID provided during request
userId	String	Unique Username
cancelResult	String	categorizes the type of result. Refer Result Code Information for details.

Sample Response

{
  "subSystem": 5,
  "status": "OK",
  "message": "Transaction cancelled successfully",
  "data": [
      {
          "deviceId": "DEVICE_ID",
          "userId": "USER_NAME",
          "transactionId": "TRANSACTION_ID",
          "cancelResult": "TRANSACTION_DISCARDED_FROM_CLIENT"
      }
  ]
}

Result Code Information

ResultCode	Description
TRANSACTION_DISCARDED_FROM_CLIENT	The transaction was already sent to client. It will be discarded, when the result is available.

Response Status Information

Status Code	Status	Message
200	OK	Transaction cancelled successfully
400	BAD_REQUEST	Username should not be null or empty
401	Unauthorized	HTTP 401 Unauthorized
404	USER_NOT_FOUND	User does not exist