List sessions

Retrieves a paginated list of sessions

Retrieves a paginated list of sessions for a specific flow. Supports pagination through query parameters.

Endpoint

GET v1/flows/:flowId/:environment/sessions

Path parameters

Parameter	Type	Required	Description
flowId	string	Yes	The unique identifier of the flow used to execute the session
environment	String	Yes	Environment name

Query parameters

Parameter	Type	Required	Description
page	number	No	Page number for pagination
size	number	No	Number of items per page
sortBy	string	No	Field to sort by (status or createdAt)
sortDesc	boolean	No	Sort in descending order

Request

No request body is required for this endpoint.

Headers

Header	Type	Required	Description
Authorization	string	Yes	Bearer token for authentication

Response

{
  "content": [
    {
      "sessionId": "0197c55f-5af6-7e3d-af9b-f2359b134be8",
      "sessionStatus": "COMPLETED",
      "flowId": "0197c55f-5af6-7e3d-af9b-f2359b154be8",
      "flowVersion": 1,
      "environment": "live",
      "subjectId": "subj_8f3a2c91b47d4e6b",
      "outcome": "accepted",
      "createdAt": "2025-01-07T10:30:00.000Z",
      "startedAt": "2025-01-07T10:30:00.000Z",
      "updatedAt": "2025-01-07T10:35:00.000Z",
      "completedAt": "2025-01-07T10:35:00.000Z",
      "expiresAt": null,
      "lastStep": {
        "stepId": "step_end_001",
        "stepDescription": "Final decision step",
        "verdict": "accepted"
      }
    }
  ],
  "page": {
    "size": 10,
    "number": 1,
    "totalElements": 25,
    "totalPages": 3
  }
}

Response parameters

Parameter	Type	Description
content	array	Array of flow objects
flowId	string	Flow identifier
flowVersion	number	Version of the flow executed
environment	string	Environment name
subjectId	string	The provided reference ID for the user
sessionId	string	The unique identifier of the session
sessionStatus	string	Current status (e.g., RUNNING or COMPLETED)
createdAt	string	ISO 8601 timestamp when session was created
startedAt	string	ISO 8601 timestamp when processing started (null if not started)
updatedAt	string	ISO 8601 timestamp of last update
completedAt	string	ISO 8601 timestamp when session completed
expiresAt	string	ISO 8601 timestamp when session expires
outcome	string	Final decision (e.g., accepted, rejected)
lastStep	object	Information about the last executed step
lastStep.stepId	string	Unique identifier of the last step
lastStep.stepDescription	string	Description of the last step
lastStep.verdict	string	Last step verdict (e.g., accepted, failed)

Example

curl https://api.eu.platform.idnow.io/api/v1/flows/12345/live/sessions \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json"

Notes

• Response implements data minimization by default for GDPR compliance
• If the session status is not accepted, the lastStep object provides debugging context
• Data block access is separated to allow granular access control