Track your users in Transaction Data

This section covers the different ways to access Transaction Data and the different use cases associated

Introduction

There are two main documented properties that gives our client information about the progress of the user in TD journey :

  • state : property linked to a session.
  • userJourneyState : property linked to a customer.

state property

You can track the user through the property state accessible in the route GET /v2/sessions/{sessionId}/session-data

This property gives a synthetic view of the progress of the user in a given session.

These states reflect the user's progress within Transaction Data:

  • state=IN_PROGRESS when the user has entered Transaction Data
  • state=SUCCESS when the user has successfully aggregated their account
  • state=EXIT when the user has left Transaction Data
  • state=ERROR when the user has encountered an error
  • state=EXPIRED when the user's session has expired

userJourneyState property

This property gives a detailed view of the progress of the user inside Transaction Data Journey across its associated sessions. It can be used at the micro level to understand where a user has dropped off or at the macro level to build conversion funnels.

If there are multiple sessions, userJourneyState value will be based on the session in which the user progressed the furthest in the journey.

userJourneyState is documented here https://docs.algoan.com/api-reference#getcustomerbyid

Here are the values of userJouneyState :

CUSTOMER_CREATEDThe customer is created
STARTEDThe user has arrived on TD
BANK_SELECTEDThe user has selected a bank
QR_CODE_ SCANNEDThe user has scanned the QR code to continue the process on his mobile
AGGREGATION_STARTEDThe user has been redirected to bank website/app
AGGREGATION_FINISHED_ SUCCESSThe user has been redirected to TD successfully
AGGREGATION_FINISHED_ ERRORThe user has been redirected to TD with error
FINISHED_SUCCESSThe user has been redirected to the defined redirect_uri after at least one successful aggregation.
FINISHED_ERRORThe user has been redirected to the defined redirect_uri without successful aggregation.
ANALYSIS_SUCCESSThe analysis has been created and completed
ANALYSIS_ERRORThe analysis has been created and error
Type to search, ESC to discard
Type to search, ESC to discard
Type to search, ESC to discard
  Last updated