Skip to main content

API Calls

The response may contain ErrorCodes when the TrustFactor service call is not successful.

ErrorCodes are errors with unique codes standardized by TrustFactor services to be easier to manage errors outside TrustFactor services and give more information about why the TrustFactor services couldn’t handle the request.

ErrorCodes are thrown when a server side validation blocks a request.

ErrorCodes contain a unique code (e.g. E_400020001), a message and optionally, depending on the error code, extra arguments to the error. For example, when a contract already exists an E_400020001 error code is thrown and has an argument with the App User ID, that serves as additional information to situate the error.

Also, to notice that every request that supports User ID as a similar request that supports Contract Key. That way the application has a more diverse choice.

Create Register Code​

Creates a registration token for a user with an expiration time between 0 seconds and 600 seconds, otherwise, the request will return an error.
You should create and display a QR Code and/or a Deep Link URL considering user’s device using the response object.
To get the QR Code you need to use the getRegistrationQRCode method from the Application Client, for the QR Code URL you will need to use the generateRegistrationQRCodeURL method and finally for the Deep Link URL you need to use generateRegistrationDeeplinkURL method.
The QR Code encodes the registration Deep Link URL, so besides being scanned from within the Agent application it can also be scanned with the device’s native camera, which opens the Agent application directly.

  • RegisterCodeReq (Request Object)
  • RegisterCodeRes (Response Object)

The V2 version of this API additionally supports the requirePreciseLocation flag. When enabled, the generated registration token signals the Agent that the registration must be performed with a precise (GPS) device location.

  • V2
    • RegisterCodeV2Req (Request Object)
    • RegisterCodeV2Res (Response Object)

Possible Response Error Codes:​

Reset Contract Device​

Removes the specified device from this contract.
If it is the last associated device, the user will no longer have TrustFactor associated to the account. From that moment on, it will no longer be possible to create new transactions for that user until he associates a new device through a registration flow.

  • With Key
    • ResetContractDeviceReq (Request Object)
    • ResetContractDeviceRes (Response Object)
  • With User ID
    • ResetContractDeviceByUserIDReq (Request Object)
    • ResetContractDeviceByUserIDRes (Response Object)

Possible Response Error Codes:​

Get Contract Authentication Mechanisms​

Returns all the authentications the user has configured on his agents. Might be useful to block certain actions (and don’t create transactions), if the user doesn’t have the required authentication mechanisms associated.

  • With Key
    • GetContractAuthenticationMechanismsReq (Request Object)
    • GetContractAuthenticationMechanismsRes (Response Object)
  • With User ID
    • GetContractAuthenticationMechanismsByUserIDReq (Request Object)
    • GetContractAuthenticationMechanismsByUserIDRes (Response Object)

Possible Response Error Codes:​

Set SIBS Details​

Sets the contract SIBS details used for SIBS transactions.

  • With Key
    • SetSIBSDetailsByKeyReq (Request Object)
    • SetSIBSDetailsByKeyRes (Response Object)
  • With User ID
    • SetSIBSDetailsByUserIDReq (Request Object)
    • SetSIBSDetailsByUserIDRes (Response Object)

Possible Response Error Codes:​

Create Transaction​

This API creates a new transaction for a user. In order to call this method you need a registered user, and a transaction object. For more information about how to create transactions, please check Transactions in depth chapter. The transaction object should have one of the following types:

Transaction TypeCustomApps Only
NORMAL_TRANSACTIONNo
ACTIONABLE_TRANSACTIONNo
GENERIC_TRANSACTIONNo
SIBS_3DS_TRANSACTIONYes
SIBS_3DS_TRANSACTION_V2Yes

NORMAL_TRANSACTION and ACTIONABLE_TRANSACTION types reference an operation (see the BackOffice Documentation for more information on Operations) that should already be defined in Backoffice via action field.

Transactions can also require a precise (GPS) device location on decision (requirePreciseLocation) and/or a confirmation code (requireConfirmationCode, optionally customized with confirmationCode settings). When a confirmation code is required, the creation response contains a Confirmation Code object with the correct code and the options presented to the user. Check the Transactions in depth chapter for further details.

  • With Key
    • CreateTransactionV3WithKeyReq (Request Object)
    • CreateTransactionV3WithKeyRes (Response Object)
  • With ID
    • CreateTransactionV3WithUserIDReq (Request Object)
    • CreateTransactionV3WithUserIDRes (Response Object)

Possible Response Error Codes:​

Update Transaction Status – CustomApps with SIBS MBWay SDK only​

Sets the status of a SIBS3DSV2 transaction.

  • UpdateTransactionStatusReq (Request Object)
  • UpdateTransactionStatusRes (Response Object)

The possible states the transaction can be updated to are:

If the requests tries to update the transaction to the same state the response returns a 204 HTTP code.

The possible states the transaction can be updated from are:

These transaction states can be found on com.securityside.trustfactor.constants.enums package.

Possible Response Error Codes:​

Get Transaction Status​

Retrieves the status of a transaction.

  • GetTransactionStatusReq (Request Object)
  • GetTransactionStatusRes (Response Object)

Possible Response Error Codes:​