GBG Developers

sdfsdfsdf

some text

.red { fill: #b0013a; }

Document Data (new)

Post /verify/people/v4/person/documentData/

Allows the calling system to submit a set of data from a document and have it verified against a preset list of checks. This call should be used where this is the first step in the verification process.

Mandatory fields are highlighted
Header Parameters
Name Type Description
Authorization string

A JWT token to allow access

cleanse-address boolean

Specifies if the addresses should be cleansed by our Loqate product to improve the verification results.

Example: true
journey-id string

Used by ID3 to pick out the preconfigured list of checks to do against this submission

Example: 9d75d85e-f7bc-4d22-a93b-60c04881193d
journey-version integer

Used by ID3 to pick out the preconfigured list of checks to do against this submission

Example: 1
customer-reference string

Allows you to submit a UUID that can be used to track this verification

Example: 9d75d86e-f7bc-4d22-a93b-59c04881193f
Request Body
  • {
    One of ->
    • ukdrivingLicence {
      • firstName string

        A person's name used by their collegues and friends to address them

        example: David
      • lastName Array [
        • string example: Jones
        ]
      • dateOfBirth string

        Specified in year, month and day separated by - which conforms to ISO 8601, should be two digit month and day

        Pattern: ^\d{4}-\d{2}-\d{2}$ example: 2000-01-01
      • issueDate string

        Specified in year, month and day separated by - which conforms to ISO 8601, should be two digit month and day

        Pattern: ^\d{4}-\d{2}-\d{2}$ example: 2000-01-01
      • expiryDate string

        Specified in year, month and day separated by - which conforms to ISO 8601, should be two digit month and day

        Pattern: ^\d{4}-\d{2}-\d{2}$ example: 2000-01-01
      • documentNumber string
      • address {
        • lines Array [
          • string
          ]
        • address string

          Used in the response to contain the full address.

        • premise string example: 128
        • building string
        • subBuilding string
        • thoroughfare string example: Queen Victoria Street
        • dependentThoroughfare string
        • locality string example: London
        • dependentLocality string
        • doubleDependentLocality string
        • postalCode string example: EC4V 4BJ
        • postBox string
        • country string

          Country the address is in. It must be a valid ISO2 or ISO3 country code

          example: GBR
        • superAdministrativeArea string
        • administrativeArea string
        • subAdministrativeArea string
        • organization string example: GB Group
        • quality {
          • avc string
          • aqi string
          }
        • location {
          • latitude string
          • longitude string
          • geoAccuracy string
          }
        }
      • licenseCategory string
      • portraitPhoto string

        the image would be base64

      }
    • passport {
      • passportNumber string

        Passport number

      • shortPassportNumber string

        Short passport number

      • countryOfOrigin string

        Country of origin

      • issueDate string

        Specified in year, month and day separated by - which conforms to ISO 8601, should be two digit month and day

        Pattern: ^\d{4}-\d{2}-\d{2}$ example: 2000-01-01
      • expiryDate string

        Specified in year, month and day separated by - which conforms to ISO 8601, should be two digit month and day

        Pattern: ^\d{4}-\d{2}-\d{2}$ example: 2000-01-01
      • birthdate string

        Specified in year, month and day separated by - which conforms to ISO 8601, should be two digit month and day

        Pattern: ^\d{4}-\d{2}-\d{2}$ example: 2000-01-01
      • placeOfBirth string

        Place passport holder was born (as shown on passport)

      • lastNames Array [
        • string example: Jones
        ]
      • firstName string

        A person's name used by their collegues and friends to address them

        example: David
      • middleNames Array [
        • string example: James
        ]
      • gender string Enum: [MALE, FEMALE, UNSPECIFIED] example: MALE
      }
    • europeanID {
      • title string

        Title of an individual such as Mr, Mrs, Dr, Sir

        example: Mr
      • firstName string

        A person's name used by their collegues and friends to address them

        example: David
      • middleNames Array [
        • string example: James
        ]
      • lastNames Array [
        • string example: Jones
        ]
      • gender string Enum: [MALE, FEMALE, UNSPECIFIED] example: MALE
      • birthdate string

        Specified in year, month and day separated by - which conforms to ISO 8601, should be two digit month and day

        Pattern: ^\d{4}-\d{2}-\d{2}$ example: 2000-01-01
      • address {
        • premise string example: 128
        • building string
        • subBuilding string
        • thoroughfare string example: Queen Victoria Street
        • dependentThoroughfare string
        • locality string example: London
        • dependentLocality string
        • postalCode string example: EC4V 4BJ
        • country string
        • superAdministrativeArea string
        • administrativeArea string
        }
      • cardLine1 string
      • cardLine2 string
      • cardLine3 string
      • countryOfNationality string
      • countryOfIssue string
      • expiryDate string

        Specified in year, month and day separated by - which conforms to ISO 8601, should be two digit month and day

        Pattern: ^\d{4}-\d{2}-\d{2}$ example: 2000-01-01
      }
    • australianMedicare {
      • title string

        Title of an individual such as Mr, Mrs, Dr, Sir

        example: Mr
      • firstName string

        A person's name used by their collegues and friends to address them

        example: David
      • middleNames Array [
        • string example: James
        ]
      • lastNames Array [
        • string example: Jones
        ]
      • gender string Enum: [MALE, FEMALE, UNSPECIFIED] example: MALE
      • birthdate string

        Specified in year, month and day separated by - which conforms to ISO 8601, should be two digit month and day

        Pattern: ^\d{4}-\d{2}-\d{2}$ example: 2000-01-01
      • address {
        • premise string example: 128
        • building string
        • subBuilding string
        • thoroughfare string example: Queen Victoria Street
        • dependentThoroughfare string
        • locality string example: London
        • dependentLocality string
        • postalCode string example: EC4V 4BJ
        • country string
        • superAdministrativeArea string
        • administrativeArea string
        }
      • cardNumber string
      • referenceNumber string
      • lastNameAtCitizenship string
      • middleNameOnCard string
      • cardColour string
      • expiryDate string

        Specified in year, month and day separated by - which conforms to ISO 8601, should be two digit month and day

        Pattern: ^\d{4}-\d{2}-\d{2}$ example: 2000-01-01
      }
    • chineseID {
      • title string

        Title of an individual such as Mr, Mrs, Dr, Sir

        example: Mr
      • firstName string

        A person's name used by their collegues and friends to address them

        example: David
      • middleNames Array [
        • string example: James
        ]
      • lastNames Array [
        • string example: Jones
        ]
      • gender string Enum: [MALE, FEMALE, UNSPECIFIED] example: MALE
      • birthdate string

        Specified in year, month and day separated by - which conforms to ISO 8601, should be two digit month and day

        Pattern: ^\d{4}-\d{2}-\d{2}$ example: 2000-01-01
      • address {
        • premise string example: 128
        • building string
        • subBuilding string
        • thoroughfare string example: Queen Victoria Street
        • dependentThoroughfare string
        • locality string example: London
        • dependentLocality string
        • postalCode string example: EC4V 4BJ
        • country string
        • superAdministrativeArea string
        • administrativeArea string
        }
      • idCardNumber string
      }
Response

The data provided was accepted and the verification results are returned

Response Headers
Name Type Description
verification-id string

The unique key for this verification transaction. This is the same as the verificationID field in the response.

customer-reference string

The same id as provided by the customer in the inbound header

person-id string

Provides a unique key to allow retrieval of the data submitted or the results of the verification in other methods

Response Body
  • {
    • verificationID string Pattern: ^(\{{0,1}([0-9a-fA-F]){8}-([0-9a-fA-F]){4}-([0-9a-fA-F]){4}-([0-9a-fA-F]){4}-([0-9a-fA-F]){12}\}{0,1})$ example: 7ab2ff08-728a-42e6-aa38-df191ffd4817
    • timestamp string

      An ISO 8601 timestamp, with no optional bits:
      1) hyphens MUST be used to separate the date components
      2) day and month should be 2 digits
      3) colons MUST be used to separate the time components
      4) timestamps MUST NOT contain milliseconds
      5) timestamp MUST indicate the timezone, either as a time offset or a Zulu time indicator

      Pattern: ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(([+-]\d{2}:\d{2})|Z)$ example: 2019-01-04T14:38:25
    • verificationURL string

      A URL to retrieve the full verification details

      example: https://api.gbgplc.com/people/{person-id}/verifications/{verification-id}
    • THIS IS A NULL VALUE
    • decision {
      • current string
      • combined string Enum: [REFER, PASS, UNDETERMINED] example: PASS
      }
    • action string

      Instruction on what a user needs to do next

      example: Upload next document
    }
{
  "verificationID": {
    "PrimitiveType": 4,
    "AnyType": 0,
    "Value": "7ab2ff08-728a-42e6-aa38-df191ffd4817"
  },
  "timestamp": {
    "PrimitiveType": 9,
    "AnyType": 0,
    "Value": "2019-01-04T14:38:25+00:00"
  },
  "verificationURL": {
    "PrimitiveType": 4,
    "AnyType": 0,
    "Value": "https://api.gbgplc.com/people/{person-id}/verifications/{verification-id}"
  },
  "person": null,
  "decision": {
    "current": {
      "Title": null,
      "Type": "string",
      "Format": null,
      "Description": null,
      "Maximum": null,
      "ExclusiveMaximum": null,
      "Minimum": null,
      "ExclusiveMinimum": null,
      "MaxLength": null,
      "MinLength": null,
      "Pattern": null,
      "MultipleOf": null,
      "Default": null,
      "ReadOnly": false,
      "WriteOnly": false,
      "AllOf": [],
      "OneOf": [],
      "AnyOf": [],
      "Not": null,
      "Required": [],
      "Items": null,
      "MaxItems": null,
      "MinItems": null,
      "UniqueItems": null,
      "Properties": {},
      "MaxProperties": null,
      "MinProperties": null,
      "AdditionalPropertiesAllowed": true,
      "AdditionalProperties": null,
      "Discriminator": null,
      "Example": null,
      "Enum": [],
      "Nullable": false,
      "ExternalDocs": null,
      "Deprecated": false,
      "Xml": null,
      "Extensions": {},
      "UnresolvedReference": false,
      "Reference": null
    },
    "combined": {
      "Title": null,
      "Type": "string",
      "Format": null,
      "Description": null,
      "Maximum": null,
      "ExclusiveMaximum": null,
      "Minimum": null,
      "ExclusiveMinimum": null,
      "MaxLength": null,
      "MinLength": null,
      "Pattern": null,
      "MultipleOf": null,
      "Default": null,
      "ReadOnly": false,
      "WriteOnly": false,
      "AllOf": [],
      "OneOf": [],
      "AnyOf": [],
      "Not": null,
      "Required": [],
      "Items": null,
      "MaxItems": null,
      "MinItems": null,
      "UniqueItems": null,
      "Properties": {},
      "MaxProperties": null,
      "MinProperties": null,
      "AdditionalPropertiesAllowed": true,
      "AdditionalProperties": null,
      "Discriminator": null,
      "Example": {
        "PrimitiveType": 4,
        "AnyType": 0,
        "Value": "PASS"
      },
      "Enum": [
        {
          "PrimitiveType": 4,
          "AnyType": 0,
          "Value": "REFER"
        },
        {
          "PrimitiveType": 4,
          "AnyType": 0,
          "Value": "PASS"
        },
        {
          "PrimitiveType": 4,
          "AnyType": 0,
          "Value": "UNDETERMINED"
        }
      ],
      "Nullable": false,
      "ExternalDocs": null,
      "Deprecated": false,
      "Xml": null,
      "Extensions": {},
      "UnresolvedReference": false,
      "Reference": null
    }
  },
  "action": {
    "PrimitiveType": 4,
    "AnyType": 0,
    "Value": "Upload next document"
  }
})

