Skip to main content
The GBG Go API provides a set of RESTful endpoints for managing customer verification and authentication journeys. Use this API to initiate verification processes, retrieve tasks, submit customer data, and track journey progress.

​
API protocols

The API follows REST principles and supports the following request methods:
  • POST: Submit data or trigger actions.
  • GET: Retrieve information from the system.
All responses are returned in JSON format. Requests must include a Content-Type: application/json header.

​
Authentication

You must authenticate API requests using a Bearer token. Include the token in the Authorization header of every request. To get a token, you first need an API client. Create an API client in the Account management portal to get a client ID and client secret. You can reuse these credentials each time you request an access token from the authentication endpoint. GBG Go shows the client secret only once, when you create the API client. Copy it and store it somewhere safe. For steps to create an API client and request a token, see Manage API clients. For the token endpoint schema, see the Generate access token endpoint reference.

​
Base URL

All API requests must be sent to the appropriate regional endpoint based on your deployment:
Select the endpoint that corresponds to your region to ensure optimal performance and compliance with regional data regulations. Each region covers a wider area than the code in its URL suggests. For example, organisations in the United Kingdom use the Europe (eu) endpoint.
If you’re not sure which region your organisation is set up in, contact us.

​
Error handling

The API returns standard HTTP status codes to indicate success or failure. If a request fails, the response includes an error code and description to help you troubleshoot the issue. For more information, see how to handle errors.

​
API status and availability

Check the system status page to monitor downtime, maintenance schedules, and service disruptions.

​
Next steps

To start using the API:
  1. Create an API client and copy its client ID and client secret.
  2. Use the client ID and client secret to request a Bearer token.
  3. Include the token in the Authorization header of your API requests.
  4. Refer to the relevant endpoint documentation for request and response details.