Skip to main content

Your Partner profile is the top-level organisation record in Wych. It is where you set your business details, branding, and operational settings used by your Data Recipient applications.

AU CDRNZ PNZ

Before you start​

Before configuring your Partner, make sure you have:

  • a Wych Partner Portal account provided as part of onboarding
  • your organisation details, including legal name, trading name, registration number, address and primary contacts
  • any required operational contacts, such as support or incident contacts where applicable
  • branding assets ready for upload, ideally:
    • SVG or PNG logo
    • light and dark logo variants, where available
    • primary and secondary brand colours
  • confirmation of the environment you are configuring, such as sandbox or production

You will configure your Partner first, then register an Application. The application configuration step defines consent settings and produces the credentials you use to call the API.

What you will set up​

When configuring your Partner, you will typically confirm:

  • organisation name and contact details
  • operational contacts
  • branding defaults used by hosted consent journeys
  • environment access for the relevant deployment stage

Your Application configuration in the next guide will then produce the app-specific consent journey link and API credentials.

info

You will configure your Partner first, then register an Application (which defines consent settings and produces the credentials you use to call the API).

Step 1: Sign in to the Partner Portal​

  1. Navigate to the Wych Partner Portal and sign in.
  2. If this is your first login, complete any first-time profile prompts.
note

If you are unsure which portal hostname applies to your environment, confirm this with your Wych account team.

Step 2: Create or update your Partner profile​

  1. Open Partner (or Organisation) settings.
  2. Enter your organisation details:
    • legal entity name
    • trading name (if different)
    • registered address
    • primary contact
  3. Add operational contacts (recommended):
    • technical contact
    • support contact
    • security or incident response contact
info

Keeping operational contacts current helps shorten incident and onboarding cycles, especially when moving to production.

Step 3: Configure branding defaults​

Hosted consent journeys can be branded so the customer experience remains consistent with your product. Branding is applied from your Partner and Application settings.

  1. Open Branding settings.
  2. Upload your logo(s).
  3. Configure your brand colours.
  4. Save changes and preview if your portal supports preview.
tip

Use high contrast colours and provide a transparent-background logo. This improves readability across light and dark UI surfaces.

Step 4: Confirm environment and access​

Partners typically work in at least one non-production environment before production enablement.

  1. Confirm your current environment (non-production or production).
  2. Confirm the organisation details match the intended environment.
  3. If you require production enablement, ensure your operational contacts and branding are complete.

Step 5: Hand off to Application registration​

Once your Partner is configured, continue to Register your application. Application configuration is where Wych captures consent settings and generates the values you need for integration, including:

  • the application-specific hosted consent journey link, for example: https://connect.wych.app/app/{appName}/connection
  • access credentials and API keys required for calling Wych APIs
Continue: Register your application

Troubleshooting​

I cannot see Partner settings​

  • Confirm your user has the correct role or access level for Partner administration.
  • If the portal is multi-tenant, confirm you are signed into the correct tenant or environment.
  • Confirm branding is saved in the portal.
  • Confirm the journey you are using is the hosted consent journey for the correct Application.
  • If multiple Applications exist, confirm you are using the correct app-specific journey link.

What credentials do I need to call the API?​

Wych APIs require an API key header and an authorisation token header. These are retrieved from the application configuration dashboard.