BadRequest

Response Body
  • {
    • CorrelationId string

      Unique id for this error. Enquiries to GBG should reference this.

      example: 7ab2ff08-728a-42e6-aa38-df191ffd4817
    • Errors [
      • Error {
        • Location string example: Authorization
        • Code integer example: 1106
        • Problem string example: The token is invalid
        • Action string example: Please pass a valid token for access
        }
      ]
    }
{
  "CorrelationId": {
    "PrimitiveType": 4,
    "AnyType": 0,
    "Value": "7ab2ff08-728a-42e6-aa38-df191ffd4817"
  },
  "Errors": {
    "Title": null,
    "Type": "object",
    "Format": null,
    "Description": null,
    "Maximum": null,
    "ExclusiveMaximum": null,
    "Minimum": null,
    "ExclusiveMinimum": null,
    "MaxLength": null,
    "MinLength": null,
    "Pattern": null,
    "MultipleOf": null,
    "Default": null,
    "ReadOnly": false,
    "WriteOnly": false,
    "AllOf": [],
    "OneOf": [],
    "AnyOf": [],
    "Not": null,
    "Required": [],
    "Items": null,
    "MaxItems": null,
    "MinItems": null,
    "UniqueItems": null,
    "Properties": {
      "Location": {
        "Title": null,
        "Type": "string",
        "Format": null,
        "Description": null,
        "Maximum": null,
        "ExclusiveMaximum": null,
        "Minimum": null,
        "ExclusiveMinimum": null,
        "MaxLength": null,
        "MinLength": null,
        "Pattern": null,
        "MultipleOf": null,
        "Default": null,
        "ReadOnly": false,
        "WriteOnly": false,
        "AllOf": [],
        "OneOf": [],
        "AnyOf": [],
        "Not": null,
        "Required": [],
        "Items": null,
        "MaxItems": null,
        "MinItems": null,
        "UniqueItems": null,
        "Properties": {},
        "MaxProperties": null,
        "MinProperties": null,
        "AdditionalPropertiesAllowed": true,
        "AdditionalProperties": null,
        "Discriminator": null,
        "Example": {
          "PrimitiveType": 4,
          "AnyType": 0,
          "Value": "Authorization"
        },
        "Enum": [],
        "Nullable": false,
        "ExternalDocs": null,
        "Deprecated": false,
        "Xml": null,
        "Extensions": {},
        "UnresolvedReference": false,
        "Reference": null
      },
      "Code": {
        "Title": null,
        "Type": "integer",
        "Format": null,
        "Description": null,
        "Maximum": null,
        "ExclusiveMaximum": null,
        "Minimum": null,
        "ExclusiveMinimum": null,
        "MaxLength": null,
        "MinLength": null,
        "Pattern": null,
        "MultipleOf": null,
        "Default": null,
        "ReadOnly": false,
        "WriteOnly": false,
        "AllOf": [],
        "OneOf": [],
        "AnyOf": [],
        "Not": null,
        "Required": [],
        "Items": null,
        "MaxItems": null,
        "MinItems": null,
        "UniqueItems": null,
        "Properties": {},
        "MaxProperties": null,
        "MinProperties": null,
        "AdditionalPropertiesAllowed": true,
        "AdditionalProperties": null,
        "Discriminator": null,
        "Example": {
          "PrimitiveType": 0,
          "AnyType": 0,
          "Value": 1106
        },
        "Enum": [],
        "Nullable": false,
        "ExternalDocs": null,
        "Deprecated": false,
        "Xml": null,
        "Extensions": {},
        "UnresolvedReference": false,
        "Reference": null
      },
      "Problem": {
        "Title": null,
        "Type": "string",
        "Format": null,
        "Description": null,
        "Maximum": null,
        "ExclusiveMaximum": null,
        "Minimum": null,
        "ExclusiveMinimum": null,
        "MaxLength": null,
        "MinLength": null,
        "Pattern": null,
        "MultipleOf": null,
        "Default": null,
        "ReadOnly": false,
        "WriteOnly": false,
        "AllOf": [],
        "OneOf": [],
        "AnyOf": [],
        "Not": null,
        "Required": [],
        "Items": null,
        "MaxItems": null,
        "MinItems": null,
        "UniqueItems": null,
        "Properties": {},
        "MaxProperties": null,
        "MinProperties": null,
        "AdditionalPropertiesAllowed": true,
        "AdditionalProperties": null,
        "Discriminator": null,
        "Example": {
          "PrimitiveType": 4,
          "AnyType": 0,
          "Value": "The token is invalid"
        },
        "Enum": [],
        "Nullable": false,
        "ExternalDocs": null,
        "Deprecated": false,
        "Xml": null,
        "Extensions": {},
        "UnresolvedReference": false,
        "Reference": null
      },
      "Action": {
        "Title": null,
        "Type": "string",
        "Format": null,
        "Description": null,
        "Maximum": null,
        "ExclusiveMaximum": null,
        "Minimum": null,
        "ExclusiveMinimum": null,
        "MaxLength": null,
        "MinLength": null,
        "Pattern": null,
        "MultipleOf": null,
        "Default": null,
        "ReadOnly": false,
        "WriteOnly": false,
        "AllOf": [],
        "OneOf": [],
        "AnyOf": [],
        "Not": null,
        "Required": [],
        "Items": null,
        "MaxItems": null,
        "MinItems": null,
        "UniqueItems": null,
        "Properties": {},
        "MaxProperties": null,
        "MinProperties": null,
        "AdditionalPropertiesAllowed": true,
        "AdditionalProperties": null,
        "Discriminator": null,
        "Example": {
          "PrimitiveType": 4,
          "AnyType": 0,
          "Value": "Please pass a valid token for access"
        },
        "Enum": [],
        "Nullable": false,
        "ExternalDocs": null,
        "Deprecated": false,
        "Xml": null,
        "Extensions": {},
        "UnresolvedReference": false,
        "Reference": null
      }
    },
    "MaxProperties": null,
    "MinProperties": null,
    "AdditionalPropertiesAllowed": true,
    "AdditionalProperties": null,
    "Discriminator": null,
    "Example": null,
    "Enum": [],
    "Nullable": false,
    "ExternalDocs": null,
    "Deprecated": false,
    "Xml": null,
    "Extensions": {},
    "UnresolvedReference": false,
    "Reference": null
  }
})

