Onboarding
This page describes what customers need to know and do during the Open Gateway onboarding process with Biza.
Overview
When you onboard with Open Gateway, Biza will provision and supply everything needed for your software product to connect. You are responsible for:
- Building software that connects to the Open Gateway API using the credentials supplied by Biza.
- Configuring an identity provider (IDP) for the OG Dashboard (Consumer profile login) (see OAuth2 Clients).
- Setting up SendGrid for consumer email notifications (Configure Notifications).
What Biza Provides
During onboarding, Biza will provide:
- OG API M2M credentials: client ID, client secret, and the permission scopes granted for your software product. These are managed by Biza via Biza ID.
- OG Admin access: access to the OG Admin portal is granted via Biza ID. Biza will provision your administrator account.
- Software product configuration: Biza administers software product registration within Open Gateway on your behalf.
- Connection details: API base URLs, environment details, and any other configuration required to connect your software to Open Gateway.
Customer IDP Setup (OG Dashboard)
Customers must supply an identity provider for the Open Gateway Consumer Dashboard only. This allows your consumers to log in and manage their data sharing agreements.
Refer to:
- OAuth2 Profiles (Consumer) for the required OAuth2 profile.
- OAuth2 Clients (OG Dashboard) for the client configuration.
- Cognito OAuth Integration for an example using AWS Cognito.
Next Steps
Once onboarding is complete:
- Ensure your SendGrid integration is configured (see Configure Notifications).
- Integrate your software product with the Open Gateway API (see Developer Resources).