Skip to main content

Disabling captive mode

This widget parameter can be set when you:

It defines whether the widget must keep the user in the view during all the synchronization process. It is useful when the client application is not consuming the event queue.

  • When false, we try to keep the user as short as possible on widgets. The user can leave before the credentials are validated and can come back to edit credentials later. This implies that you are responsible for polling the event queue, to retrieve the account list or transactions. We just validate that the user IDs are valid and functional.
  • When this parameter is set to true (default), the screens are linked synchronously. The user will remain on the widgets until the last bank operation is retrieved. This greatly simplifies the integration work. Actions that take a little time are usually those related to the captive_mode parameter. When this parameter is set to true, we wait for all the necessary information from the current step to be gathered before proceeding to the next step.
# Default, display the list of banks and let OXLIN determine which channel definition to use and stay until operations are retrieved (default captive mode is true)
curl https://{widget_uri}/widget/add_connection?session_id=4242XXX&redirect_uri=https://mywebsite.coom/callback
# Call widget session with required captivemode set to false
curl -sk -X POST https://embed.oxlin.io/widget_session?captive_mode=false -d client_id={client_id} -d client_secret={client_secret} -d access_token={access_token}
# Get session_id in JSON Response
{"session_id":"1cKfm7JqrAXbU0fo_vfjDVpb7dsfMc8t"}