Skip to navigation
Sessions Management

Get Session Settings

View as Markdown

Retrieve the settings the session actually runs with.

They are resolved once, when the session is created, from what you sent and — for whatever you left out — your application’s defaults. This read answers “what did you decide from what I gave you”: the filters or the named bank, the features, how many banks may be connected, the consent screen, the completion behaviour. It never returns the aes_key nor the tokenization ticket.

This endpoint needs to be executed with an app secret, so should always be used in server side without exposing the secret to customers.

Authentication

X-APP-SECRETstring
Application Secret

Path parameters

session_idstringRequiredformat: "object-id"
The session, as its creation returned it

Response

200 OK
The settings the session runs with

sandboxboolean
Whether the session runs in sandbox, against demo entities.
consent_levelenum
The consent screen the session shows, as configured for your application.
Allowed values:
max_connectionsinteger
How many entities the end user may connect.
tokenized_accessboolean
Whether each connection tokenizes the credentials it authenticates with.
engines_layoutenum

How the selection screen lays out the entities: as you asked for it, else as configured for your application.

Allowed values:
priority_engineslist of strings

The entities listed first, by engine code and in this order: as you asked for them, else as configured for your application.

featured_enginesobject

The entities highlighted on the selection, by engine code: as you asked for them, else as configured for your application.

executions_featureslist of objects
What the session reads from each connected entity.
hooks_extra_datamap from strings to strings

Extra data to be included in the hooks. This data will be returned in the webhook as part of the URL as query parameters. This can be useful to include dynamic data in the webhook. There are some template variables that can be used:

  • {app_id}: Your app ID
  • {customer_id}: The customer ID
  • {session_id}: The Session ID
  • {parameters_id}: The unique credentials ID, this identifier is computed by the engine based on the fixed part of the credentials (e.g. the username)
  • {producer}: The producer of the event
  • {event}: The event that triggered the hook
  • {status_code}: The status of the flow at the moment of the event For example, passing:
{
  "custom_param": "customValue",
  "current_event": "{event}",
  "status": "{status_code}",
  "id": "{session_id}"
}

Will result in the following URL: https://your.url.com/your/path?custom_param=customValue&current_event=ended&status=COMPLETED&id=67d7d9b72eb0693e7da47a0e

Note: This data is not encrypted and should not contain sensitive information.

completion_modeenum
What the widget does when the session ends.
Allowed values:
completion_extra_datamap from strings to strings

Extra data to be included in the redirect URL. This data will be added to the the url as query parameters. This can be useful to include dynamic data in the webhook. There are some template variables that can be used in the URL:

  • {app_id}: Your app ID
  • {customer_id}: The customer ID
  • {session_id}: The Session ID
  • {status_code}: The final status code of the session For example, passing:
{
  "custom_param": "customValue",
  "status": "{status_code}",
  "id": "{session_id}"
}

Will result in the following URL: https://your.url.com/your/path?custom_param=customValue&status=COMPLETED&id=67d7d9b72eb0693e7da47a0e

Note: This data is not encrypted and should not contain sensitive information.

engine_referencestringOptionalformat: "engine-reference"
The engine you named for the session. Absent when the session offers entities from the filters.
marketslist of enumsOptional
The markets the session offers entities from. Absent when you named the engine.
Allowed values:
entity_typeslist of enumsOptional
The kinds of financial entity the session offers. Absent when you named the engine.
Allowed values:
completion_urlstringOptional
Where the end user is sent when the session ends, when the mode redirects.

Errors

401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
422
Unprocessable Entity Error
429
Too Many Requests Error