Response advice schema

This section contains an explanation of the response schema returned by journeys

Understand the response object and schema

When you execute a data verification journey through the GBG GO API, the API returns a response object containing verification results, advice, and outcome information. This object provides structured data about the verification process and its results.

What is the response object?

The response object is the structured data returned after a journey execution. It contains verification results, matching scores, and advice that can be used to make decisions about identity verification.

The primary sections of the response object include:

• advice: Contains detailed verification results and matching indicators
• outcome: The overall verification outcome for example, Match or No Match

Why is the response schema important?

• It provides actionable verification results for decision-making
• It includes detailed matching scores across different data points, for example, name, address, DOB, and documents
• It helps you understand the confidence level of the verification

The response schema may vary depending on the journey configuration and the data sources used. Always refer to your specific journey’s documentation for the most accurate schema structure.

How to use the table below

The following table provides a detailed breakdown of all possible fields in the response object. It includes field names, descriptions, expected data types, and example values. Use this reference to understand and process API responses correctly.

Response

This schema represents the structure of the response returned by data verification journeys.

Property	Type	Description
advice	Advice	Detailed verification results and match scores
outcome	string	Overall verification outcome

Sample data

JSON

{
  "advice": {
    "contains": {
      "nameAddress": 1,
      "nameDob": 1,
      "nameDobAddress": 1,
      "idNameAddress": 1,
      "idNameDob": 1,
      "idNameAddressDob": 1,
      "idName": 1,
      "sources": 1,
      "isUnder18": false,
      "customDecision": null,
      "gbgScore": 400
    }
  },
  "outcome": "Match"
}

Schemas breakdown

The following sections provide detailed breakdowns of the nested objects within the response schema.

Advice

The advice object contains a contains property that holds detailed verification results with matching scores and indicators across different data combinations.

Property	Type	Description
contains	Contains	Object containing verification match indicators

Contains

The contains object holds all the verification match scores and indicators.

Property	Type	Description
nameAddress	integer	Match score for name and address combination (0 = no match, 1 = match)
nameDob	integer	Match score for name and date of birth combination
nameDobAddress	integer	Match score for name, date of birth, and address combination
idNameAddress	integer	Match score for document ID, name, and address combination
idNameDob	integer	Match score for document ID, name, and date of birth combination
idNameAddressDob	integer	Match score for document ID, name, address, and date of birth combination
idName	integer	Match score for document ID and name combination
sources	integer	Number of data sources used in the verification
isUnder18	boolean	Indicates whether the subject is under 18 years old
customDecision	string or null	Custom decision logic result (if configured in the journey)
gbgScore	integer	Overall GBG verification score (higher scores indicate stronger matches)

Match numbers

Match numbers typically use the following scale:

• 0 = No match found
• 1 = Match found

Higher values indicate stronger matches or multiple confirmations.

Sample Data

{
  "nameAddress": 1,
  "nameDob": 1,
  "nameDobAddress": 1,
  "idNameAddress": 1,
  "idNameDob": 1,
  "idNameAddressDob": 1,
  "idName": 1,
  "sources": 1,
  "isUnder18": false,
  "customDecision": null,
  "gbgScore": 400
}

Outcome

The outcome field represents the overall result of the verification journey.

Value	Description
Match	Verification successful, data matched against sources
No Match	Verification unsuccessful, data did not match

The specific outcome values may vary depending on your journey configuration. Check your journey settings for the exact outcome values used in your implementation.

Sample Data

"Match"

Understanding GBG score

The gbgScore is a numerical value that represents the overall confidence in the verification result.

• Higher scores indicate stronger matches with more data points verified
• Score ranges vary by data source and region
• Range: 0-1000, with 1000 being the highest confidence level

Use the GBG score in combination with individual match indicators to make informed decisions about identity verification.

Related Documentation

• User data input schema - Learn about the input data structure for verification requests
• API Endpoints - See how to make verification API calls