Skip to main content

Onboarding

Onboarding of clients onto the tenant is handled by the platform's Universal Onboarding. The onboarding section of the tenant's configuration file configures the behaviour.

Configuration Parameters

The configuration section contains the following parameters:

ParameterDescription
baseUrlThis is the base URL of universal onboarding.

See Onboarding URLs below

queryStringAny query string variables that must be passed to universal onboarding.

Default:

{ "tenant-id":"TENANTID" }


Replace TENANTID with your tenant's reference id.

Onboarding URLs

These are the default onboarding URLs per environment:

EnvironmentOnboarding URL
Productionhttps://onboard.platform.coaxle.co.za/
UAThttps://onboard.uat.platform.coaxle.co.za/
Testhttps://onboard.test.platform.coaxle.co.za/