Skip to main content

Get data blocks

Retrieve input and output data blocks for a session

Retrieve all data blocks associated with a specific session. Data blocks contain the input data provided when creating the session and output data generated during flow execution.

Endpoint

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

Path parameters

ParameterTypeRequiredDescription
sessionIdstringYesThe unique identifier of the session
environmentStringYesEnvironment name

Request

No request body is required for this endpoint.

Headers

HeaderTypeRequiredDescription
AuthorizationstringYesBearer token for authentication

Response

{
"dataBlocks": [
{
"datablockId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"type": "basicIdentity",
"createdBy": {
"stepId": "doc_idv",
"clock": 1,
},
"createdAt": "2025-10-24T12:30:00Z",
"status": "STORED",
"content": {
"familyName": "Schmidt",
"givenName": "Max",
"birthDate": "1985-08-22"
}
},
{
"datablockId": "b2c3d4e5-f6a7-8901-bcde-f12345678901",
"type": "documentVerification",
"createdBy": {
"stepId": "doc_idv",
"clock": 1,
},
"createdAt": "2025-10-24T12:30:00Z",
"status": "STORED",
"content": {
"verdict": {
"status": "VERIFIED"
}
}
}
]
}

Response parameters

ParameterTypeDescription
dataBlocksarrayArray of data block objects

All data blocks include these fields:

FieldTypeDescription
datablockIdstringUnique identifier of the data block (UUID)
typestringType of data block (e.g., basicIdentity, documentVerification)
createdBy.stepIdstringUnique identifier of the step that created this data block (optional)
createdBy.clockintegerA monotonic clock that indicates when this datablock was produced (optional)
createdAtstringISO 8601 timestamp when data block was created
statusstringStatus of the data block (STORED or DELETED)
contentobject | nullThe data block content. Will be null if the data block is deleted
info

For a complete list of available data block types and their schemas, see Core concepts: Data blocks.

Example

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

Notes

  • Data blocks are sorted by createdAt timestamp by default
  • Both input data blocks (provided at session creation) and output data blocks (generated during execution) are returned
  • Data blocks are linked to the steps that created them via the createdBy field
  • All access attempts are logged for auditability and compliance