Unauthorized

Response Body
  • {
    • CorrelationId string

      Unique id for this error. Enquiries to GBG should reference this.

      example: 7ab2ff08-728a-42e6-aa38-df191ffd4817
    • Errors [
      • Error {
        • Location string example: Authorization
        • Code integer example: 1106
        • Problem string example: The token is invalid
        • Action string example: Please pass a valid token for access
        }
      ]
    }
{
  "CorrelationId": {
    "PrimitiveType": 4,
    "AnyType": 0,
    "Value": "7ab2ff08-728a-42e6-aa38-df191ffd4817"
  },
  "Errors": {
    "Title": null,
    "Type": "object",
    "Format": null,
    "Description": null,
    "Maximum": null,
    "ExclusiveMaximum": null,
    "Minimum": null,
    "ExclusiveMinimum": null,
    "MaxLength": null,
    "MinLength": null,
    "Pattern": null,
    "MultipleOf": null,
    "Default": null,
    "ReadOnly": false,
    "WriteOnly": false,
    "AllOf": [],
    "OneOf": [],
    "AnyOf": [],
    "Not": null,
    "Required": [],
    "Items": null,
    "MaxItems": null,
    "MinItems": null,
    "UniqueItems": null,
    "Properties": {
      "Location": {
        "Title": null,
        "Type": "string",
        "Format": null,
        "Description": null,
        "Maximum": null,
        "ExclusiveMaximum": null,
        "Minimum": null,
        "ExclusiveMinimum": null,
        "MaxLength": null,
        "MinLength": null,
        "Pattern": null,
        "MultipleOf": null,
        "Default": null,
        "ReadOnly": false,
        "WriteOnly": false,
        "AllOf": [],
        "OneOf": [],
        "AnyOf": [],
        "Not": null,
        "Required": [],
        "Items": null,
        "MaxItems": null,
        "MinItems": null,
        "UniqueItems": null,
        "Properties": {},
        "MaxProperties": null,
        "MinProperties": null,
        "AdditionalPropertiesAllowed": true,
        "AdditionalProperties": null,
        "Discriminator": null,
        "Example": {
          "PrimitiveType": 4,
          "AnyType": 0,
          "Value": "Authorization"
        },
        "Enum": [],
        "Nullable": false,
        "ExternalDocs": null,
        "Deprecated": false,
        "Xml": null,
        "Extensions": {},
        "UnresolvedReference": false,
        "Reference": null
      },
      "Code": {
        "Title": null,
        "Type": "integer",
        "Format": null,
        "Description": null,
        "Maximum": null,
        "ExclusiveMaximum": null,
        "Minimum": null,
        "ExclusiveMinimum": null,
        "MaxLength": null,
        "MinLength": null,
        "Pattern": null,
        "MultipleOf": null,
        "Default": null,
        "ReadOnly": false,
        "WriteOnly": false,
        "AllOf": [],
        "OneOf": [],
        "AnyOf": [],
        "Not": null,
        "Required": [],
        "Items": null,
        "MaxItems": null,
        "MinItems": null,
        "UniqueItems": null,
        "Properties": {},
        "MaxProperties": null,
        "MinProperties": null,
        "AdditionalPropertiesAllowed": true,
        "AdditionalProperties": null,
        "Discriminator": null,
        "Example": {
          "PrimitiveType": 0,
          "AnyType": 0,
          "Value": 1106
        },
        "Enum": [],
        "Nullable": false,
        "ExternalDocs": null,
        "Deprecated": false,
        "Xml": null,
        "Extensions": {},
        "UnresolvedReference": false,
        "Reference": null
      },
      "Problem": {
        "Title": null,
        "Type": "string",
        "Format": null,
        "Description": null,
        "Maximum": null,
        "ExclusiveMaximum": null,
        "Minimum": null,
        "ExclusiveMinimum": null,
        "MaxLength": null,
        "MinLength": null,
        "Pattern": null,
        "MultipleOf": null,
        "Default": null,
        "ReadOnly": false,
        "WriteOnly": false,
        "AllOf": [],
        "OneOf": [],
        "AnyOf": [],
        "Not": null,
        "Required": [],
        "Items": null,
        "MaxItems": null,
        "MinItems": null,
        "UniqueItems": null,
        "Properties": {},
        "MaxProperties": null,
        "MinProperties": null,
        "AdditionalPropertiesAllowed": true,
        "AdditionalProperties": null,
        "Discriminator": null,
        "Example": {
          "PrimitiveType": 4,
          "AnyType": 0,
          "Value": "The token is invalid"
        },
        "Enum": [],
        "Nullable": false,
        "ExternalDocs": null,
        "Deprecated": false,
        "Xml": null,
        "Extensions": {},
        "UnresolvedReference": false,
        "Reference": null
      },
      "Action": {
        "Title": null,
        "Type": "string",
        "Format": null,
        "Description": null,
        "Maximum": null,
        "ExclusiveMaximum": null,
        "Minimum": null,
        "ExclusiveMinimum": null,
        "MaxLength": null,
        "MinLength": null,
        "Pattern": null,
        "MultipleOf": null,
        "Default": null,
        "ReadOnly": false,
        "WriteOnly": false,
        "AllOf": [],
        "OneOf": [],
        "AnyOf": [],
        "Not": null,
        "Required": [],
        "Items": null,
        "MaxItems": null,
        "MinItems": null,
        "UniqueItems": null,
        "Properties": {},
        "MaxProperties": null,
        "MinProperties": null,
        "AdditionalPropertiesAllowed": true,
        "AdditionalProperties": null,
        "Discriminator": null,
        "Example": {
          "PrimitiveType": 4,
          "AnyType": 0,
          "Value": "Please pass a valid token for access"
        },
        "Enum": [],
        "Nullable": false,
        "ExternalDocs": null,
        "Deprecated": false,
        "Xml": null,
        "Extensions": {},
        "UnresolvedReference": false,
        "Reference": null
      }
    },
    "MaxProperties": null,
    "MinProperties": null,
    "AdditionalPropertiesAllowed": true,
    "AdditionalProperties": null,
    "Discriminator": null,
    "Example": null,
    "Enum": [],
    "Nullable": false,
    "ExternalDocs": null,
    "Deprecated": false,
    "Xml": null,
    "Extensions": {},
    "UnresolvedReference": false,
    "Reference": null
  }
})

