URL and parameters

The Onboarding Flow is available at https://onboarding.zwapgrid.com. You build the URL using your Consent ID, a One-Time Code, and optional parameters for redirect behaviour.

Base URL with required parameters

You must include the Consent ID and One-Time Code (OTC) in the URL. Generate the OTC via the Consent API—see One-Time Code.

https://onboarding.zwapgrid.com/consent/<Consent ID>/?otc=<one-time-code>

Replace <Consent ID> and <one-time-code> with your actual values. The One-Time Code must be URL-encoded before use.

Redirect back to Your Platform (optional)

To send Your Customer back to Your Platform when they finish the Onboarding Flow, add the redirecturl query parameter:

https://onboarding.zwapgrid.com/consent/<Consent ID>/?otc=<one-time-code>&redirecturl=<url>

Replace <url> with the URL in Your Platform where they should land (e.g. a success or dashboard page).

Redirect delay (optional)

To control whether we redirect automatically and how long we wait before redirecting, add redirectdelay (in seconds):

https://onboarding.zwapgrid.com/consent/<Consent ID>/?otc=<one-time-code>&redirecturl=<url>&redirectdelay=<delay-in-seconds>

Use this when you want to show a completion message before the redirect.