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.

The GBG Trust module performs fraud checks by evaluating submitted identity data against the GBG Trust Network. It surfaces fraud signals such as application fraud, identity takeover, and mule activity during onboarding. This page contains documentation for the GBG Trust module, including its variants, capabilities, and the specific result values each variant returns. The module has two documented variants. Both draw from the GBG Trust Network, but they differ in result type and how outcomes are configured.
VariantResult type
GBG Trust EMEANumeric score (0–1000)
GBG Trust - AlertsBinary outcome with rule names

GBG Trust EMEA

The GBG Trust EMEA variant returns a numeric trust score that indicates the fraud risk level of the submitted identity data. Higher scores indicate lower risk. This variant requires the subject’s full name and date of birth. The current address is optional but improves match accuracy.

Capabilities

The module returns three capabilities, a trust score and two service-status flags.

GBG Trust score

This capability returns an integer trust score indicating the fraud risk level of the submitted identity data.
DetailDescription
TypeInteger
Range0–1000
Default0
A higher score indicates lower fraud risk. A score of 0 indicates that the comparison could not produce a result and should be treated as inconclusive rather than a confirmed high-risk outcome.

GBG Trust not available

This capability indicates whether the GBG Trust service was unavailable at the time of evaluation.
DetailDescription
TypeBoolean
ValuesisTrue, isFalse
DefaultisTrue

GBG Trust time out

This capability indicates whether the GBG Trust service timed out during the evaluation.
DetailDescription
TypeBoolean
ValuesisTrue, isFalse
DefaultisFalse

Default outcomes

The module uses score thresholds to classify the trust result into one of five outcomes.
OutcomeConditionDescription
Low RiskScore ≥ 600The identity data shows low fraud risk and can typically be accepted without further review.
Medium RiskScore ≥ 250 and ≤ 600The identity data shows moderate fraud risk. Depending on your risk tolerance, this might route to additional verification or manual review.
High RiskScore > 0 and < 250The identity data shows elevated fraud risk. This outcome typically routes to manual review or rejection.
UnknownScore is 0 or GBG Trust not available is isTrueThe service could not produce a result. Treat as inconclusive rather than as a confirmed high-risk outcome.
ERRORDefault (no conditions matched)The trust check could not be completed due to a system-level issue.

Input payload

The following is a sample payload used to submit identity data to the GBG Trust EMEA variant for processing.
JSON
{
  "resourceId": "your-journey-resourceID@latest",
  "context": {
    "subject": {
      "identity": {
        "firstName": "John",
        "lastNames": ["Doe"],
        "dateOfBirth": "1990-01-01",
        "currentAddress": {
          "building": "1",
          "thoroughfare": "Long Street",
          "locality": "Bristol",
          "postalCode": "PC5 1LT",
          "country": "GBR"
        },
        "phones": [
          {
            "type": "Landline",
            "number": "+441234567890"
          },
          {
            "type": "Mobile",
            "number": "+447700900123"
          }
        ],
        "emails": [
          {
            "type": "home",
            "email": "john.doe@example.com"
          }
        ]
      },
      "documents": [
        {
          "type": "Driving Licence",
          "number": "DOE99012345AB6CD",
          "country": "GBR"
        },
        {
          "type": "International Passport",
          "number": "123456789",
          "country": "GBR"
        }
      ]
    }
  }
}
The table below describes each field in the payload.
FieldRequiredDescription
identity.firstNameYesFirst name of the subject.
identity.middleNamesNoArray containing middle name(s) of the subject.
identity.lastNamesYesArray containing the last name(s) of the subject.
identity.dateOfBirthYesDate of birth in YYYY-MM-DD format.
identity.currentAddressNoCurrent address of the subject, broken down into building, thoroughfare, locality, postalCode, and country in ISO 3166-1 alpha-3 format. Improves match accuracy when supplied.
identity.phonesNoArray of phone numbers. Each entry includes a type, for example, Landline or Mobile, and a number in international format.
identity.emailsNoArray of email addresses. Each entry includes a type, for example, home, and an email value.
documents[].typeNoDocument type, for example, Driving Licence or International Passport.
documents[].numberNoDocument number as printed on the document.
documents[].countryNoCountry of issue in ISO 3166-1 alpha-3 format.

