The GBG GO API allows you to integrate customer verification workflows into your system. You can use it to verify identities, collect documents, or track journey progress while interacting with the GBG GO platform in a structured way.

If you’re new to the API, this guide walks you through the key integration steps and what to expect when executing a journey.

How the API works

The GBG GO API is designed to let you:

  • Start a customer journey: Initiate a verification process for a user.
  • Retrieve assigned tasks: Fetch actions required to complete verification.
  • Submit customer data: Provide necessary details like identity, documents, or biometrics.
  • Monitor journey progress: Track whether a journey is in progress or completed.

Each journey consists of tasks that require user input, such as identity verification, document submission, or biometric checks. As you integrate, you’ll use the API to retrieve and complete these tasks step by step.

For an overview of key concepts such as customer journeys, tasks, and schemas, see Key concepts.

Integration steps

To integrate the GBG GO API into your system, follow these steps:

  1. Authenticate API requests: Generate a Bearer token to authorize API calls. See Authentication.
  2. Start a customer journey: Trigger a verification journey. See Start journey.
  3. Retrieve and complete tasks: Fetch required actions and submit user data. See Retrieve tasks.
  4. Track journey progress: Check if the journey is in progress or completed. See Fetch journey state.

For a full breakdown of each step, visit the Execute journeys guide.

To identify and resolve common issues. See Handle errors.

Why use the GBG GO API?

The API allows you to automate customer verification, reducing manual reviews and enhancing user experience. Benefits include:

  • Customizable workflows: Execute verification processes tailored to your business.
  • Real-time updates: Fetch tasks and submit data dynamically.
  • Consistent tracking: Monitor customer journeys at any stage.

For detailed API requests, refer to the API Reference.