Customer journeys and workflow
A customer journey is a structured process that guides a user through steps such as identity verification, document processing, and approvals.- Business users create and configure customer journeys in the GBG GO platform. They define workflows, add verification steps, and publish journeys.
- Developers integrate with the API to start journeys, retrieve tasks, and submit customer data.
Outcomes and decisions
In GBG GO, outcomes typically refer to module results while decisions refer to evaluation results. See Glossary of terms for more details. Outcomes and decisions are evaluated in order from top to bottom. When a condition is met, that result is returned and processing stops. For example, in a NameMatch module, if customer names match correctly, the system immediately returns the IsNameMatch outcome. All remaining configured outcomes are skipped.Journey instance
When a journey starts, the system creates a journey instance, which represents an active execution of a customer journey. Each instance is assigned a uniqueinstanceId
, which you use to track progress, retrieve tasks, and submit data.
Resource ID and journey versions
A resource ID identifies a specific journey version. When a journey is published, it receives a unique resource ID. To start a journey, you provide this ID in the request. If you want to start the most recent published version, append@latest
(e.g., your-resource-id@latest
). If your integration requires a specific version, use the fixed resource ID instead of @latest
.
Tasks and data requirements
A task is an action a user must complete within a journey. These actions may involve providing identity details, uploading documents, or performing biometric verification.Task lifecycle
Tasks move through different stages based on how the journey is configured:- Assigned – The task is created and waiting for input.
- In Progress – The task has been started.
- Completed – The required data has been submitted and validated.
Task ID
Each task within a journey has a unique task ID, which you use to:- Retrieve the list of tasks assigned to a journey instance.
- Fetch the schema that defines required data for a task.
- Submit task data to progress the journey.
Task schema
A task schema defines the required fields and expected data structure for a task. The schema ensures that submitted data follows the correct format. If a journey is running in Prefill Mode, you must retrieve the schema from the Journey Dashboard in the GBG GO platform before starting the journey. The schema tells you:- Which fields must be included.
- What data types are expected (
string
,array
,object
). - How identity information should be structured.
Identity and user data in journeys
A context object holds structured user data, including:- Personal details: First name, last name, date of birth.
- Contact information: Email addresses, phone numbers.
- Address details: Current and previous addresses.
- Government-issued IDs: Passport numbers, Social Security Numbers.
User roles in GBG GO
There are two main user roles in the platform:- Business users design and configure customer journeys in the GBG GO platform. They define workflows, add verification modules, and publish journeys.
- Developers integrate with the API to start journeys, retrieve tasks, and submit user data.
Authentication and security
Access tokens
To interact with the API, you must authenticate using an access token. This temporary credential is required for every API request.- Access tokens must be included in the
Authorization
header. - They expire after a set period and must be refreshed when they become invalid.
Device connection
Some journeys require linking a customer’s session to a device. In such cases, the API provides a connection secret, allowing the device to:- Authenticate without requiring repeated logins.
- Refresh its session securely.
Journey state and tracking
A journey state indicates the current status of an active journey instance. The most common states include:- In Progress: The journey is active, and tasks are pending.
- Completed: The journey has been fully processed.
- Pending Input: The journey is waiting for user action.