The GBG GO API allows you to trigger customer journeys programmatically, track their progress, and submit customer data as needed. If you’re building an integration with the GBG GO API, you’ll need to follow a series of API calls to execute a journey successfully. Each step involves retrieving information, handling customer input, and progressing the journey toward completion. This page gives you a high-level view of the journey execution process and what to prepare before you start.

​
Before you begin

Make sure you have the following in place before using the API:
  • A published customer journey
    A business user (someone closer to the business) must first design and publish the journey in the GBG GO platform. If you’re unsure, check with your team to confirm the journey is ready.
  • API access and credentials
    You need an API Client ID, Client Secret, Username, and Password. These are provided by your GBG account manager. See the next step, Authenticate, to learn more.
  • Understanding of your journey’s tasks
    Customer journeys may include document upload, ID checks, or biometric validation. Confirm which steps apply to your specific journey before integrating.
If you’re a business user, work with your developer or technical team to set up the API integration once the journey is published.

​
Execution flow

A complete customer journey execution consists of six main steps:
  1. Authenticate
    Get an access token to authorize API requests.
  2. Start a journey
    Trigger a journey instance using the published journey’s resource ID.
  3. Retrieve tasks
    Fetch assigned tasks that need to be completed in the journey.
  4. Manage schemas
    Retrieve schemas to understand the structure of required data for each task.
  5. Submit task data
    Submit data to complete the journey’s tasks.
  6. Fetch journey state
    Check the journey’s current progress or completion status.
Refer to the API reference for detailed endpoint information, request formats, and examples.
If an API request fails, troubleshoot using the Handle errors guide.

​
Next step

Go to Authenticate to learn how to get your access token.