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.
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
A
USER_CREATED
wehbook is emitted after a permanent user is created.A
USER_DELETED
wehbook is emitted after a user is deleted.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 | 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. |
Property | Type | Description |
---|---|---|
users | List of users. |
Property | Type | Description |
---|---|---|
id | Integer | ID of the user. |
signin | DateTime | |
Last modified 2mo ago