Links
Comment on page

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

get
https://{domain}.biapi.pro/2.0
/users
List users
get
https://{domain}.biapi.pro/2.0
/users/{userId}
Get a user
delete
https://{domain}.biapi.pro/2.0
/users/{userId}
Delete a 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:
Property
Type
Description
user
User object
The user related to the sync.
connections
Array of Connection objects
List of connections.
connections[].connector
Connector object
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
Array of BankAccount objects
On each connections item, the activated bank accounts sources that were synced.
connections[].accounts[].transactions
Array of Transaction objects
On each accounts item, the new transactions that were found.

Data model

UsersList object

Property
Type
Description
users
Array of User objects
List of users.

User object

Property
Type
Description
id
Integer
ID of the user.
signin
DateTime