Forbidden

Response Body
  • {
    • CorrelationId string

      Unique id for this error. Enquiries to GBG should reference this.

      example: 7ab2ff08-728a-42e6-aa38-df191ffd4817
    • Errors [
      • Error {
        • Location string example: Authorization
        • Code integer example: 1106
        • Problem string example: The token is invalid
        • Action string example: Please pass a valid token for access
        }
      ]
    }
{
  "CorrelationId": {
    "PrimitiveType": 4,
    "AnyType": 0,
    "Value": "7ab2ff08-728a-42e6-aa38-df191ffd4817"
  },
  "Errors": {
    "Title": null,
    "Type": "object",
    "Format": null,
    "Description": null,
    "Maximum": null,
    "ExclusiveMaximum": null,
    "Minimum": null,
    "ExclusiveMinimum": null,
    "MaxLength": null,
    "MinLength": null,
    "Pattern": null,
    "MultipleOf": null,
    "Default": null,
    "ReadOnly": false,
    "WriteOnly": false,
    "AllOf": [],
    "OneOf": [],
    "AnyOf": [],
    "Not": null,
    "Required": [],
    "Items": null,
    "MaxItems": null,
    "MinItems": null,
    "UniqueItems": null,
    "Properties": {
      "Location": {
        "Title": null,
        "Type": "string",
        "Format": null,
        "Description": null,
        "Maximum": null,
        "ExclusiveMaximum": null,
        "Minimum": null,
        "ExclusiveMinimum": null,
        "MaxLength": null,
        "MinLength": null,
        "Pattern": null,
        "MultipleOf": null,
        "Default": null,
        "ReadOnly": false,
        "WriteOnly": false,
        "AllOf": [],
        "OneOf": [],
        "AnyOf": [],
        "Not": null,
        "Required": [],
        "Items": null,
        "MaxItems": null,
        "MinItems": null,
        "UniqueItems": null,
        "Properties": {},
        "MaxProperties": null,
        "MinProperties": null,
        "AdditionalPropertiesAllowed": true,
        "AdditionalProperties": null,
        "Discriminator": null,
        "Example": {
          "PrimitiveType": 4,
          "AnyType": 0,
          "Value": "Authorization"
        },
        "Enum": [],
        "Nullable": false,
        "ExternalDocs": null,
        "Deprecated": false,
        "Xml": null,
        "Extensions": {},
        "UnresolvedReference": false,
        "Reference": null
      },
      "Code": {
        "Title": null,
        "Type": "integer",
        "Format": null,
        "Description": null,
        "Maximum": null,
        "ExclusiveMaximum": null,
        "Minimum": null,
        "ExclusiveMinimum": null,
        "MaxLength": null,
        "MinLength": null,
        "Pattern": null,
        "MultipleOf": null,
        "Default": null,
        "ReadOnly": false,
        "WriteOnly": false,
        "AllOf": [],
        "OneOf": [],
        "AnyOf": [],
        "Not": null,
        "Required": [],
        "Items": null,
        "MaxItems": null,
        "MinItems": null,
        "UniqueItems": null,
        "Properties": {},
        "MaxProperties": null,
        "MinProperties": null,
        "AdditionalPropertiesAllowed": true,
        "AdditionalProperties": null,
        "Discriminator": null,
        "Example": {
          "PrimitiveType": 0,
          "AnyType": 0,
          "Value": 1106
        },
        "Enum": [],
        "Nullable": false,
        "ExternalDocs": null,
        "Deprecated": false,
        "Xml": null,
        "Extensions": {},
        "UnresolvedReference": false,
        "Reference": null
      },
      "Problem": {
        "Title": null,
        "Type": "string",
        "Format": null,
        "Description": null,
        "Maximum": null,
        "ExclusiveMaximum": null,
        "Minimum": null,
        "ExclusiveMinimum": null,
        "MaxLength": null,
        "MinLength": null,
        "Pattern": null,
        "MultipleOf": null,
        "Default": null,
        "ReadOnly": false,
        "WriteOnly": false,
        "AllOf": [],
        "OneOf": [],
        "AnyOf": [],
        "Not": null,
        "Required": [],
        "Items": null,
        "MaxItems": null,
        "MinItems": null,
        "UniqueItems": null,
        "Properties": {},
        "MaxProperties": null,
        "MinProperties": null,
        "AdditionalPropertiesAllowed": true,
        "AdditionalProperties": null,
        "Discriminator": null,
        "Example": {
          "PrimitiveType": 4,
          "AnyType": 0,
          "Value": "The token is invalid"
        },
        "Enum": [],
        "Nullable": false,
        "ExternalDocs": null,
        "Deprecated": false,
        "Xml": null,
        "Extensions": {},
        "UnresolvedReference": false,
        "Reference": null
      },
      "Action": {
        "Title": null,
        "Type": "string",
        "Format": null,
        "Description": null,
        "Maximum": null,
        "ExclusiveMaximum": null,
        "Minimum": null,
        "ExclusiveMinimum": null,
        "MaxLength": null,
        "MinLength": null,
        "Pattern": null,
        "MultipleOf": null,
        "Default": null,
        "ReadOnly": false,
        "WriteOnly": false,
        "AllOf": [],
        "OneOf": [],
        "AnyOf": [],
        "Not": null,
        "Required": [],
        "Items": null,
        "MaxItems": null,
        "MinItems": null,
        "UniqueItems": null,
        "Properties": {},
        "MaxProperties": null,
        "MinProperties": null,
        "AdditionalPropertiesAllowed": true,
        "AdditionalProperties": null,
        "Discriminator": null,
        "Example": {
          "PrimitiveType": 4,
          "AnyType": 0,
          "Value": "Please pass a valid token for access"
        },
        "Enum": [],
        "Nullable": false,
        "ExternalDocs": null,
        "Deprecated": false,
        "Xml": null,
        "Extensions": {},
        "UnresolvedReference": false,
        "Reference": null
      }
    },
    "MaxProperties": null,
    "MinProperties": null,
    "AdditionalPropertiesAllowed": true,
    "AdditionalProperties": null,
    "Discriminator": null,
    "Example": null,
    "Enum": [],
    "Nullable": false,
    "ExternalDocs": null,
    "Deprecated": false,
    "Xml": null,
    "Extensions": {},
    "UnresolvedReference": false,
    "Reference": null
  }
})

