Selecting the right consent journey for your App

In order to consume data via the Tapico API you are required to get the user’s consent. You do that via directing the user, using the redirectUri , to the consent journey workflow where they can select their account servicer and review the consents been requested by your App. The parameters you assign to the redirectUri can greatly alter the user experience of the consent journey. Depending on your App's use case you would likely prefer one user journey over another.

Short vs Long Consent Journey:

The default consent journey is referred to as the Long Consent Journey. This is accessed via the redirectUri returned in the POST /account-access-consents endpoint. This redirects the user to the default Tapico consent flow where they:

  1. Select their Account Servicer.

  2. Review the consents requested by your App.

Before they are redirected to the Account Servicer’s portal to authorise the consent request, ultimately granting access to the account information.

The Short Consent Journey bypasses the default Tapico consent flow and navigates the user directly to the Account Servicer’s portal for authorisation. This is done by adding the accountServicerId to the body of the POST /account-access-consents.

The Short Consent Journey is the preferred user journey in scenarios where it is clear that the user is from a particular Account Servicer.

Where do you get the accountServicerId from?

There are two locations to source the accountServicerId

  1. GET /account-servicers endpoint.

  2. The accountServicerId is passed as a parameter of the URL when the user navigates from a particular account servicer’s App Store when single sign on has been implemented between your App and the account servicer.

https://fire.sandbox.tapico.cloud/sso?accountServicerId=98a9a9cc-a4c0-4a87-92ca-451f094941b1