Skip to main content

Data-recipients

Access credentials 🔐

Prior to authenticating your application you will need to register for a Wych account. Register Prepare your access credentials # To call the Wych API you need to send two headers, these headers are used to manage your access. These are sent on each call. x-api-key authorisation API key # Like with your client id and secret your x-api-key is retrieved from the app configuration dashboard.

Bring your own - Consent Journey

This is an advanced integration. Before you review our out of the box consent. Consent & Connect Occasionally it is necessary to integrate the consent flow into an existing application. This can be helpful when you are migrating from an existing provider, or working with providers in different regions and want to provide your users with a consistent user experience. In this case we provide access to the relevant API to retrive the necessary data to perform the connection journey.

Consent

What is consent? # Consent is the principle where a custom gives express permission for the collection, use and disclosure of their data. In many regions it is mandatory to request this consent before interacting with a customer’s data. Without express consent, you should not able to collect, use, or disclose customer data. When a customer consents they are agreeing to a specific usecase, think of this as the terms of the consent.

Introduction 🎉

What is Wych Data? # Wych Data is a Consumer Data Right accredited API platform that provides the secure access to financial and energy data. Our APIs enable secure access to public and customer-consented financial and energy data. Wych also goes beyond raw data and offers insights - pre-built outcomes for you to use without having to write a line of code. Wych Data API # Now that we have your attention, you might be thinking “what can I do with this data?

Postman collection

Account Data # Access CDR v3 Account Data Transaction Insights # Access CDR v3 Transaction Insights Onetime Login Link # Access CDR v3 Onetime Link

Retrieve customer data

The following steps are outlined and supported with an accompanying Postman collection. Postman is an API Platform for developers to design, build, test and iterate their APIs running on Windows, Mac and Linux. This can be used to validate your API calls. You will be supplied three credentials for access to the Wych Data API, an API key x-api-key, client_id and client_secret. The Postman collection is supported with the API docs.

User management

Registration # Out of the box compliance # When it comes to customer registration Wych’s OpenID compliant authentication and authorisation service - Wych Auth - provides all the necessary tools for businesses to get going with user authentication and registration. Wych requires an end-user to be registered before a connection journey can begin. User registration can be managed by the Wych Auth system, using email address and password, social loging or by utilising a business existing SSO.