Skip to main content

Callbacks

Every callback has Envelope class as the request body.

All callbacks come with the following headers:

  • X-Request-Correlation-ID - identifies the Request ID on TrustFactor services (useful for error tracing – you should use this value when asking for support from the SecuritySide Team)
  • X-Application-Key - contains the TrustFactor Public Key and might be used to block unauthorized access to endpoints

Register​

This callback is triggered when a user successfully registers a new contract.
Contains an X-Registration-ID header with the App User ID that might be useful for quick implementations.
Contains the following data:

Share Contract​

This callback is triggered when a user shares a contract from one agent to another.
Contains the following data:

Contract Recover​

This callback is triggered when a user recovers a contract via TrustFactor identity backup.
Contains the following data:

Remove Device Contract​

This callback is triggered when an association is removed (either via client application/backoffice or agent side).
Contains the following data:

  • Removed Device Key
  • Device Key that removed the other (optional, only happens when an agent is removed using another agent)
  • Contract Key
  • App User ID
  • Removed Device Info

Transaction​

Contains an X-Transaction-ID header with the Transaction ID, might be useful for middlewares.
This callback is triggered when a transaction is decided. Below is a list of possible transaction states:

Contains the following data:

  • Status (final transaction status)
  • Device Key (optional, the field is filled when transaction is accepted or declined)
  • Transaction ID
  • App User ID
  • Contract Key
  • Authentications - Authentications used for the agent transaction decision. Should be validated in order to confirm all the required authentications of the transaction were used on this decision in case it was accepted (a malicious application emulating the agent might decide the transaction ignoring the required authentications)

Get SIBS Register Token – CustomApps with SIBS MBWay SDK only​

This callback is triggered when the agent requires SIBS registration token in order to communicate with MBWay SDK. The callback should respond with an activation code for the user.