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.

In a hosted journey, verification modules require specific pieces of identity data such as a name, date of birth, or address, before they can process a check. Interactions are the mechanism through which this data is collected from end users. They define what information to request, how to organise it across pages, and in what order to present it. When you enable hosted pages as the delivery method for a journey, the GBG GO platform generates a set of interaction pages based on the domain elements required by the modules in your flow. Each page presents input fields that map directly to the data those modules consume.

​
Key concepts

Here are some key concepts to understand about interactions:

​
Domain elements

A domain element is a specific piece of information required by one or more verification modules. Examples include FullName, DateOfBirth, CurrentAddress, MobilePhone, PersonalEmail, and SSN. The platform maintains a catalogue of domain elements, and each module in a journey declares which elements it needs as inputs. When multiple modules in the same journey require the same domain element, the platform collects it only once. This deduplication is handled automatically to avoid asking end users for the same information more than once.

​
Interaction groups

An interaction group is a collection of related data fields and pages that the platform presents to end users as a single block within a journey flow. Rather than scattering data collection across individual module steps, the platform groups the required fields together and organises them into pages. Each interaction group contains:
  • Data fields: The domain elements the journey needs to collect. For example, an interaction group might include FullName, DateOfBirth, CurrentAddress, PreviousAddresses, MobilePhone, PersonalEmail, and SSN.
  • Pages : Logical groupings that split the data fields into manageable screens. For example, a “Personal details” page might collect first name, last name, and date of birth, while a “Contact details” page collects phone number and email address.
This grouping reduces friction for end users by consolidating data collection into a clear, sequential set of screens rather than requesting information at multiple unrelated points in the flow.

​
Pages, cards, and screens

Interaction groups organise data collection into a layered structure:
  • Pages: These represent individual screens in the end-user interface. Each page contains one or more cards that collect related information.
  • Cards: Visual groupings of input fields within a page. A card typically collects data for a single domain element or a set of closely related elements.
  • Screens: These are what the end user sees and navigates through using Next and Back controls.
Pages should contain no more than five fields to maintain a clear, readable layout.

​
How the platform generates interactions

When you choose Hosted journeys as the integration method for a journey that contains one or more modules, the platform performs the following steps:
  1. Collects the list of domain elements required by each module in the flow.
  2. Removes duplicate entries where multiple modules require the same element.
  3. Sorts the elements based on the order of modules in the flow and the field order within each module.
  4. Creates an interaction group and distributes the fields across pages, with each page containing up to five fields.
If a module appears after an evaluation node in the flow and requires additional data, the platform creates a separate interaction to collect that data at the appropriate point. This approach requests information only when it is needed, reducing the number of fields end users encounter upfront.

​
Customising interactions

In the Interaction Group panel, you can remove data fields that your journey doesn’t need to collect. If a domain element is not required by your specific configuration, you can remove it from the interaction group. When you remove a field, it moves to the Start of journey node of the journey. Click the Start of journey node to view all removed fields. If a module still requires that data, it must be provided via pre-fill when the journey is started. To learn more, refer to Start a journey (partial prefill mode). All changes to interaction fields and pages are recorded in the audit log.
Removing a field that is required by a module in the journey may affect the module’s ability to process the verification check. Review the list of required fields for each module before removing any data fields.

​
Interaction lifecycle during execution

When a journey instance reaches an interaction group during execution, the platform:
  1. Displays the first page of the interaction to the end user.
  2. Waits for the end user to complete the fields and navigate through the pages.
  3. Validates the submitted data against the domain element requirements.
  4. Advances the journey to the next step in the flow once all required data is submitted.