Connections
Connections materialize the individual link between a user and a connector. They act as a parent for business data and hold metadata about the synchronization state, the PSU credentials and consents.
Last updated
Connections materialize the individual link between a user and a connector. They act as a parent for business data and hold metadata about the synchronization state, the PSU credentials and consents.
Last updated
Authentication: endpoints listed in this page require header authentication with a user token.
POST https://{domain}.biapi.pro/2.0/users/{userId}/connections
Request body: ConnectionRequest object
| Name | Type | Description |
|---|---|---|
Response body: Connection object
GET https://{domain}.biapi.pro/2.0/users/{userId}/connections
| Name | Type | Description |
|---|---|---|
Response body: ConnectionsList object
GET https://{domain}.biapi.pro/2.0/users/{userId}/connections/{connectionId}
Get a single connection by ID.
Response body: Connection object
POST https://{domain}.biapi.pro/2.0/users/{userId}/connections/{connectionId}
Update a single connection by ID.
Request body: ConnectionUpdateRequest object
Response body: Connection object
PUT https://{domain}.biapi.pro/2.0/users/{userId}/connections/{connectionId}
Request synchronization of a single connection by ID.
Response body: Connection object
DELETE https://{domain}.biapi.pro/2.0/users/{userId}/connections/{connectionId}
This operation deletes the connection and all its related data (accounts, transactions, subscriptions, documents, identities...). This is a hard delete and cannot be reversed: the data (including full history) is permanently erased from Powens' databases. This operation meets GDPR requirements related to the deletion of personal data.
Response body: Connection object
GET https://{domain}.biapi.pro/2.0/webauth-url
Constructs a connection URL for connectors (and sources) using the webauth auth mechanism. The same service can be used for both establishing a new connection and resuming an existing connection that requires an update for SCA or consent renewal (i.e. in the SCARequired state).
The returned URL should be presented on the device of the PSU using the most appropriate front-end components, taking full advantage of URL-handling behaviors to enable app-to-app experiences when available.
Response body: WebauthURL object
GET https://{domain}.biapi.pro/2.0/webauth
The /webauth-url endpoint provides an alternate (recommended) way to obtain the redirection URL in order to optimize app-to-app experiences.
This endpoint is a special redirection service to help presenting the auth webview from a connector (e.g. using OAuth2 protocol). This service is not an API endpoint, the URL must be navigated to in a browser.
Response body: WebauthURL object
To optimize user experience, the URL should be opened in a fully-capable browser. From a website or webapp, perform a full-page redirect. In a native Android app, prefer opening the default browser or relying on Chrome Custom Tabs. In a native iOS app, prefer using a SFSafariViewController.
After the flow has terminated, a redirection will be performed to the provided redirect_uri, with additional query parameters:
GET https://{domain}.biapi.pro/2.0/users/{userId}/connections/{connectionId}/sources
By default, disabled sources are omitted in the response. Add the all query parameter to include them.
Response body: ConnectionSourcesList object
GET https://{domain}.biapi.pro/2.0/users/{userId}/connections/{connectionId}/sources/{sourceId}
Response body: ConnectionSource object
POST https://{domain}.biapi.pro/2.0/users/{userId}/connections/{connectionId}/sources/{sourceId}
Request body: ConnectionSourceUpdateRequest object
Response body: ConnectionSource object
GET https://{domain}.biapi.pro/2.0/users/{userId}/connections/{connectionId}/logs
List synchronization logs of a connection by ID.
Response body: ConnectionSourcesList object
A CONNECTION_SYNCED webhook is emitted after a connection has been synced.
Webhook request:
A CONNECTION_DELETED webhook is emitted after a connection has been deleted.
Webhook request: Connection object
To add a connection to a connector/source using the credentials AuthMechanism, you must also include in the request values from the connector fields definition.
Available expands
The following parameters can be used for response properties expansion:
Instructions for presenting and processing the various error states are available in our dedicated integration guide.
Forward compatibility requirement: additional states may be added in the future. When implementing state handling, always fallback to a non-resolvable generic case for unknown values.
To edit a connection source using the credentials AuthMechanism, you can also include in the request new values from the connector fields.
| Name | Type | Description |
|---|---|---|
| Name | Type | Description |
|---|---|---|
| Name | Type | Description |
|---|---|---|
Response body: with wrongPass code
| Name | Type | Description |
|---|---|---|
| Name | Type | Description |
|---|---|---|
| Name | Type | Description |
|---|---|---|
| Name | Type | Description |
|---|---|---|
Response body: with invalidValue code
| Name | Type | Description |
|---|---|---|
| Parameter | Type | Description |
|---|---|---|
| Parameter | Type | Description |
|---|---|---|
| Name | Type | Description |
|---|---|---|
| Name | Type | Description |
|---|---|---|
| Name | Type | Description |
|---|---|---|
| Name | Type | Description |
|---|---|---|
| Name | Type | Description |
|---|---|---|
| Name | Type | Description |
|---|---|---|
| Name | Type | Description |
|---|---|---|
| Name | Type | Description |
|---|---|---|
| Property | Type | Description |
|---|---|---|
| Name | Type | Required | Description |
|---|---|---|---|
| Property | Type | Description |
|---|---|---|
| Property | Type | Description |
|---|---|---|
| Property | Type | Description |
|---|---|---|
| Value | Description |
|---|---|
| Property | Type | Required | Description |
|---|---|---|---|
| Property | Type | Description |
|---|---|---|
| Property | Type | Description |
|---|---|---|
| Property | Type | Required | Description |
|---|---|---|---|
| Property | Type | Description |
|---|---|---|