Sample response

The following is a sample response for a medium-risk trust outcome.
JSON
{
  "response": {
    "advice": {
      "contains": {
        "gbgTrustNotAvailable": false
      }
    },
    "outcome": "Medium Risk"
  }
}

GBG Trust - Alerts

The Alerts variant evaluates a set of configurable alert rules against the GBG Trust Network and returns whether any rules triggered. Rather than a numeric score, it returns a pass or alert outcome with detail on which specific rules fired. You configure which alert rules are active, and you can use the names of triggered rules to drive journey routing decisions.

Capabilities

The module returns two capabilities, an overall alert outcome and the list of rules that triggered.

GBG Trust alert overall outcome

This capability indicates whether any configured alert rules triggered for the subject.
DetailDescription
TypeBoolean
ValuesisTrue, isFalse
DefaultisFalse

GBG Trust alert rules triggered

This capability returns the names of the specific alert rules that triggered, if any.
DetailDescription
TypeEnumset
ValuesGBG Alert Rule A1, GBG Alert Rule B1, GBG Alert Rule A6
DefaultNone

Default outcomes

The module classifies the alert evaluation into one of three outcomes based on whether any rules triggered.
OutcomeConditionDescription
PASSAlert overall outcome is isFalseNo alert rules triggered. The subject can typically proceed without further review.
ALERTAlert overall outcome is isTrueOne or more alert rules triggered. Check the triggered rules capability to determine the specific signals and route accordingly.
ERRORDefault (no conditions matched)The alert evaluation could not be completed due to a system-level issue.

Input payload

The following is a sample payload used to submit identity data to the GBG Trust - Alerts variant for processing.
JSON
{
  "resourceId": "your-journey-resourceID@latest",
  "context": {
    "subject": {
      "identity": {
        "title": "Mr.",
        "firstName": "John",
        "middleNames": ["TWOFFFFFFFFFFFFFFFFFFFFFFFFFFF"],
        "lastNames": ["Doe"],
        "dateOfBirth": "1980-01-01",
        "gender": "Male",
        "currentAddress": {
          "country": "AU",
          "postalCode": "2617",
          "administrativeArea": "ACT",
          "dependentLocality": "Belconnen",
          "thoroughfareType": "Street",
          "thoroughfare": "Baloney",
          "building": "42"
        }
      },
      "previousAddress": [],
      "phones": [
        {
          "type": "mobile",
          "number": "0420000009"
        }
      ],
      "emails": [
        {
          "type": "personal",
          "email": "john.doe@example.com"
        }
      ],
      "socials": [
        {
          "type": "facebook",
          "identity": "john.doe"
        }
      ]
    }
  }
}
The table below describes each field in the payload.
FieldRequiredDescription
identity.titleNoSubject’s title, for example, Mr., Ms., Dr..
identity.firstNameYesFirst name of the subject.
identity.middleNamesNoArray containing middle name(s) of the subject.
identity.lastNamesYesArray containing the last name(s) of the subject.
identity.dateOfBirthYesDate of birth in YYYY-MM-DD format.
identity.genderNoSubject’s gender, for example, Male or Female.
identity.currentAddressNoCurrent address of the subject, broken down into building, thoroughfareType, thoroughfare, dependentLocality, administrativeArea, postalCode, and country in ISO 3166-1 alpha-2 or alpha-3 format.
previousAddressNoArray of the subject’s previous addresses. Same structure as currentAddress.
phonesNoArray of phone numbers. Each entry includes a type, for example, mobile or landline, and a number.
emailsNoArray of email addresses. Each entry includes a type, for example, personal or home, and an email value.
socialsNoArray of the subject’s social media identities. Each entry includes a type, for example, facebook, and an identity — the username or handle.

Sample response

The following is a sample response for an alert outcome.
JSON
{
  "response": {
    "advice": {
      "contains": {
        "alertRaised": true
      }
    },
    "export": {
      "sku": ["greenID_AU_trustalert"]
    },
    "outcome": "ALERT"
  }
}