Models
Here you can find some helpful models used in the SDK.
Envelope
The model Envelope can be found on com.securityside.trustfactor.util.crypto namespace. Contains an encrypted message, the receiver and sender keys and the payload signature
Device Info
The model DeviceInfo can be found on com.securityside.trustfactor.model.device package.
| Attribute | Description |
|---|---|
name | Device’s name (configured by the user on the Agent) |
manufacturer | Device’s manufacturer |
os | Device’s operating system (“Android”/“iOS”) |
osVersion | Device’s operating system version |
Meta Data
The MetaData model for transactions v3 can be found on
com.securityside.trustfactor.model.transaction.creation.v3.auxiliary package. Contains transaction’s metadata.
| Attribute | Description |
|---|---|
timestamp | Should contain the application timestamp when the transaction was created |
userAgent | Should contain the user’s UserAgent of the request that initiated the transaction creation flow |
platform | User’s operating system |
channel | Application channel used. Useful for applications that have Web/Mobile channels |
sourceIP | User’s IP either IPv4 or IPv6 |
Core
The Core model for transactions v3 can be found on com.securityside.trustfactor.model.transaction.creation.v3 package.
| Attribute | Description |
|---|---|
metadata | Transaction’s metadata |
Transaction’s core contains basic information needed to create any type of transaction.
Message Engine
The MessageEngine model for transactions v3 can be found on
com.securityside.trustfactor.model.transaction.creation.v3.auxiliary package.
| Attribute | Description |
|---|---|
language | Overrides the preferred language defined in the Operation |
message | Specifies the message that should be displayed on user’s agent. It will override the message template engine or any operation defined message. msgIdentifier should be null or empty if this field is filled. |
msgIdentifier | Specifies the operation’s defined template message to use |
The MessageEngine object in the transactions is used to easily show messages to the user. There are two ways to do that, the simplest way is to fill the field message with the intended message. The other way is to fill the msgIdentifier with the identifier of a message created within the operation referenced on the action field of the transaction. This message identifier is retrieved through the backoffice Operations menu. MessageEngine can only be used with NORMAL_TRANSACTION and ACTIONABLE_TRANSACTION types, since they are the only ones that take a predefined operation on the backoffice.
Confirmation Code Settings
The ConfirmationCodeSettings model for transactions v3 can be found on
com.securityside.trustfactor.model.transaction.creation.v3 package.
| Attribute | Description |
|---|---|
options | Number of confirmation code options presented to the user on the Agent |
digits | Number of digits of each confirmation code |
The ConfirmationCodeSettings object customizes the confirmation codes generated for a transaction created with requireConfirmationCode enabled. When omitted, the TrustFactor services use the default settings.
Confirmation Code
The ConfirmationCode model can be found on com.securityside.trustfactor.client.request.transaction package.
| Attribute | Description |
|---|---|
code | The correct confirmation code the user must select on the Agent to approve the transaction |
options | All the confirmation code options presented to the user on the Agent |
The ConfirmationCode object is returned in the transaction creation response when the transaction was created with requireConfirmationCode enabled. The application should display the correct code to the user, so he can select it on the Agent when deciding the transaction.