Skip to main content

Models

Here you can find some helpful models used in the SDK.

Envelope

The model Envelope can be found on TrustFactorSDK.V2.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 TrustFactorSDK.V2.Models namespace.

AttributeDescription
NameDevice’s name (configured by the user on the Agent)
ManufacturerDevice’s manufacturer
OSDevice’s operating system (“Android”/“iOS”)
OSVersionDevice’s operating system version

Meta Data

The MetaData model for transactions v3 can be found on TrustFactorSDK.V2.Models.TransactionCreation.V3.Auxiliary namespace. Contains transaction’s metadata.

AttributeDescription
TimestampShould contain the application timestamp when the transaction was created
UserAgentShould contain the user’s UserAgent of the request that initiated the transaction creation flow
PlatformUser’s operating system
ChannelApplication channel used. Useful for applications that have Web/Mobile channels
SourceIPUser’s IP either IPv4 or IPv6

Core

The Core model for transactions v3 can be found on TrustFactorSDK.V2.Models.TransactionCreation.V3 namespace.

AttributeDescription
MetaDataTransaction’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 TrustFactorSDK.V2.Models.TransactionCreation.V3.Auxiliary namespace.

AttributeDescription
LanguageOverrides the preferred language defined in the Operation
MessageSpecifies 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.
MsgIdentifierSpecifies 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 NormalTransaction and ActionableTransaction 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 TrustFactorSDK.V2.Models.TransactionCreation.V3 namespace. Customizes the confirmation code generated for a transaction created with the RequireConfirmationCode flag active.

AttributeDescription
OptionsNumber of options presented on the user’s agent for the user to choose from
DigitsNumber of digits of the confirmation code and of each option

Confirmation Code

The ConfirmationCode model can be found on TrustFactorSDK.V2.Requests namespace. It is returned on the Create Transaction response when the transaction was created with the RequireConfirmationCode flag active.

AttributeDescription
CodeThe generated confirmation code. Should be displayed on the channel that initiated the transaction, so the user can pick the matching option on their agent
OptionsThe full list of options presented on the user’s agent, which includes the generated code