Consents
Create, authorise and manage customer connections and consent with data holders.
Create a connection
Initialises a connection between the user and a data holder. The connection must be authorised before customer-permissioned data can be accessed.
Get a connection
Retrieves a connection and its current details, including the associated user, data holder, consent scopes and connection status.
Authorise a connection
Starts the customer consent journey for the connection and returns the URI used to redirect the customer to the data holder for authorisation.
Amend a connection
Allows the API requester to amend the scopes or permissions associated with an existing connection. Returns the URI used to redirect the customer to the data holder to review and reconsent to the updated permissions.
Revoke a connection
Revokes the consent associated with the connection and disconnects the user from the data holder.
Get connection state
Retrieves the current connection status together with available connection and data extraction timestamps and state information.
Refresh connection data
Requests a new extraction of customer-permissioned data for an existing connection.
List connections
Retrieves the user's connections. Results can be filtered by data holder or connection status.
List connection extractions
Retrieves the extraction history for a connection, allowing you to inspect the status of data retrieval activity.