Users
Users represent the top-level isolation level of synchronized data. They are intended to be actively managed by clients to mirror their own end-user definition.
API endpoints
Users management
List users
GET https://{domain}.biapi.pro/2.0/users
List all users of the domain.
The endpoint requires header authentication with a users token. The users token is only available in the Settings section of the console.
Response body: UsersList object
Get a user
GET https://{domain}.biapi.pro/2.0/users/{userId}
Get a single user by ID.
The endpoint requires header authentication with a user token
Path Parameters
userId
Integer or "me"
ID of the user.
Response body: User object
Delete a user
DELETE https://{domain}.biapi.pro/2.0/users/{userId}
Delete a user by ID.
The endpoint requires header authentication with a user token
Path Parameters
userId
Integer or "me"
ID of the user.
Webhooks
User created
A USER_CREATED wehbook is emitted after a permanent user is created.
Webhook request: User object
User deleted
A USER_DELETED wehbook is emitted after a user is deleted.
Webhook request: User object
User synced (deprecated)
A USER_SYNCED webhook is emitted after multiple connections of a user have been synced. This webhook is deprecated for multiple connections per user, prefer usage of CONNECTION_SYNCED.
Webhook request:
user
The user related to the sync.
connections
List of connections.
connections[].connector
On each connections item, the connector associated with the connection.
connections[].sources
Array of ConnectionSource objects
On each connections item, the activated connections sources that were synced.
connections[].accounts
On each connections item, the activated bank accounts sources that were synced.
connections[].accounts[].transactions
On each accounts item, the new transactions that were found.
Data model
UsersList object
users
List of users.
User object
id
Integer
ID of the user.
signin
DateTime
Last updated