Start Signature

Using this API, transaction can be initiated 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

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

HTTP request URL for SHIFT

POST https://{hostname}/auth/realms/{tenantId}/v3_user/digitaniumsignature/{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
*transactionId	String	Unique transactionId, which characterizes this transaction.
*deviceGoOnlineTimeout	String	Time 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".
*deviceId	String	If set transaction will trigger to that particular device. Default value will be -1 if not set.
pinRequired	Boolean	If true, the user must enter his PIN to access this transaction. Per default false
pushNotificationMessage	String	Public message sent via Google or Apple Push Services to the mobile device. This is only for informations purpose
*signatureMode	String	MESSAGE
*signatureMessage	String	Transaction data which will be digitally sign by 2FA. This fields should contain sensible transaction data. (e.b. payment data)
*signatureTimeout	String	Time in seconds, how long the message will be displayed to the user on mobile devices before expiring.
*callbackUrl	String	Callback "https://{hostname}/{path}", If empty HTTP response is used.
callBackHeaders	String	Headers 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": "https://testdevice1.free.beeceptor.com",
	"deviceGoOnlineTimeout": 1,
	"deviceId": "-1",
	"pinRequired": false,
	"pushNotificationMessage": "string",
	"signatureMessage": "string",
	"signatureMessageItems": {
		"additionalProp1": "string"
	},
	"signatureMode": "MESSAGE",
	"signatureTimeout": 1,
	"transactionId": "demo"
}

Response

Field Name	Type	Description
message	String	The message explains the result of the API call. Refer to 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	Object	Transaction object
deviceId	String	Device Id of deviced created the signature
resultCode	String	See ResultCode details Result Code
signature	String	PKCS#7 Format of signature created on device
transactionId	String	Transaction UUID provided during request
userId	String	Username

Sample Response

import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem';

<Tabs

values={[ {label: 'If the callbackUrl is added in the request body', value: 'If the callbackUrl is added in the request body'}, {label: 'If the callbackUrl is not added in the request body', value: 'If the callbackUrl is not added in the request body'}, ]}>

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

{
	"subSystem": 5,
	"status": "TRANSACTION_COMPLETED",
	"message": "TRX_e256adff-951d-40b9-b973-cf93338a4810_demokc1",
	"data": [{
		"appName": [],
		"deviceId": "-1",
		"resultCode": "DEVICE_GO_ONLINE_TIMEOUT",
		"signature": null,
		"transactionId": "e256adff-951d-40b9-b973-cf93338a4810",
		"userId": "demotest"
	}]
}

ResultCode

ResultCode	Description
OK_IN_WAITING_LIST	The 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_TIMEOUT	The device is offline and deviceGoOnlineTimeout is set to 0.

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