GBG Developers

sdfsdfsdf

some text

.red { fill: #b0013a; }

Retrieve image by id

Get /verify/people/v4/{person-id}/images/{image-id}

Allows the calling system to retrieve any of the individual images created during verify document processing. The image-id will have been returned from an earlier POST call.

Mandatory fields are highlighted
Path Parameters
Name Type Description
person-id string

Use to identify the verification made against a person

Example: 9d75d85e-f7bc-4d22-a93b-60c04881193d
image-id string

Used to identify the image. This will be an id returned from a previous POST call to /document or by document-id

Example: 9d75d86e-f7bc-4d22-a93b-59c04881193f
Header Parameters
Name Type Description
Authorization string

A JWT token to allow access

Response

The image identified from the incoming image-id

Response Body
  • string
{})

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
  }
})

NotFound document id

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 GET \
 - H 'Authorization: Bearer {Authorization}' \
 - H 'Content-Type: application/json' \
"https://api.gbgplc.com/verify/people/v4/{person-id}/images/{image-id}"
var data = '';
var xhr = new XMLHttpRequest();
xhr.addEventListener('readystatechange', function () {
    if (this.readyState === this.DONE) {
        console.log(this.responseText);
    }
});
xhr.open('Get', 'https://api.gbgplc.com/verify/people/v4/{person-id}/images/{image-id}');
xhr.setRequestHeader('Authorization', 'Bearer {Authorization}');
xhr.setRequestHeader('Content-Type', 'application/json');
xhr.send(data);
var client = new HttpClient();
var message = new HttpRequestMessage(HttpMethod.Get, "https://api.gbgplc.com/verify/people/v4/{person-id}/images/{image-id}");
message.Headers.Add("Authorization", "Bearer {Authorization}");
var response = await client.SendAsync(message);
var responseString = await response.Content.ReadAsStringAsync();
Console.WriteLine(responseString);
$url = 'https://api.gbgplc.com/verify/people/v4/{person-id}/images/{image-id}';
$ch = curl_init($url);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "GET");
curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, false);
curl_setopt($ch, CURLOPT_HTTPHEADER, array(     
    'Authorization: Bearer {Authorization}',
    '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}");
String host = "https://api.gbgplc.com/verify/people/v4/{person-id}/images/{image-id}";
//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.