Skip to main content
Version: 4.18.1

Start Signature

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

Resource Informations

Requires authentication?Yes
Rate limited?No


Request headers

AuthorizationBearer token

HTTP request URL for SSMS

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

HTTP request URL for SHIFT

POST https://{hostname}/auth/realms/{tenantId}/v3_user/digitaniumsignature/{userId}

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


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


No Parameter fields are required.

Request body(*Required)

Field NameTypeDescription
*transactionIdStringUnique transactionId, which characterizes this transaction.
*deviceGoOnlineTimeoutStringTime in seconds, If=10, the device should come online with the mentioned time orelse SSMS will reject the transaction. Note The deviceGoOnlineTimeout value should be always greater than "0".
*deviceIdStringIf set transaction will trigger to that particular device. Default value will be -1 if not set.
pinRequiredBooleanIf true, the user must enter his PIN to access this transaction. Per default false
pushNotificationMessageStringPublic message sent via Google or Apple Push Services to the mobile device. This is only for informations purpose
*signatureMessageStringTransaction data which will be digitally sign by 2FA. This fields should contain sensible transaction data. (e.b. payment data)
*signatureTimeoutStringTime in seconds, how long the message will be displayed to the user on mobile devices before expiring.
*callbackUrlStringCallback "https://{hostname}/{path}", If empty HTTP response is used.
callBackHeadersStringHeaders which needs to be sent while sending response to the callback url. Based on the user requirement the user attributes can be updated. User can add any customized attribute in form of key value pair.

Sample Request

"callBackHeaders": {
"additionalProp1": "string",
"additionalProp2": "string",
"additionalProp3": "string"
"callbackUrl": "",
"deviceGoOnlineTimeout": 1,
"deviceId": "-1",
"pinRequired": false,
"pushNotificationMessage": "string",
"signatureMessage": "string",
"signatureMessageItems": {
"additionalProp1": "string"
"signatureMode": "MESSAGE",
"signatureTimeout": 1,
"transactionId": "demo"


Field NameTypeDescription
messageStringThe message explains the result of the API call. Refer to Response status Information for details.
statusStringThe status of the API call. Refer Response status Information for details.
subSystemIntegersubSystem categorizes the type of API that has been called. Refer Subsystem details for details.
dataObjectTransaction object
deviceIdStringDevice Id of deviced created the signature
resultCodeStringSee ResultCode details Result Code
signatureStringPKCS#7 Format of signature created on device
transactionIdStringTransaction UUID provided during request

Sample Response

"data": "OK",
"message": "Transaction created successfully",
"status": "OK",
"subSystem": 5


OK_IN_WAITING_LISTThe device is OFFLINE and deviceGoOnlineTimeout is > 0. The transaction was stored and will be sent to client, when client will get online in time. When client does not get online in time, the transaction will be discarded.
DEVICE_GO_ONLINE_TIMEOUTThe device is offline and deviceGoOnlineTimeout is set to 0.

Response Status Information

Status CodeStatusMessage
200OKTransaction cancelled successfully
400BAD_REQUESTUsername should not be null or empty
401UnauthorizedHTTP 401 Unauthorized
404USER_NOT_FOUNDUser does not exist