UnsupportedMediaType

Response Body
  • {
    • CorrelationId string

      Unique id for this error. Enquiries to GBG should reference this.

      example: 7ab2ff08-728a-42e6-aa38-df191ffd4817
    • Errors [
      • Error {
        • Location string example: Authorization
        • Code integer example: 1106
        • Problem string example: The token is invalid
        • Action string example: Please pass a valid token for access
        }
      ]
    }
{
  "CorrelationId": {
    "PrimitiveType": 4,
    "AnyType": 0,
    "Value": "7ab2ff08-728a-42e6-aa38-df191ffd4817"
  },
  "Errors": {
    "Title": null,
    "Type": "object",
    "Format": null,
    "Description": null,
    "Maximum": null,
    "ExclusiveMaximum": null,
    "Minimum": null,
    "ExclusiveMinimum": null,
    "MaxLength": null,
    "MinLength": null,
    "Pattern": null,
    "MultipleOf": null,
    "Default": null,
    "ReadOnly": false,
    "WriteOnly": false,
    "AllOf": [],
    "OneOf": [],
    "AnyOf": [],
    "Not": null,
    "Required": [],
    "Items": null,
    "MaxItems": null,
    "MinItems": null,
    "UniqueItems": null,
    "Properties": {
      "Location": {
        "Title": null,
        "Type": "string",
        "Format": null,
        "Description": null,
        "Maximum": null,
        "ExclusiveMaximum": null,
        "Minimum": null,
        "ExclusiveMinimum": null,
        "MaxLength": null,
        "MinLength": null,
        "Pattern": null,
        "MultipleOf": null,
        "Default": null,
        "ReadOnly": false,
        "WriteOnly": false,
        "AllOf": [],
        "OneOf": [],
        "AnyOf": [],
        "Not": null,
        "Required": [],
        "Items": null,
        "MaxItems": null,
        "MinItems": null,
        "UniqueItems": null,
        "Properties": {},
        "MaxProperties": null,
        "MinProperties": null,
        "AdditionalPropertiesAllowed": true,
        "AdditionalProperties": null,
        "Discriminator": null,
        "Example": {
          "PrimitiveType": 4,
          "AnyType": 0,
          "Value": "Authorization"
        },
        "Enum": [],
        "Nullable": false,
        "ExternalDocs": null,
        "Deprecated": false,
        "Xml": null,
        "Extensions": {},
        "UnresolvedReference": false,
        "Reference": null
      },
      "Code": {
        "Title": null,
        "Type": "integer",
        "Format": null,
        "Description": null,
        "Maximum": null,
        "ExclusiveMaximum": null,
        "Minimum": null,
        "ExclusiveMinimum": null,
        "MaxLength": null,
        "MinLength": null,
        "Pattern": null,
        "MultipleOf": null,
        "Default": null,
        "ReadOnly": false,
        "WriteOnly": false,
        "AllOf": [],
        "OneOf": [],
        "AnyOf": [],
        "Not": null,
        "Required": [],
        "Items": null,
        "MaxItems": null,
        "MinItems": null,
        "UniqueItems": null,
        "Properties": {},
        "MaxProperties": null,
        "MinProperties": null,
        "AdditionalPropertiesAllowed": true,
        "AdditionalProperties": null,
        "Discriminator": null,
        "Example": {
          "PrimitiveType": 0,
          "AnyType": 0,
          "Value": 1106
        },
        "Enum": [],
        "Nullable": false,
        "ExternalDocs": null,
        "Deprecated": false,
        "Xml": null,
        "Extensions": {},
        "UnresolvedReference": false,
        "Reference": null
      },
      "Problem": {
        "Title": null,
        "Type": "string",
        "Format": null,
        "Description": null,
        "Maximum": null,
        "ExclusiveMaximum": null,
        "Minimum": null,
        "ExclusiveMinimum": null,
        "MaxLength": null,
        "MinLength": null,
        "Pattern": null,
        "MultipleOf": null,
        "Default": null,
        "ReadOnly": false,
        "WriteOnly": false,
        "AllOf": [],
        "OneOf": [],
        "AnyOf": [],
        "Not": null,
        "Required": [],
        "Items": null,
        "MaxItems": null,
        "MinItems": null,
        "UniqueItems": null,
        "Properties": {},
        "MaxProperties": null,
        "MinProperties": null,
        "AdditionalPropertiesAllowed": true,
        "AdditionalProperties": null,
        "Discriminator": null,
        "Example": {
          "PrimitiveType": 4,
          "AnyType": 0,
          "Value": "The token is invalid"
        },
        "Enum": [],
        "Nullable": false,
        "ExternalDocs": null,
        "Deprecated": false,
        "Xml": null,
        "Extensions": {},
        "UnresolvedReference": false,
        "Reference": null
      },
      "Action": {
        "Title": null,
        "Type": "string",
        "Format": null,
        "Description": null,
        "Maximum": null,
        "ExclusiveMaximum": null,
        "Minimum": null,
        "ExclusiveMinimum": null,
        "MaxLength": null,
        "MinLength": null,
        "Pattern": null,
        "MultipleOf": null,
        "Default": null,
        "ReadOnly": false,
        "WriteOnly": false,
        "AllOf": [],
        "OneOf": [],
        "AnyOf": [],
        "Not": null,
        "Required": [],
        "Items": null,
        "MaxItems": null,
        "MinItems": null,
        "UniqueItems": null,
        "Properties": {},
        "MaxProperties": null,
        "MinProperties": null,
        "AdditionalPropertiesAllowed": true,
        "AdditionalProperties": null,
        "Discriminator": null,
        "Example": {
          "PrimitiveType": 4,
          "AnyType": 0,
          "Value": "Please pass a valid token for access"
        },
        "Enum": [],
        "Nullable": false,
        "ExternalDocs": null,
        "Deprecated": false,
        "Xml": null,
        "Extensions": {},
        "UnresolvedReference": false,
        "Reference": null
      }
    },
    "MaxProperties": null,
    "MinProperties": null,
    "AdditionalPropertiesAllowed": true,
    "AdditionalProperties": null,
    "Discriminator": null,
    "Example": null,
    "Enum": [],
    "Nullable": false,
    "ExternalDocs": null,
    "Deprecated": false,
    "Xml": null,
    "Extensions": {},
    "UnresolvedReference": false,
    "Reference": null
  }
})

