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.

GBG GO APIs use conventional HTTP response codes to indicate the success or failure of an API request.
CodeDescriptionNotes
200OkRequest successful
201CreatedNew resource created successfully
400Bad requestRequest invalid or missing required parameters
401UnauthorizedNo valid authentication token or token expired
403ForbiddenNo permission to access the requested resource
404Not foundRequested resource or endpoint does not exist
405Method not allowedHTTP method used, for example, GET or POST, is not supported
500Internal server errorA problem with the API, which may not be related to your request server
503Service unavailableAPI service is temporarily down
For more details on API response codes and troubleshooting, refer to Error handling.

​
FAQ

You can access detailed failure reasons in two ways:
  • Through the v2 API error response
  • Through the Investigation portal.

​
v2 API error responses

The v2 API returns structured error objects that include a machine-readable error code, a description of the problem, and a recommended action. Each error specifies where the issue originated, making it easier to diagnose failures programmatically.
{
  "errors": [
    {
      "code": "4002",
      "name": "MISSING_FIELD",
      "location": "Body",
      "problem": "problem description goes here",
      "action": "action to resolve the issue goes here"
    }
  ]
}
FieldDescription
codeNumeric error code (returned as a string).
nameMachine-readable error identifier (for example, MISSING_FIELD).
locationWhere the error originated: Body, Authorization, Path, or Service.
problemA description of what went wrong.
actionWhat you should do to resolve the error.
Every API response also includes an X-Request-ID header. Include this value when contacting GBG support. It correlates your request with server-side logs for faster troubleshooting.

​
Investigation portal

For document-specific verification failures, the Investigation portal provides the most detailed view. To access granular failure reasons:
  1. Log in to the GBG GO platform and navigate to the Investigation section.
  2. Click the Session ID of the session you want to review. This opens the session detail view, which shows an overview of the session.
  3. Navigate to the Processing tab to see each module’s outcome, for example, Match, No Match, or Error.
  4. Expand any module section to see a breakdown of individual data point matches.
  5. Click More details to open the module detail view. The available tabs vary by module type.
  6. Check the Raw Response tab for the complete response from the verification provider, which contains the module errors and reasons.