Skip to main content

The hosted consent journey allows your application to send a customer to a Wych-managed consent experience where they can connect to a bank or other provider, authenticate, and approve data sharing.

This is typically the quickest way to get started because Wych hosts the consent interface and manages the user-facing journey.

AU CDRNZ PNZ

Before you start​

Before starting a hosted consent flow, make sure you have:

  • a configured Partner profile
  • a registered application
  • working access credentials
  • a valid customer or test user ready to complete the journey
  • the consent journey link or hosted flow entry point configured for your Wych application
  • the correct redirect or return handling in your Wych application, where applicable

What the hosted flow does​

A hosted consent journey allows the customer to:

  • select or search for their bank or data provider
  • review the data access being requested
  • sign in with that provider
  • approve the consent
  • return to your application once the journey is complete

After the consent has been granted, your application can use the resulting connection to retrieve the approved data.

Typical hosted journey​

A typical hosted flow looks like this:

  1. your application launches the hosted consent journey
  2. the customer selects their institution
  3. the customer authenticates with the institution
  4. the customer reviews and approves consent
  5. Wych completes the connection
  6. your application resumes and begins data retrieval

What to confirm before going live​

Before using the hosted flow in a live environment, confirm that:

  • branding has been configured correctly in the portal
  • the correct environment is being used
  • the consent scope matches your intended product behaviour
  • return URLs or follow-up actions are clear to the customer
  • internal support teams know how to identify a consented connection

After a hosted consent flow has completed, confirm that:

  • the customer successfully connected to the target institution
  • the consent record is active
  • the expected accounts or permissions are present
  • the resulting user or connection identifier is available to your application
  • you can make authenticated API calls using the active consent

Common implementation notes​

The hosted journey is useful when you want to:

  • get to market quickly
  • minimise front-end consent build effort
  • use Wych-managed branding and consent screens
  • reduce the amount of consent UX you need to implement yourself

It is especially well suited to quick start and early integration phases.

Troubleshooting​

Customer cannot complete the journey​

Check that:

  • the hosted consent link is correct
  • the application is active in the expected environment (sandbox or production)
  • the customer is using a supported institution
  • branding or configuration changes have been published as expected

Check that:

  • the application is sending valid access credentials
  • the consent is still active
  • the requested endpoint is within the granted consent scope
  • the correct user or connection identifier is being used

Customer returns but your app cannot continue​

Check that:

  • your application handles the post-consent return correctly
  • any state or correlation values are preserved correctly
  • follow-up API calls are made only after the consent is active

What this step enables​

Once the customer has successfully completed the hosted consent journey, your application can move on to retrieving accounts, balances, transactions and other permitted data.

Next step​

Continue to Retrieve data to call the relevant Recipient APIs using the active consent.