Skip to main content
Hosted journeys use the GBG GO platform to handle the end-user experience. Your backend starts the journey and receives a hosted page URL, which you redirect end users to. The platform handles the verification flow, and your backend polls for journey state to detect when the journey completes. This guide walks you through the complete integration flow for executing a hosted journey using the API.

​
Before you begin

Make sure you have the following in place before using the API:
  • A published Hosted journey. To learn how to create and publish a hosted journey, refer to Create hosted journeys. You need the journey’s resource ID and version to start a journey instance.
  • An API client for API authentication, which provides a Client ID and Client secret. You create API clients yourself in the Account management portal. See Manage API clients to create one.

​
Execution flow

A complete hosted journey execution consists of three steps:
  1. Authenticate: Get access token to authorise API requests.
  2. Start a journey: Create a new journey instance using the published journey’s resource ID. Include config.delivery: "page" to receive an instanceUrl in the response.
  3. Share the instanceUrl with the end user to complete the verification steps on the hosted pages. Your backend polls for journey completion by fetching the journey state. Once the journey completes, you can retrieve the verification results from the API response.
  4. Fetch journey state: Poll the journey status to detect completion and retrieve verification results.
After starting the journey, share the instanceUrl with the end user, either through redirect, email, SMS, or QR code. The hosted pages handle the entire verification experience. Your backend only needs to poll for completion.

​
Reference