Get session results

Retrieve the status and results of a flow session

Retrieve detailed information about a specific session, including its current status, outcome, and session history. The response follows data minimization principles by default, returning only essential metadata.

Endpoint

GET v1/{environment}/sessions/{sessionId}

Path parameters

Parameter	Type	Required	Description
sessionId	string	Yes	The unique identifier of the session
environment	String	Yes	Environment name

Request

No request body is required for this endpoint.

Headers

Header	Type	Required	Description
Authorization	string	Yes	Bearer token for authentication

Response

    {
      "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"
      },
      "redirectUrl": null,
      "state": null
}

Response parameters

Parameter	Type	Description
sessionId	string	The unique identifier of the session
sessionStatus	string	Current status. One of CREATED, RUNNING, EXPIRED, ERROR, ABORTED, or COMPLETED
flowId	string	Flow identifier
flowVersion	number	Version of the flow executed
environment	string	Environment name
subjectId	string	The original subjectId value provided in metadata when creating the session
outcome	string	Final session outcome (e.g., accepted, rejected, NO_OUTCOME)
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
redirectUrl	string	Redirect URL for session completion (optional)
state	string	State parameter for CSRF protection in redirect (optional)
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/live/sessions/123 \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json"

Notes

• Response implements data minimization by default for GDPR compliance
• The lastStep object is optional and provides context about the most recently executed step
• Data block access is separated to allow granular access control