Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.go.gbgplc.com/llms.txt

Use this file to discover all available pages before exploring further.

The API-first integration method gives you full control over the end-user experience. You build your own frontend application and use the GBG GO APIs to start journeys, fetch interactions, submit verification data, and monitor progress.
If you don’t need to build a custom frontend, consider Hosted journeys instead. With hosted journeys, the GBG GO platform generates and hosts the verification screens for you. You start a journey with a single API call and receive a URL where end users complete verification. No frontend development required.

​
SDKs

Official SDKs simplify integration and reduce boilerplate. Use the Core SDK for server-side API access, and the Bridge SDKs to embed pre-built web journeys in your native apps with device capabilities like camera, NFC, and biometrics.

SDK overview

Understand the SDK architecture and choose the right SDK for your use case.

Core SDK

Type-safe TypeScript client for the GBG GO API.

iOS Bridge

Embed journeys in your iOS app with native device features.

​
API integration

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 journey: Initiate a verification process for a user.
  • Fetch the current interaction: Discover what domain element data the end user must provide.
  • Submit interaction data: Provide the collected data such as identity details, documents, or biometrics.
  • Monitor journey progress: Track whether a journey is in progress or completed.
Each journey collects data through interactions. Each interaction specifies a set of domain elements. These are units of identity data such as FullName, DateOfBirth, or PrimaryDocument that the end user must provide. As you integrate, you’ll use the API to fetch and complete these interactions step by step.
For an overview of key concepts such as journeys, interactions, and domain elements, see Key concepts.

​
Why use the GBG GO API?

The API allows you to automate customer verification, reducing manual reviews and enhancing user experience. Benefits include:
  • Customisable workflows: Execute verification processes tailored to your business.
  • Real-time updates: Fetch interactions and submit data dynamically.
  • Consistent tracking: Monitor customer journeys at any stage.
For detailed API request and response definitions, refer to the API reference.