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.

200: OK List of users

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

Name	Type	Description
userId	Integer or "me"	ID of the user.

200: OK User details

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

Name	Type	Description
userId	Integer or "me"	ID of the user.

204: No Content User deleted

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