Data Sessions
The Data Session object and its endpoints
Data Session Object
The Data Session object represents a session for connecting to financial institutions and retrieving account data. It allows you to request access to a user’s accounts and permissions, and to retrieve the data for those accounts.
Properties
Unique identifier for the session
List of permissions requested for this session: - accounts
- Access to
account data - transactions
- Access to transaction data - balances
-
Access to balance data - holders
- Access to account holder data
Your unique identifier for this session
Key-value pairs that can be used to store additional information about the session
The language to display the interface in (e.g., ‘en’)
The market where the session is created (e.g., ‘de’)
The URL to redirect to after the session is completed
The status of the session: - active
- Session is currently active -
completed
- Session completed successfully - expired
- Session has expired
List of account IDs that were connected during this session
The time at which the session will expire
Time at which the session was created
Endpoints
Create Session
Creates a new data session for connecting to financial institutions.
Request
List of permissions to request: - accounts
- Access to account data -
transactions
- Access to transaction data - balances
- Access to balance
data - holders
- Access to account holder data
Your unique identifier for this session
Key-value pairs that can be used to store additional information about the session
The language to display the interface in (e.g., ‘en’)
The market where the session is created (e.g., ‘de’)
The URL to redirect to after the session is completed
Retrieve Session
Retrieves a data session by its ID.
Request
The ID of the session to retrieve