Internal Server Error

Response Body
  • {
    • CorrelationId string

      Unique id for this error. Enquiries to GBG should reference this.

      example: 7ab2ff08-728a-42e6-aa38-df191ffd4817
    • Errors [
      • Error {
        • Location string example: Authorization
        • Code integer example: 1106
        • Problem string example: The token is invalid
        • Action string example: Please pass a valid token for access
        }
      ]
    }
{
  "CorrelationId": {
    "PrimitiveType": 4,
    "AnyType": 0,
    "Value": "7ab2ff08-728a-42e6-aa38-df191ffd4817"
  },
  "Errors": {
    "Title": null,
    "Type": "object",
    "Format": null,
    "Description": null,
    "Maximum": null,
    "ExclusiveMaximum": null,
    "Minimum": null,
    "ExclusiveMinimum": null,
    "MaxLength": null,
    "MinLength": null,
    "Pattern": null,
    "MultipleOf": null,
    "Default": null,
    "ReadOnly": false,
    "WriteOnly": false,
    "AllOf": [],
    "OneOf": [],
    "AnyOf": [],
    "Not": null,
    "Required": [],
    "Items": null,
    "MaxItems": null,
    "MinItems": null,
    "UniqueItems": null,
    "Properties": {
      "Location": {
        "Title": null,
        "Type": "string",
        "Format": null,
        "Description": null,
        "Maximum": null,
        "ExclusiveMaximum": null,
        "Minimum": null,
        "ExclusiveMinimum": null,
        "MaxLength": null,
        "MinLength": null,
        "Pattern": null,
        "MultipleOf": null,
        "Default": null,
        "ReadOnly": false,
        "WriteOnly": false,
        "AllOf": [],
        "OneOf": [],
        "AnyOf": [],
        "Not": null,
        "Required": [],
        "Items": null,
        "MaxItems": null,
        "MinItems": null,
        "UniqueItems": null,
        "Properties": {},
        "MaxProperties": null,
        "MinProperties": null,
        "AdditionalPropertiesAllowed": true,
        "AdditionalProperties": null,
        "Discriminator": null,
        "Example": {
          "PrimitiveType": 4,
          "AnyType": 0,
          "Value": "Authorization"
        },
        "Enum": [],
        "Nullable": false,
        "ExternalDocs": null,
        "Deprecated": false,
        "Xml": null,
        "Extensions": {},
        "UnresolvedReference": false,
        "Reference": null
      },
      "Code": {
        "Title": null,
        "Type": "integer",
        "Format": null,
        "Description": null,
        "Maximum": null,
        "ExclusiveMaximum": null,
        "Minimum": null,
        "ExclusiveMinimum": null,
        "MaxLength": null,
        "MinLength": null,
        "Pattern": null,
        "MultipleOf": null,
        "Default": null,
        "ReadOnly": false,
        "WriteOnly": false,
        "AllOf": [],
        "OneOf": [],
        "AnyOf": [],
        "Not": null,
        "Required": [],
        "Items": null,
        "MaxItems": null,
        "MinItems": null,
        "UniqueItems": null,
        "Properties": {},
        "MaxProperties": null,
        "MinProperties": null,
        "AdditionalPropertiesAllowed": true,
        "AdditionalProperties": null,
        "Discriminator": null,
        "Example": {
          "PrimitiveType": 0,
          "AnyType": 0,
          "Value": 1106
        },
        "Enum": [],
        "Nullable": false,
        "ExternalDocs": null,
        "Deprecated": false,
        "Xml": null,
        "Extensions": {},
        "UnresolvedReference": false,
        "Reference": null
      },
      "Problem": {
        "Title": null,
        "Type": "string",
        "Format": null,
        "Description": null,
        "Maximum": null,
        "ExclusiveMaximum": null,
        "Minimum": null,
        "ExclusiveMinimum": null,
        "MaxLength": null,
        "MinLength": null,
        "Pattern": null,
        "MultipleOf": null,
        "Default": null,
        "ReadOnly": false,
        "WriteOnly": false,
        "AllOf": [],
        "OneOf": [],
        "AnyOf": [],
        "Not": null,
        "Required": [],
        "Items": null,
        "MaxItems": null,
        "MinItems": null,
        "UniqueItems": null,
        "Properties": {},
        "MaxProperties": null,
        "MinProperties": null,
        "AdditionalPropertiesAllowed": true,
        "AdditionalProperties": null,
        "Discriminator": null,
        "Example": {
          "PrimitiveType": 4,
          "AnyType": 0,
          "Value": "The token is invalid"
        },
        "Enum": [],
        "Nullable": false,
        "ExternalDocs": null,
        "Deprecated": false,
        "Xml": null,
        "Extensions": {},
        "UnresolvedReference": false,
        "Reference": null
      },
      "Action": {
        "Title": null,
        "Type": "string",
        "Format": null,
        "Description": null,
        "Maximum": null,
        "ExclusiveMaximum": null,
        "Minimum": null,
        "ExclusiveMinimum": null,
        "MaxLength": null,
        "MinLength": null,
        "Pattern": null,
        "MultipleOf": null,
        "Default": null,
        "ReadOnly": false,
        "WriteOnly": false,
        "AllOf": [],
        "OneOf": [],
        "AnyOf": [],
        "Not": null,
        "Required": [],
        "Items": null,
        "MaxItems": null,
        "MinItems": null,
        "UniqueItems": null,
        "Properties": {},
        "MaxProperties": null,
        "MinProperties": null,
        "AdditionalPropertiesAllowed": true,
        "AdditionalProperties": null,
        "Discriminator": null,
        "Example": {
          "PrimitiveType": 4,
          "AnyType": 0,
          "Value": "Please pass a valid token for access"
        },
        "Enum": [],
        "Nullable": false,
        "ExternalDocs": null,
        "Deprecated": false,
        "Xml": null,
        "Extensions": {},
        "UnresolvedReference": false,
        "Reference": null
      }
    },
    "MaxProperties": null,
    "MinProperties": null,
    "AdditionalPropertiesAllowed": true,
    "AdditionalProperties": null,
    "Discriminator": null,
    "Example": null,
    "Enum": [],
    "Nullable": false,
    "ExternalDocs": null,
    "Deprecated": false,
    "Xml": null,
    "Extensions": {},
    "UnresolvedReference": false,
    "Reference": null
  }
})
  • cURL
  • JavaScript
  • C#
  • PHP
  • Java (Spring)
