Subscriptions

The Trust product lets you retrieve subscriptions of end users. Subscriptions are associated with a connection, and a connector (a provider).

API endpoints

Authentication: endpoints listed in this page require header authentication with a user token.

List subscriptions

GET https://{domain}.biapi.pro/2.0/users/{userId}/subscriptions

Path Parameters

Query Parameters

Filtering route alias:
/users/{userId}/connections/{connectionId}/subscriptions

Get a subscription

GET https://{domain}.biapi.pro/2.0/users/{userId}/subscriptions/{subscriptionId}

Get a single subscription by ID.

Path Parameters

Response body: Subscription object

Subscription resources partially support an update operation to handle activation/deactivation:

Update a subscription

POST https://{domain}.biapi.pro/2.0/users/{userId}/subscriptions/{subscriptionId}

Update a single subscription by ID.

Request body: SubscriptionUpdateRequest object

Path Parameters

Query Parameters

Response body: Subscription object

Life cycle

Subscriptions can be in a disabled or enabled state.

For legal compliance, subscriptions are disabled by default. Also, disabling subscription will result in the deletion of subscription child resources (documents).

Querying

Disabled subscriptions will only appear when passing the all parameter:

GET /users/{userId}/subscriptions/{id}?all
GET /users/{userId}/connections/{connectionId}/subscriptions/{id}?all

Enabling

To enable one such subscription, it is necessary to perform a POST request on that subscription, with the all parameter and { "disabled": false }.

Please note that this action represents the PSU's consent.

Webhooks

Subscription synced

A SUBSCRIPTION_SYNCED webhook is emitted during a sync after a subscription was processed, including new documents.

Webhook request: Subscription object with the following additional properties:

Subscription found

A SUBSCRIPTION_FOUND webhook is emitted after a new subscription was discovered.

Webhook request:

Data model

SubscriptionsList object

Subscription object

Available expands

The following parameters can be used for response properties expansion:

SubscriptionUpdateRequest object

Last updated