Spain Public AdministrationSessions Management

Get Session Settings

View as Markdown
Retrieve the resolved configuration settings applied to the flow session. This endpoint returns the final settings active for the session. These settings are resolved by merging: 1. The custom parameters requested in the session initialization payload ([Create Session](api:POST/es-public-administration/v1/manager/init)). 2. The default settings configured for the client application. 3. Global system defaults. Its primary utility is diagnostic, allowing clients and auditing tools to verify the exact rules, features, and sandbox configurations executing for the flow session. > 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: "ObjectId"
Session ID to fetch

Response

200 OK
State of the session

sandboxboolean

Set to true to initialize the session in sandbox/test mode.

consent_levelenum
The level of consent screening displayed to the user inside the widget.
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:
1{
2  "custom_param": "customValue",
3  "current_event": "{event}",
4  "status": "{status_code}",
5  "id": "{session_id}"
6}

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.

executions_featureslist of objects

The list of public administration features to retrieve (e.g. life employment certificate, vehicle details, etc.).

completion_modeenum
The redirection mode to trigger when the user exits the widget.
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:
1{
2  "custom_param": "customValue",
3  "status": "{status_code}",
4  "id": "{session_id}"
5}

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.

allowed_engineslist of strings
The list of underlying engine identifiers permitted for execution in this session.
completion_urlstring
The target URL where the user is redirected when they complete or exit the widget.

Errors

404
Not Found Error
422
Unprocessable Entity Error
429
Too Many Requests Error