Skip to navigation
Sessions Management

Get Session State

View as Markdown

Retrieve the current state of the session: its status, where your customer is in the experience, and its dates.

A webhook is the recommended way to follow a session — configured once per application in the Console, not per session. This endpoint is for keeping your backend in step when you cannot receive one, or for recovering a session’s state after a lost connection.

A session is finished only when is_closed is true

Branch on is_closed. While it is false the session is alive — your customer may still connect another bank, or come back to the experience. The HTTP code says the same: 200 once the session is finished, 202 while it is open, with the same body either way.

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 session is FINISHED and nothing about it will change.

kind"financial-rider"

The flow this session belongs to: always financial-rider.

cursorenum

The screen the end user is on — or, once the session is over, the last one they reached.

Allowed values:
session_idstringformat: "object-id"
The identifier of this session.
app_idstringformat: "object-id"
The application that owns this session.
customer_idstring1-64 characters
Your reference for the end user, as you sent it when you created the session.
status_codeenum

The status of the session. READY while it is open; any other status is final.

date_createdstringformat: "datetime"
When the session was created.
date_limitstringformat: "datetime"

The deadline: a session still open at this moment closes as TIMED_OUT. Always present — 12 hours after creation when you did not ask for another.

expiration_datestringformat: "datetime"
When this session, and everything it retrieved, is deleted from the platform.
is_closedbooleanRead-only

Whether the session is over. Trust this field — not the arrival of a webhook — to know that nothing about the session will change.

status_messagestringOptional

A human-readable note on the status, when there is one.

date_startedstringOptionalformat: "datetime"
When the end user first opened the widget. Absent until they do.
ping_datestringOptionalformat: "datetime"
The last time the widget reported the end user's presence.
date_endedstringOptionalformat: "datetime"
When the session closed. Absent while it is open.
end_hookenumOptional

Delivery status of the financial-rider:ended webhook.

Errors

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