Consents

Before you can access a user's data that user must consent to data sharing. Consents are started by creating an Auth Session. After creating the Auth Session, direct your user to the returned auth_url where they will sign in to the institution, select accounts to share from, and approve sharing of the data being requested.

After the data sharing has been approved, the user will be redirected back to your application. You will also receive a Webhook with the end_user_id and consent_id.

Tip: You can also use the Consents API to check if an End User has any active consents.

Ending of Consent

Consents can be ended in multiple ways:

  1. By the end user through the institution
  2. By the institution when the sharing duration expires
  3. By the institution when the user closes all of their accounts
  4. By you on behalf of the end user

In all of these instances you will receieve a Webhook to inform you that the consent has ended.

Was this page helpful?