Skip to main content

​
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

​
string
required
Unique identifier for the session
​
array
required
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
​
string
Your unique identifier for this session
​
object
Key-value pairs that can be used to store additional information about the session
​
string
The language to display the interface in (e.g., ‘en’)
​
string
The market where the session is created (e.g., ‘de’)
​
string
The URL to redirect to after the session is completed
​
string
The URL to redirect to after the session fails
​
enum
required
The status of the session: - open - Session is currently active - closed - Session completed successfully - expired - Session has expired
​
timestamp
required
The time at which the session will expire
​
timestamp
required
Time at which the session was created

​
Endpoints

​
Create Session

Creates a new data session for connecting to financial institutions.
Request
​
string
Your unique identifier for this session
​
object
Key-value pairs that can be used to store additional information about the session
​
string
The language to display the interface in (e.g., ‘en’)
​
string
The market where the session is created (e.g., ‘de’)
​
string
The URL to redirect to after the session is completed
​
string
The URL to redirect to after the session fails
Response

​
Retrieve Session

Retrieves a data session by its ID.
Request
​
string
required
The ID of the session to retrieve
Response