Get Session State

View as Markdown
Retrieve the current execution state, lifecycle status, and active cursor screen of the flow session. This endpoint allows synchronous checking of a session's progress. While webhooks (configured via [Create/Update Webhook](api:PATCH/es-public-administration/v1/hooks/update)) are the recommended asynchronous way to track status updates, this endpoint is useful for clients that want to keep their backend state synchronized with INFONITE. Common use cases include: - Polling for session completion or terminal failure status when webhooks are not implemented. - Retrieving the active cursor/screen to display progress or updates in client dashboards. - Recovering and synchronizing the final session state if a connection is lost during the flow. <Warning title="A session is finished only when is_closed is true"> If polling, poll this endpoint for **`is_closed`**, not for anything else. While it is `false` the session is still alive — even if the customer left, even if the widget closed, even if you already received partial results. A source may still be working in the background (the *CIRBE* report from the Banco de España is the usual case), and records can still change or appear. `status_code` alone is not the answer: a session sitting on `WAITING` with the cursor at `es-public-administration:connect:wait` is unfinished by design, not stuck. </Warning> > 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

kind"es-public-administration"

The flow type identifier, always ‘es-public-administration’.

cursorenum
The current screen identifier where the user is positioned in the widget experience.
session_idstringformat: "ObjectId"
The unique database identifier of the created flow session.
app_idstringformat: "ObjectId"
The identifier of the client application that owns this session.
customer_idstring1-64 characters
The external identifier of the customer in your system. Used for auditing and tracking.
status_codeenum

The current execution status of the flow session (e.g., initialized, completed, etc.).

date_createdstringformat: "datetime"
The timestamp when this flow session was created.
date_limitstringformat: "datetime"
Custom expiration deadline for this session. After this timestamp, the widget cannot be opened.
expiration_datestringformat: "datetime"

The timestamp when this session record will be auto-deleted from the database.

is_closedbooleanRead-only
Indicates if the flow session has been finalized or closed.
status_messagestring
An informative status message describing the current session state.
date_startedstringformat: "datetime"
The timestamp when the customer opened the session widget.
ping_datestringformat: "datetime"
The timestamp of the last customer interaction or heartbeat.
date_endedstringformat: "datetime"
The timestamp when the flow session was finalized or closed.
end_hookenum
Delivery status of the final webhook event callback.

Errors

404
Not Found Error
422
Unprocessable Entity Error
429
Too Many Requests Error
504
Gateway Timeout Error