curl -X POST \
 - H 'Authorization: Bearer {Authorization}' \
 - H 'cleanse-address: true' \
 - H 'journey-id: 9d75d85e-f7bc-4d22-a93b-60c04881193d' \
 - H 'journey-version: 1' \
 - H 'customer-reference: 9d75d86e-f7bc-4d22-a93b-59c04881193f' \
 - H 'Content-Type: application/json' \
"https://api.gbgplc.com/verify/people/v4/person/documentData/"
var data = '';
var xhr = new XMLHttpRequest();
xhr.addEventListener('readystatechange', function () {
    if (this.readyState === this.DONE) {
        console.log(this.responseText);
    }
});
xhr.open('Post', 'https://api.gbgplc.com/verify/people/v4/person/documentData/');
xhr.setRequestHeader('Authorization', 'Bearer {Authorization}');
xhr.setRequestHeader('cleanse-address', 'true');
xhr.setRequestHeader('journey-id', '9d75d85e-f7bc-4d22-a93b-60c04881193d');
xhr.setRequestHeader('journey-version', '1');
xhr.setRequestHeader('customer-reference', '9d75d86e-f7bc-4d22-a93b-59c04881193f');
xhr.setRequestHeader('Content-Type', 'application/json');
xhr.send(data);
var client = new HttpClient();
var message = new HttpRequestMessage(HttpMethod.Post, "https://api.gbgplc.com/verify/people/v4/person/documentData/");
message.Headers.Add("Authorization", "Bearer {Authorization}");
message.Headers.Add("cleanse-address", "true");
message.Headers.Add("journey-id", "9d75d85e-f7bc-4d22-a93b-60c04881193d");
message.Headers.Add("journey-version", "1");
message.Headers.Add("customer-reference", "9d75d86e-f7bc-4d22-a93b-59c04881193f");
var response = await client.SendAsync(message);
var responseString = await response.Content.ReadAsStringAsync();
Console.WriteLine(responseString);
$url = 'https://api.gbgplc.com/verify/people/v4/person/documentData/';
$ch = curl_init($url);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, false);
$data = '';
curl_setopt($ch, CURLOPT_POSTFIELDS, $data);
curl_setopt($ch, CURLOPT_HTTPHEADER, array(     
    'Authorization: Bearer {Authorization}',
    'cleanse-address: true',
    'journey-id: 9d75d85e-f7bc-4d22-a93b-60c04881193d',
    'journey-version: 1',
    'customer-reference: 9d75d86e-f7bc-4d22-a93b-59c04881193f',
    'content-type: application/json')
);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$response = curl_exec($ch);
if (curl_errno($ch)) {
    echo 'Error:' . curl_error($ch);
}
$json = json_decode($response, true);
curl_close($ch);
print_r($json);
HttpHeaders headers = new HttpHeaders();
headers.set("Authorization", "Bearer {Authorization}");
headers.set("cleanse-address", "true");
headers.set("journey-id", "9d75d85e-f7bc-4d22-a93b-60c04881193d");
headers.set("journey-version", "1");
headers.set("customer-reference", "9d75d86e-f7bc-4d22-a93b-59c04881193f");
HttpEntity<MultiValueMap<String, String>> request = new HttpEntity<>("", headers);
String host = "https://api.gbgplc.com/verify/people/v4/person/documentData/";
//restTemplate should be autowired via constructor of this class
ResponseEntity<String> response = restTemplate.postForEntity(host, request, String.class);
if (200 == response.getStatusCodeValue()){
    //DO STUFF
}

Remember! Each of the marked variables should be replaced with your credentials or your chosen options.