GBG | Developers

AuthenticationService

Calls for using GBG Authorisation services in conjunction with your SSO service.

Authorisation Tokens

Post /authenticate/v1/connect/token

This service will accept the authorisation code from your SSO provider and exchange it for a GBG access token

  • cURL
  • JavaScript
  • C#
  • PHP
  • Java (Spring)
curl -X POST \
 - H 'Content-Type: application/x-www-form-urlencoded' \
    -d 'client_id=ro.client' \
    -d 'grant_type=id_auth' \
    -d 'client_secret=secret' \
    -d 'scope=api api2' \
    -d 'id_token=eyJpc3MiOiJ0b3B0YWwuY29tIiwiZXhwIjoxNDI2NDIwODAwLCJodHRwOi8vdG9wdGFsLmNvbS9qd3RfY2xhaW1zL2lzX2FkbWluIjp0cnVlLCJjb21wYW55IjoiVG9wdGFsIiwiYXdlc29tZSI6dHJ1ZX0' \
"https://api.gbgplc.com/authenticate/v1/connect/token"
var data = ""
data += "client_id=" + encodeURIComponent("ro.client");
data += "&grant_type=" + encodeURIComponent("id_auth");
data += "&client_secret=" + encodeURIComponent("secret");
data += "&scope=" + encodeURIComponent("api api2");
data += "&id_token=" + encodeURIComponent("eyJpc3MiOiJ0b3B0YWwuY29tIiwiZXhwIjoxNDI2NDIwODAwLCJodHRwOi8vdG9wdGFsLmNvbS9qd3RfY2xhaW1zL2lzX2FkbWluIjp0cnVlLCJjb21wYW55IjoiVG9wdGFsIiwiYXdlc29tZSI6dHJ1ZX0");
var xhr = new XMLHttpRequest();
xhr.addEventListener('readystatechange', function () {
    if (this.readyState === this.DONE) {
        console.log(this.responseText);
    }
});
xhr.open('Post', 'https://api.gbgplc.com/authenticate/v1/connect/token');
xhr.setRequestHeader('Content-Type', 'application/x-www-form-urlencoded');
xhr.send(data);
var client = new HttpClient();
var message = new HttpRequestMessage(HttpMethod.Post, "https://api.gbgplc.com/authenticate/v1/connect/token");
var formItems = new List<KeyValuePair<string, string>>();
formItems.Add(new KeyValuePair<string, string>("client_id", "ro.client"));
formItems.Add(new KeyValuePair<string, string>("grant_type", "id_auth"));
formItems.Add(new KeyValuePair<string, string>("client_secret", "secret"));
formItems.Add(new KeyValuePair<string, string>("scope", "api api2"));
formItems.Add(new KeyValuePair<string, string>("id_token", "eyJpc3MiOiJ0b3B0YWwuY29tIiwiZXhwIjoxNDI2NDIwODAwLCJodHRwOi8vdG9wdGFsLmNvbS9qd3RfY2xhaW1zL2lzX2FkbWluIjp0cnVlLCJjb21wYW55IjoiVG9wdGFsIiwiYXdlc29tZSI6dHJ1ZX0"));
var formContent = new FormUrlEncodedContent(formItems);
message.Content = formContent;
var response = await client.SendAsync(message);
var responseString = await response.Content.ReadAsStringAsync();
Console.WriteLine(responseString);
$url = 'https://api.gbgplc.com/authenticate/v1/connect/token';
$ch = curl_init($url);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, false);
$data = array(
    'client_id' => 'ro.client',
    'grant_type' => 'id_auth',
    'client_secret' => 'secret',
    'scope' => 'api api2',
    'id_token' => 'eyJpc3MiOiJ0b3B0YWwuY29tIiwiZXhwIjoxNDI2NDIwODAwLCJodHRwOi8vdG9wdGFsLmNvbS9qd3RfY2xhaW1zL2lzX2FkbWluIjp0cnVlLCJjb21wYW55IjoiVG9wdGFsIiwiYXdlc29tZSI6dHJ1ZX0'
);
curl_setopt($ch, CURLOPT_POSTFIELDS, $data);
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();
MultiValueMap<String, String> body = new LinkedMultiValueMap<String, String>();
body.add("client_id","ro.client");
body.add("grant_type","id_auth");
body.add("client_secret","secret");
body.add("scope","api api2");
body.add("id_token","eyJpc3MiOiJ0b3B0YWwuY29tIiwiZXhwIjoxNDI2NDIwODAwLCJodHRwOi8vdG9wdGFsLmNvbS9qd3RfY2xhaW1zL2lzX2FkbWluIjp0cnVlLCJjb21wYW55IjoiVG9wdGFsIiwiYXdlc29tZSI6dHJ1ZX0");
HttpEntity<MultiValueMap<String, String>> request = new HttpEntity<>(body, headers);
String host = "https://api.gbgplc.com/authenticate/v1/connect/token";
//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.

Request Body

  • client_id string

    Client identifier

    example: ro.client
  • grant_type string

    Use the custom grant type id_auth

    example: id_auth
  • client_secret string

    Client secret either in the post body, or as a basic authentication header

    example: secret
  • scope string

    One or more registered scopes as a space separated list. If not specified, a token for all explicitly allowed scopes will be issued.

    example: api api2
  • id_token string

    a JSON web token that has been obtained from an external authentication provider

    example: eyJpc3MiOiJ0b3B0YWwuY29tIiwiZXhwIjoxNDI2NDIwODAwLCJodHRwOi8vdG9wdGFsLmNvbS9qd3RfY2xhaW1zL2lzX2FkbWluIjp0cnVlLCJjb21wYW55IjoiVG9wdGFsIiwiYXdlc29tZSI6dHJ1ZX0
  • Response

    Success

    • {
      • access_token string
      • expires_in integer
      • token_type string
      }
    {
      "access_token": null,
      "expires_in": null,
      "token_type": null
    })

    Bad Request

    Server Error

    Verify People API

    Verifies a person's details using combinations of their name, date of birth, gender, address and phone number. This information can be supplied directly or extracted from a document image. For more detailed information see the guide.

    For more information on our ID3Global product and associated matters please see these links:
    ID3Global Support Centre
    ID3Global Product Information
    GBG
    GDPR

    Verify Person Details

    Post /verify/people/v4/person

    Submits a person's details to verify them against a preset list of checks. This call should be used where it is the first step in the verification process.

    • 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' \
        -d '{
      "title": "Mr",
      "firstName": "Dave",
      "middlenames": [
        "Dai"
      ],
      "lastnames": [
        "Jones"
      ],
      "gender": "MALE",
      "birthdate": "2000-01-01",
      "addresses": [
        {
          "type": "CURRENT",
          "address": {
            "premise": 18,
            "building": "The House",
            "thoroughfare": "The Street",
            "locality": "The Town",
            "postalCode": "CL7 9DF",
            "country": "UK"
          },
          "resident": {
            "from": "2011-11-11"
          }
        },
        {
          "type": "PREVIOUS",
          "address": {
            "lines": [
              "11 The other street",
              "New Town",
              "YF9 3FP"
            ]
          },
          "resident": {
            "from": "2010-01-01",
            "to": "2011-11-11"
          }
        }
      ],
      "phones": [
        {
          "type": "HOME",
          "number": "+44 781 761 8573"
        }
      ]
    }' \
    "https://api.gbgplc.com/verify/people/v4/person"
    
    var data = JSON.stringify({
      "title": "Mr",
      "firstName": "Dave",
      "middlenames": [
        "Dai"
      ],
      "lastnames": [
        "Jones"
      ],
      "gender": "MALE",
      "birthdate": "2000-01-01",
      "addresses": [
        {
          "type": "CURRENT",
          "address": {
            "premise": 18,
            "building": "The House",
            "thoroughfare": "The Street",
            "locality": "The Town",
            "postalCode": "CL7 9DF",
            "country": "UK"
          },
          "resident": {
            "from": "2011-11-11"
          }
        },
        {
          "type": "PREVIOUS",
          "address": {
            "lines": [
              "11 The other street",
              "New Town",
              "YF9 3FP"
            ]
          },
          "resident": {
            "from": "2010-01-01",
            "to": "2011-11-11"
          }
        }
      ],
      "phones": [
        {
          "type": "HOME",
          "number": "+44 781 761 8573"
        }
      ]
    });
    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');
    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");
    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");
    message.Content = new StringContent(@"{
      ""title"": ""Mr"",
      ""firstName"": ""Dave"",
      ""middlenames"": [
        ""Dai""
      ],
      ""lastnames"": [
        ""Jones""
      ],
      ""gender"": ""MALE"",
      ""birthdate"": ""2000-01-01"",
      ""addresses"": [
        {
          ""type"": ""CURRENT"",
          ""address"": {
            ""premise"": 18,
            ""building"": ""The House"",
            ""thoroughfare"": ""The Street"",
            ""locality"": ""The Town"",
            ""postalCode"": ""CL7 9DF"",
            ""country"": ""UK""
          },
          ""resident"": {
            ""from"": ""2011-11-11""
          }
        },
        {
          ""type"": ""PREVIOUS"",
          ""address"": {
            ""lines"": [
              ""11 The other street"",
              ""New Town"",
              ""YF9 3FP""
            ]
          },
          ""resident"": {
            ""from"": ""2010-01-01"",
            ""to"": ""2011-11-11""
          }
        }
      ],
      ""phones"": [
        {
          ""type"": ""HOME"",
          ""number"": ""+44 781 761 8573""
        }
      ]
    }", Encoding.UTF8, "application/json");
    var response = await client.SendAsync(message);
    var responseString = await response.Content.ReadAsStringAsync();
    Console.WriteLine(responseString);
    
    $url = 'https://api.gbgplc.com/verify/people/v4/person';
    $ch = curl_init($url);
    curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
    curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, false);
    $data = '{
      "title": "Mr",
      "firstName": "Dave",
      "middlenames": [
        "Dai"
      ],
      "lastnames": [
        "Jones"
      ],
      "gender": "MALE",
      "birthdate": "2000-01-01",
      "addresses": [
        {
          "type": "CURRENT",
          "address": {
            "premise": 18,
            "building": "The House",
            "thoroughfare": "The Street",
            "locality": "The Town",
            "postalCode": "CL7 9DF",
            "country": "UK"
          },
          "resident": {
            "from": "2011-11-11"
          }
        },
        {
          "type": "PREVIOUS",
          "address": {
            "lines": [
              "11 The other street",
              "New Town",
              "YF9 3FP"
            ]
          },
          "resident": {
            "from": "2010-01-01",
            "to": "2011-11-11"
          }
        }
      ],
      "phones": [
        {
          "type": "HOME",
          "number": "+44 781 761 8573"
        }
      ]
    }';
    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',
        'Content-Length: ' . strlen($data))
    );
    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");
    String body = "<JSON BODY>";
    HttpEntity<String> request = new HttpEntity<>(body, headers);
    String host = "https://api.gbgplc.com/verify/people/v4/person";
    //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.

    Header Parameters
    Name Description Example

    Authorization*

    Required

    A JWT token to allow access


    Type: string

    cleanse-address

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


    Type: boolean
    true

    journey-id*

    Required

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


    Type: string
    9d75d85e-f7bc-4d22-a93b-60c04881193d

    journey-version*

    Required

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


    Type: integer
    1

    customer-reference

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


    Type: string
    9d75d86e-f7bc-4d22-a93b-59c04881193f

    Request Body

    • Example
    • Schema
    • {
      • 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
      • addresses [
        • address {
          • type string

            specify if this is a current or previous address

            Enum: [CURRENT, PREVIOUS]
          • 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
              }
            }
          • resident {
            • from 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
            • to 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
            }
          • enrichments {
            • cleansed {
              • 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
                }
              }
            }
          }
        ]
      • phones [
        • phone {
          • type string

            Specifies the type of phone this is

            Enum: [HOME, WORK, MOBILE]
          • number string

            GBG Global Phone format used across the GBG product and services, Required in international format with +(Country Code)

            Pattern: ^(\+)(?:\d\s?){1,14}$ example: +44 207 4281250
          }
        ]
      }
    {
      "title": "Mr",
      "firstName": "Dave",
      "middlenames": [
        "Dai"
      ],
      "lastnames": [
        "Jones"
      ],
      "gender": "MALE",
      "birthdate": "2000-01-01",
      "addresses": [
        {
          "type": "CURRENT",
          "address": {
            "premise": 18,
            "building": "The House",
            "thoroughfare": "The Street",
            "locality": "The Town",
            "postalCode": "CL7 9DF",
            "country": "UK"
          },
          "resident": {
            "from": "2011-11-11"
          }
        },
        {
          "type": "PREVIOUS",
          "address": {
            "lines": [
              "11 The other street",
              "New Town",
              "YF9 3FP"
            ]
          },
          "resident": {
            "from": "2010-01-01",
            "to": "2011-11-11"
          }
        }
      ],
      "phones": [
        {
          "type": "HOME",
          "number": "+44 781 761 8573"
        }
      ]
    }
    {
      "title": "Mr",
      "firstName": "Dave",
      "middlenames": [
        "Dai"
      ],
      "lastnames": [
        "Jones"
      ],
      "gender": "MALE",
      "birthdate": "2000-01-01",
      "addresses": [
        {
          "address": {
            "premise": 18,
            "building": "The House",
            "thoroughfare": "The Street",
            "locality": "The Town",
            "postalCode": "CL7 9DF",
            "country": "UK"
          },
          "resident": {
            "from": "2011-11-11"
          }
        }
      ],
      "phones": [
        {
          "type": "HOME",
          "number": "+44 781 761 8573"
        }
      ]
    }

    Response

    The data provided was accepted and the verification results are returned

    Response Headers
    Name Description Example
    Access-Control-Expose-Headers

    A CORS header which allows browser access to the custom response headers. This is a comma seperated list of the required header names


    Type: string
    person-id

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


    Type: string
    verification-id

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


    Type: string
    customer-reference

    The same id as provided by the customer


    Type: string
    • {
      • 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}/response
      • person {
        • 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
        • addresses [
          • address {
            • type string

              specify if this is a current or previous address

              Enum: [CURRENT, PREVIOUS]
            • 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
                }
              }
            • resident {
              • from 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
              • to 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
              }
            • enrichments {
              • cleansed {
                • 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
                  }
                }
              }
            }
          ]
        • phones [
          • phone {
            • type string

              Specifies the type of phone this is

              Enum: [HOME, WORK, MOBILE]
            • number string

              GBG Global Phone format used across the GBG product and services, Required in international format with +(Country Code)

              Pattern: ^(\+)(?:\d\s?){1,14}$ example: +44 207 4281250
            }
          ]
        }
      • score integer

        The cumulative score of all the checks done against this verification as specified by you

      • 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}/response"
      },
      "person": {
        "title": {
          "Title": null,
          "Type": "string",
          "Format": null,
          "Description": "Title of an individual such as Mr, Mrs, Dr, Sir",
          "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": "Mr"
          },
          "Enum": [],
          "Nullable": false,
          "ExternalDocs": null,
          "Deprecated": false,
          "Xml": null,
          "Extensions": {},
          "UnresolvedReference": false,
          "Reference": null
        },
        "firstName": {
          "Title": null,
          "Type": "string",
          "Format": null,
          "Description": "A person's name used by their collegues and friends to address them",
          "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": "David"
          },
          "Enum": [],
          "Nullable": false,
          "ExternalDocs": null,
          "Deprecated": false,
          "Xml": null,
          "Extensions": {},
          "UnresolvedReference": false,
          "Reference": null
        },
        "middlenames": {
          "Title": null,
          "Type": "array",
          "Format": null,
          "Description": "Any other registered names used by the individual, not aliases",
          "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": {
            "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": "James"
            },
            "Enum": [],
            "Nullable": false,
            "ExternalDocs": null,
            "Deprecated": false,
            "Xml": null,
            "Extensions": {},
            "UnresolvedReference": false,
            "Reference": 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
        },
        "lastnames": {
          "Title": null,
          "Type": "array",
          "Format": null,
          "Description": "Any family names for the individual",
          "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": {
            "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": "Jones"
            },
            "Enum": [],
            "Nullable": false,
            "ExternalDocs": null,
            "Deprecated": false,
            "Xml": null,
            "Extensions": {},
            "UnresolvedReference": false,
            "Reference": 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
        },
        "gender": {
          "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": "MALE"
          },
          "Enum": [
            {
              "PrimitiveType": 4,
              "AnyType": 0,
              "Value": "MALE"
            },
            {
              "PrimitiveType": 4,
              "AnyType": 0,
              "Value": "FEMALE"
            },
            {
              "PrimitiveType": 4,
              "AnyType": 0,
              "Value": "UNSPECIFIED"
            }
          ],
          "Nullable": false,
          "ExternalDocs": null,
          "Deprecated": false,
          "Xml": null,
          "Extensions": {},
          "UnresolvedReference": false,
          "Reference": null
        },
        "birthdate": {
          "Title": null,
          "Type": "string",
          "Format": null,
          "Description": "Specified in year, month and day separated by - which conforms to ISO 8601, should be two digit month and day",
          "Maximum": null,
          "ExclusiveMaximum": null,
          "Minimum": null,
          "ExclusiveMinimum": null,
          "MaxLength": null,
          "MinLength": null,
          "Pattern": "^\\d{4}-\\d{2}-\\d{2}$",
          "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": "2000-01-01"
          },
          "Enum": [],
          "Nullable": false,
          "ExternalDocs": null,
          "Deprecated": false,
          "Xml": null,
          "Extensions": {},
          "UnresolvedReference": false,
          "Reference": null
        },
        "addresses": {
          "Title": null,
          "Type": "array",
          "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": {
            "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": [
              "address"
            ],
            "Items": null,
            "MaxItems": null,
            "MinItems": null,
            "UniqueItems": null,
            "Properties": {
              "type": {
                "Title": null,
                "Type": "string",
                "Format": null,
                "Description": "specify if this is a current or previous address",
                "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": [
                  {
                    "PrimitiveType": 4,
                    "AnyType": 0,
                    "Value": "CURRENT"
                  },
                  {
                    "PrimitiveType": 4,
                    "AnyType": 0,
                    "Value": "PREVIOUS"
                  }
                ],
                "Nullable": false,
                "ExternalDocs": null,
                "Deprecated": false,
                "Xml": null,
                "Extensions": {},
                "UnresolvedReference": false,
                "Reference": null
              },
              "address": {
                "Title": null,
                "Type": "object",
                "Format": null,
                "Description": "GBG Global Address format used across the GBG product and services",
                "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": {
                  "lines": {
                    "Title": null,
                    "Type": "array",
                    "Format": null,
                    "Description": "If you don't know the address fields to use then put them in here.  If a cleansed result is returned then these fields will be populated as well with the full address for usability purposes",
                    "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": {
                      "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
                    },
                    "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
                  },
                  "address": {
                    "Title": null,
                    "Type": "string",
                    "Format": null,
                    "Description": "Used in the response to contain the full address.",
                    "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
                  },
                  "premise": {
                    "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": "128"
                    },
                    "Enum": [],
                    "Nullable": false,
                    "ExternalDocs": null,
                    "Deprecated": false,
                    "Xml": null,
                    "Extensions": {},
                    "UnresolvedReference": false,
                    "Reference": null
                  },
                  "building": {
                    "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
                  },
                  "subBuilding": {
                    "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
                  },
                  "thoroughfare": {
                    "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": "Queen Victoria Street"
                    },
                    "Enum": [],
                    "Nullable": false,
                    "ExternalDocs": null,
                    "Deprecated": false,
                    "Xml": null,
                    "Extensions": {},
                    "UnresolvedReference": false,
                    "Reference": null
                  },
                  "dependentThoroughfare": {
                    "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
                  },
                  "locality": {
                    "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": "London"
                    },
                    "Enum": [],
                    "Nullable": false,
                    "ExternalDocs": null,
                    "Deprecated": false,
                    "Xml": null,
                    "Extensions": {},
                    "UnresolvedReference": false,
                    "Reference": null
                  },
                  "dependentLocality": {
                    "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
                  },
                  "doubleDependentLocality": {
                    "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
                  },
                  "postalCode": {
                    "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": "EC4V 4BJ"
                    },
                    "Enum": [],
                    "Nullable": false,
                    "ExternalDocs": null,
                    "Deprecated": false,
                    "Xml": null,
                    "Extensions": {},
                    "UnresolvedReference": false,
                    "Reference": null
                  },
                  "postBox": {
                    "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
                  },
                  "country": {
                    "Title": null,
                    "Type": "string",
                    "Format": null,
                    "Description": "Country the address is in.  It must be a valid ISO2 or ISO3 country code",
                    "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": "GBR"
                    },
                    "Enum": [],
                    "Nullable": false,
                    "ExternalDocs": null,
                    "Deprecated": false,
                    "Xml": null,
                    "Extensions": {},
                    "UnresolvedReference": false,
                    "Reference": null
                  },
                  "superAdministrativeArea": {
                    "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
                  },
                  "administrativeArea": {
                    "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
                  },
                  "subAdministrativeArea": {
                    "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
                  },
                  "organization": {
                    "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": "GB Group"
                    },
                    "Enum": [],
                    "Nullable": false,
                    "ExternalDocs": null,
                    "Deprecated": false,
                    "Xml": null,
                    "Extensions": {},
                    "UnresolvedReference": false,
                    "Reference": null
                  },
                  "quality": {
                    "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": {
                      "avc": {
                        "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
                      },
                      "aqi": {
                        "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
                      }
                    },
                    "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
                  },
                  "location": {
                    "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": {
                      "latitude": {
                        "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
                      },
                      "longitude": {
                        "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
                      },
                      "geoAccuracy": {
                        "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
                      }
                    },
                    "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
                  }
                },
                "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
              },
              "resident": {
                "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": [
                  "from"
                ],
                "Items": null,
                "MaxItems": null,
                "MinItems": null,
                "UniqueItems": null,
                "Properties": {
                  "from": {
                    "Title": null,
                    "Type": "string",
                    "Format": null,
                    "Description": "Specified in year, month and day separated by - which conforms to ISO 8601, should be two digit month and day",
                    "Maximum": null,
                    "ExclusiveMaximum": null,
                    "Minimum": null,
                    "ExclusiveMinimum": null,
                    "MaxLength": null,
                    "MinLength": null,
                    "Pattern": "^\\d{4}-\\d{2}-\\d{2}$",
                    "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": "2000-01-01"
                    },
                    "Enum": [],
                    "Nullable": false,
                    "ExternalDocs": null,
                    "Deprecated": false,
                    "Xml": null,
                    "Extensions": {},
                    "UnresolvedReference": false,
                    "Reference": null
                  },
                  "to": {
                    "Title": null,
                    "Type": "string",
                    "Format": null,
                    "Description": "Specified in year, month and day separated by - which conforms to ISO 8601, should be two digit month and day",
                    "Maximum": null,
                    "ExclusiveMaximum": null,
                    "Minimum": null,
                    "ExclusiveMinimum": null,
                    "MaxLength": null,
                    "MinLength": null,
                    "Pattern": "^\\d{4}-\\d{2}-\\d{2}$",
                    "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": "2000-01-01"
                    },
                    "Enum": [],
                    "Nullable": false,
                    "ExternalDocs": null,
                    "Deprecated": false,
                    "Xml": null,
                    "Extensions": {},
                    "UnresolvedReference": false,
                    "Reference": null
                  }
                },
                "MaxProperties": null,
                "MinProperties": null,
                "AdditionalPropertiesAllowed": false,
                "AdditionalProperties": null,
                "Discriminator": null,
                "Example": null,
                "Enum": [],
                "Nullable": false,
                "ExternalDocs": null,
                "Deprecated": false,
                "Xml": null,
                "Extensions": {},
                "UnresolvedReference": false,
                "Reference": null
              },
              "enrichments": {
                "Title": null,
                "Type": "object",
                "Format": null,
                "Description": "Any enrichments done by GBG for this address is supplied here.  Such as converting the supplied address to a nationaly recognised format",
                "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": {
                  "cleansed": {
                    "Title": null,
                    "Type": "object",
                    "Format": null,
                    "Description": "GBG Global Address format used across the GBG product and services",
                    "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": {
                      "lines": {
                        "Title": null,
                        "Type": "array",
                        "Format": null,
                        "Description": "If you don't know the address fields to use then put them in here.  If a cleansed result is returned then these fields will be populated as well with the full address for usability purposes",
                        "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": {
                          "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
                        },
                        "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
                      },
                      "address": {
                        "Title": null,
                        "Type": "string",
                        "Format": null,
                        "Description": "Used in the response to contain the full address.",
                        "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
                      },
                      "premise": {
                        "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": "128"
                        },
                        "Enum": [],
                        "Nullable": false,
                        "ExternalDocs": null,
                        "Deprecated": false,
                        "Xml": null,
                        "Extensions": {},
                        "UnresolvedReference": false,
                        "Reference": null
                      },
                      "building": {
                        "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
                      },
                      "subBuilding": {
                        "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
                      },
                      "thoroughfare": {
                        "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": "Queen Victoria Street"
                        },
                        "Enum": [],
                        "Nullable": false,
                        "ExternalDocs": null,
                        "Deprecated": false,
                        "Xml": null,
                        "Extensions": {},
                        "UnresolvedReference": false,
                        "Reference": null
                      },
                      "dependentThoroughfare": {
                        "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
                      },
                      "locality": {
                        "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": "London"
                        },
                        "Enum": [],
                        "Nullable": false,
                        "ExternalDocs": null,
                        "Deprecated": false,
                        "Xml": null,
                        "Extensions": {},
                        "UnresolvedReference": false,
                        "Reference": null
                      },
                      "dependentLocality": {
                        "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
                      },
                      "doubleDependentLocality": {
                        "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
                      },
                      "postalCode": {
                        "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": "EC4V 4BJ"
                        },
                        "Enum": [],
                        "Nullable": false,
                        "ExternalDocs": null,
                        "Deprecated": false,
                        "Xml": null,
                        "Extensions": {},
                        "UnresolvedReference": false,
                        "Reference": null
                      },
                      "postBox": {
                        "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
                      },
                      "country": {
                        "Title": null,
                        "Type": "string",
                        "Format": null,
                        "Description": "Country the address is in.  It must be a valid ISO2 or ISO3 country code",
                        "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": "GBR"
                        },
                        "Enum": [],
                        "Nullable": false,
                        "ExternalDocs": null,
                        "Deprecated": false,
                        "Xml": null,
                        "Extensions": {},
                        "UnresolvedReference": false,
                        "Reference": null
                      },
                      "superAdministrativeArea": {
                        "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
                      },
                      "administrativeArea": {
                        "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
                      },
                      "subAdministrativeArea": {
                        "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
                      },
                      "organization": {
                        "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": "GB Group"
                        },
                        "Enum": [],
                        "Nullable": false,
                        "ExternalDocs": null,
                        "Deprecated": false,
                        "Xml": null,
                        "Extensions": {},
                        "UnresolvedReference": false,
                        "Reference": null
                      },
                      "quality": {
                        "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": {
                          "avc": {
                            "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
                          },
                          "aqi": {
                            "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
                          }
                        },
                        "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
                      },
                      "location": {
                        "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": {
                          "latitude": {
                            "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
                          },
                          "longitude": {
                            "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
                          },
                          "geoAccuracy": {
                            "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
                          }
                        },
                        "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
                      }
                    },
                    "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
                  }
                },
                "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
              }
            },
            "MaxProperties": null,
            "MinProperties": null,
            "AdditionalPropertiesAllowed": false,
            "AdditionalProperties": null,
            "Discriminator": null,
            "Example": null,
            "Enum": [],
            "Nullable": false,
            "ExternalDocs": null,
            "Deprecated": false,
            "Xml": null,
            "Extensions": {},
            "UnresolvedReference": false,
            "Reference": 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
        },
        "phones": {
          "Title": null,
          "Type": "array",
          "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": {
            "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": {
              "type": {
                "Title": null,
                "Type": "string",
                "Format": null,
                "Description": "Specifies the type of phone this is",
                "Maximum": null,
                "ExclusiveMaximum": null,
                "Minimum": null,
                "ExclusiveMinimum": null,
                "MaxLength": null,
                "MinLength": null,
                "Pattern": null,
                "MultipleOf": null,
                "Default": {
                  "PrimitiveType": 4,
                  "AnyType": 0,
                  "Value": "HOME"
                },
                "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": [
                  {
                    "PrimitiveType": 4,
                    "AnyType": 0,
                    "Value": "HOME"
                  },
                  {
                    "PrimitiveType": 4,
                    "AnyType": 0,
                    "Value": "WORK"
                  },
                  {
                    "PrimitiveType": 4,
                    "AnyType": 0,
                    "Value": "MOBILE"
                  }
                ],
                "Nullable": false,
                "ExternalDocs": null,
                "Deprecated": false,
                "Xml": null,
                "Extensions": {},
                "UnresolvedReference": false,
                "Reference": null
              },
              "number": {
                "Title": null,
                "Type": "string",
                "Format": null,
                "Description": "GBG Global Phone format used across the GBG product and services, Required in international format with +(Country Code)",
                "Maximum": null,
                "ExclusiveMaximum": null,
                "Minimum": null,
                "ExclusiveMinimum": null,
                "MaxLength": null,
                "MinLength": null,
                "Pattern": "^(\\+)(?:\\d\\s?){1,14}$",
                "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": "+44 207 4281250"
                },
                "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
          },
          "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
        }
      },
      "score": 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

    • {
      • 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

    • {
      • 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

    • {
      • 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

    • {
      • 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

    • {
      • 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
      }
    })
    Post /verify/people/v4/{person-id}

    Submits a person's details to verify them against a preset list of checks. This call should be used where a person-id has been created from a previous verification step.

    • 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 'triangulation-verification-id: 9d75d85e-f7bc-4d22-a93b-60c04881193d' \
     - H 'Content-Type: application/json' \
        -d '{
      "title": "Mr",
      "firstName": "Dave",
      "middlenames": [
        "Dai"
      ],
      "lastnames": [
        "Jones"
      ],
      "gender": "MALE",
      "birthdate": "2000-01-01",
      "addresses": [
        {
          "type": "CURRENT",
          "address": {
            "premise": 18,
            "building": "The House",
            "thoroughfare": "The Street",
            "locality": "The Town",
            "postalCode": "CL7 9DF",
            "country": "UK"
          },
          "resident": {
            "from": "2011-11-11"
          }
        },
        {
          "type": "PREVIOUS",
          "address": {
            "lines": [
              "11 The other street",
              "New Town",
              "YF9 3FP"
            ]
          },
          "resident": {
            "from": "2010-01-01",
            "to": "2011-11-11"
          }
        }
      ],
      "phones": [
        {
          "type": "HOME",
          "number": "+44 781 761 8573"
        }
      ]
    }' \
    "https://api.gbgplc.com/verify/people/v4/{person-id}"
    
    var data = JSON.stringify({
      "title": "Mr",
      "firstName": "Dave",
      "middlenames": [
        "Dai"
      ],
      "lastnames": [
        "Jones"
      ],
      "gender": "MALE",
      "birthdate": "2000-01-01",
      "addresses": [
        {
          "type": "CURRENT",
          "address": {
            "premise": 18,
            "building": "The House",
            "thoroughfare": "The Street",
            "locality": "The Town",
            "postalCode": "CL7 9DF",
            "country": "UK"
          },
          "resident": {
            "from": "2011-11-11"
          }
        },
        {
          "type": "PREVIOUS",
          "address": {
            "lines": [
              "11 The other street",
              "New Town",
              "YF9 3FP"
            ]
          },
          "resident": {
            "from": "2010-01-01",
            "to": "2011-11-11"
          }
        }
      ],
      "phones": [
        {
          "type": "HOME",
          "number": "+44 781 761 8573"
        }
      ]
    });
    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-id}');
    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('triangulation-verification-id', '9d75d85e-f7bc-4d22-a93b-60c04881193d');
    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-id}");
    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");
    message.Headers.Add("triangulation-verification-id", "9d75d85e-f7bc-4d22-a93b-60c04881193d");
    message.Content = new StringContent(@"{
      ""title"": ""Mr"",
      ""firstName"": ""Dave"",
      ""middlenames"": [
        ""Dai""
      ],
      ""lastnames"": [
        ""Jones""
      ],
      ""gender"": ""MALE"",
      ""birthdate"": ""2000-01-01"",
      ""addresses"": [
        {
          ""type"": ""CURRENT"",
          ""address"": {
            ""premise"": 18,
            ""building"": ""The House"",
            ""thoroughfare"": ""The Street"",
            ""locality"": ""The Town"",
            ""postalCode"": ""CL7 9DF"",
            ""country"": ""UK""
          },
          ""resident"": {
            ""from"": ""2011-11-11""
          }
        },
        {
          ""type"": ""PREVIOUS"",
          ""address"": {
            ""lines"": [
              ""11 The other street"",
              ""New Town"",
              ""YF9 3FP""
            ]
          },
          ""resident"": {
            ""from"": ""2010-01-01"",
            ""to"": ""2011-11-11""
          }
        }
      ],
      ""phones"": [
        {
          ""type"": ""HOME"",
          ""number"": ""+44 781 761 8573""
        }
      ]
    }", Encoding.UTF8, "application/json");
    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}';
    $ch = curl_init($url);
    curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
    curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, false);
    $data = '{
      "title": "Mr",
      "firstName": "Dave",
      "middlenames": [
        "Dai"
      ],
      "lastnames": [
        "Jones"
      ],
      "gender": "MALE",
      "birthdate": "2000-01-01",
      "addresses": [
        {
          "type": "CURRENT",
          "address": {
            "premise": 18,
            "building": "The House",
            "thoroughfare": "The Street",
            "locality": "The Town",
            "postalCode": "CL7 9DF",
            "country": "UK"
          },
          "resident": {
            "from": "2011-11-11"
          }
        },
        {
          "type": "PREVIOUS",
          "address": {
            "lines": [
              "11 The other street",
              "New Town",
              "YF9 3FP"
            ]
          },
          "resident": {
            "from": "2010-01-01",
            "to": "2011-11-11"
          }
        }
      ],
      "phones": [
        {
          "type": "HOME",
          "number": "+44 781 761 8573"
        }
      ]
    }';
    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',
        'triangulation-verification-id: 9d75d85e-f7bc-4d22-a93b-60c04881193d',
        'content-type: application/json',
        'Content-Length: ' . strlen($data))
    );
    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");
    headers.set("triangulation-verification-id", "9d75d85e-f7bc-4d22-a93b-60c04881193d");
    String body = "<JSON BODY>";
    HttpEntity<String> request = new HttpEntity<>(body, headers);
    String host = "https://api.gbgplc.com/verify/people/v4/{person-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.

    Path Parameters
    Name Description Example

    person-id*

    Required

    Use to identify the verification made against a person


    Type: string
    9d75d85e-f7bc-4d22-a93b-60c04881193d
    Header Parameters
    Name Description Example

    Authorization*

    Required

    A JWT token to allow access


    Type: string

    cleanse-address

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


    Type: boolean
    true

    journey-id*

    Required

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


    Type: string
    9d75d85e-f7bc-4d22-a93b-60c04881193d

    journey-version*

    Required

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


    Type: integer
    1

    customer-reference

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


    Type: string
    9d75d86e-f7bc-4d22-a93b-59c04881193f

    triangulation-verification-id

    ID of a previous verification step which this input should be compared with. The matching person-id header must be populated to use this option.


    Type: string
    9d75d85e-f7bc-4d22-a93b-60c04881193d

    Request Body

    • Example
    • Schema
    • {
      • 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
      • addresses [
        • address {
          • type string

            specify if this is a current or previous address

            Enum: [CURRENT, PREVIOUS]
          • 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
              }
            }
          • resident {
            • from 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
            • to 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
            }
          • enrichments {
            • cleansed {
              • 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
                }
              }
            }
          }
        ]
      • phones [
        • phone {
          • type string

            Specifies the type of phone this is

            Enum: [HOME, WORK, MOBILE]
          • number string

            GBG Global Phone format used across the GBG product and services, Required in international format with +(Country Code)

            Pattern: ^(\+)(?:\d\s?){1,14}$ example: +44 207 4281250
          }
        ]
      }
    {
      "title": "Mr",
      "firstName": "Dave",
      "middlenames": [
        "Dai"
      ],
      "lastnames": [
        "Jones"
      ],
      "gender": "MALE",
      "birthdate": "2000-01-01",
      "addresses": [
        {
          "type": "CURRENT",
          "address": {
            "premise": 18,
            "building": "The House",
            "thoroughfare": "The Street",
            "locality": "The Town",
            "postalCode": "CL7 9DF",
            "country": "UK"
          },
          "resident": {
            "from": "2011-11-11"
          }
        },
        {
          "type": "PREVIOUS",
          "address": {
            "lines": [
              "11 The other street",
              "New Town",
              "YF9 3FP"
            ]
          },
          "resident": {
            "from": "2010-01-01",
            "to": "2011-11-11"
          }
        }
      ],
      "phones": [
        {
          "type": "HOME",
          "number": "+44 781 761 8573"
        }
      ]
    }
    {
      "title": "Mr",
      "firstName": "Dave",
      "middlenames": [
        "Dai"
      ],
      "lastnames": [
        "Jones"
      ],
      "gender": "MALE",
      "birthdate": "2000-01-01",
      "addresses": [
        {
          "address": {
            "premise": 18,
            "building": "The House",
            "thoroughfare": "The Street",
            "locality": "The Town",
            "postalCode": "CL7 9DF",
            "country": "UK"
          },
          "resident": {
            "from": "2011-11-11"
          }
        }
      ],
      "phones": [
        {
          "type": "HOME",
          "number": "+44 781 761 8573"
        }
      ]
    }

    Response

    The data provided was accepted and the verification results are returned

    Response Headers
    Name Description Example
    verification-id

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


    Type: string
    customer-reference

    The same id as provided by the customer


    Type: string
    • {
      • 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}/response
      • person {
        • 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
        • addresses [
          • address {
            • type string

              specify if this is a current or previous address

              Enum: [CURRENT, PREVIOUS]
            • 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
                }
              }
            • resident {
              • from 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
              • to 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
              }
            • enrichments {
              • cleansed {
                • 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
                  }
                }
              }
            }
          ]
        • phones [
          • phone {
            • type string

              Specifies the type of phone this is

              Enum: [HOME, WORK, MOBILE]
            • number string

              GBG Global Phone format used across the GBG product and services, Required in international format with +(Country Code)

              Pattern: ^(\+)(?:\d\s?){1,14}$ example: +44 207 4281250
            }
          ]
        }
      • score integer

        The cumulative score of all the checks done against this verification as specified by you

      • 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}/response"
      },
      "person": {
        "title": {
          "Title": null,
          "Type": "string",
          "Format": null,
          "Description": "Title of an individual such as Mr, Mrs, Dr, Sir",
          "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": "Mr"
          },
          "Enum": [],
          "Nullable": false,
          "ExternalDocs": null,
          "Deprecated": false,
          "Xml": null,
          "Extensions": {},
          "UnresolvedReference": false,
          "Reference": null
        },
        "firstName": {
          "Title": null,
          "Type": "string",
          "Format": null,
          "Description": "A person's name used by their collegues and friends to address them",
          "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": "David"
          },
          "Enum": [],
          "Nullable": false,
          "ExternalDocs": null,
          "Deprecated": false,
          "Xml": null,
          "Extensions": {},
          "UnresolvedReference": false,
          "Reference": null
        },
        "middlenames": {
          "Title": null,
          "Type": "array",
          "Format": null,
          "Description": "Any other registered names used by the individual, not aliases",
          "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": {
            "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": "James"
            },
            "Enum": [],
            "Nullable": false,
            "ExternalDocs": null,
            "Deprecated": false,
            "Xml": null,
            "Extensions": {},
            "UnresolvedReference": false,
            "Reference": 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
        },
        "lastnames": {
          "Title": null,
          "Type": "array",
          "Format": null,
          "Description": "Any family names for the individual",
          "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": {
            "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": "Jones"
            },
            "Enum": [],
            "Nullable": false,
            "ExternalDocs": null,
            "Deprecated": false,
            "Xml": null,
            "Extensions": {},
            "UnresolvedReference": false,
            "Reference": 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
        },
        "gender": {
          "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": "MALE"
          },
          "Enum": [
            {
              "PrimitiveType": 4,
              "AnyType": 0,
              "Value": "MALE"
            },
            {
              "PrimitiveType": 4,
              "AnyType": 0,
              "Value": "FEMALE"
            },
            {
              "PrimitiveType": 4,
              "AnyType": 0,
              "Value": "UNSPECIFIED"
            }
          ],
          "Nullable": false,
          "ExternalDocs": null,
          "Deprecated": false,
          "Xml": null,
          "Extensions": {},
          "UnresolvedReference": false,
          "Reference": null
        },
        "birthdate": {
          "Title": null,
          "Type": "string",
          "Format": null,
          "Description": "Specified in year, month and day separated by - which conforms to ISO 8601, should be two digit month and day",
          "Maximum": null,
          "ExclusiveMaximum": null,
          "Minimum": null,
          "ExclusiveMinimum": null,
          "MaxLength": null,
          "MinLength": null,
          "Pattern": "^\\d{4}-\\d{2}-\\d{2}$",
          "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": "2000-01-01"
          },
          "Enum": [],
          "Nullable": false,
          "ExternalDocs": null,
          "Deprecated": false,
          "Xml": null,
          "Extensions": {},
          "UnresolvedReference": false,
          "Reference": null
        },
        "addresses": {
          "Title": null,
          "Type": "array",
          "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": {
            "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": [
              "address"
            ],
            "Items": null,
            "MaxItems": null,
            "MinItems": null,
            "UniqueItems": null,
            "Properties": {
              "type": {
                "Title": null,
                "Type": "string",
                "Format": null,
                "Description": "specify if this is a current or previous address",
                "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": [
                  {
                    "PrimitiveType": 4,
                    "AnyType": 0,
                    "Value": "CURRENT"
                  },
                  {
                    "PrimitiveType": 4,
                    "AnyType": 0,
                    "Value": "PREVIOUS"
                  }
                ],
                "Nullable": false,
                "ExternalDocs": null,
                "Deprecated": false,
                "Xml": null,
                "Extensions": {},
                "UnresolvedReference": false,
                "Reference": null
              },
              "address": {
                "Title": null,
                "Type": "object",
                "Format": null,
                "Description": "GBG Global Address format used across the GBG product and services",
                "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": {
                  "lines": {
                    "Title": null,
                    "Type": "array",
                    "Format": null,
                    "Description": "If you don't know the address fields to use then put them in here.  If a cleansed result is returned then these fields will be populated as well with the full address for usability purposes",
                    "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": {
                      "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
                    },
                    "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
                  },
                  "address": {
                    "Title": null,
                    "Type": "string",
                    "Format": null,
                    "Description": "Used in the response to contain the full address.",
                    "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
                  },
                  "premise": {
                    "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": "128"
                    },
                    "Enum": [],
                    "Nullable": false,
                    "ExternalDocs": null,
                    "Deprecated": false,
                    "Xml": null,
                    "Extensions": {},
                    "UnresolvedReference": false,
                    "Reference": null
                  },
                  "building": {
                    "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
                  },
                  "subBuilding": {
                    "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
                  },
                  "thoroughfare": {
                    "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": "Queen Victoria Street"
                    },
                    "Enum": [],
                    "Nullable": false,
                    "ExternalDocs": null,
                    "Deprecated": false,
                    "Xml": null,
                    "Extensions": {},
                    "UnresolvedReference": false,
                    "Reference": null
                  },
                  "dependentThoroughfare": {
                    "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
                  },
                  "locality": {
                    "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": "London"
                    },
                    "Enum": [],
                    "Nullable": false,
                    "ExternalDocs": null,
                    "Deprecated": false,
                    "Xml": null,
                    "Extensions": {},
                    "UnresolvedReference": false,
                    "Reference": null
                  },
                  "dependentLocality": {
                    "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
                  },
                  "doubleDependentLocality": {
                    "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
                  },
                  "postalCode": {
                    "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": "EC4V 4BJ"
                    },
                    "Enum": [],
                    "Nullable": false,
                    "ExternalDocs": null,
                    "Deprecated": false,
                    "Xml": null,
                    "Extensions": {},
                    "UnresolvedReference": false,
                    "Reference": null
                  },
                  "postBox": {
                    "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
                  },
                  "country": {
                    "Title": null,
                    "Type": "string",
                    "Format": null,
                    "Description": "Country the address is in.  It must be a valid ISO2 or ISO3 country code",
                    "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": "GBR"
                    },
                    "Enum": [],
                    "Nullable": false,
                    "ExternalDocs": null,
                    "Deprecated": false,
                    "Xml": null,
                    "Extensions": {},
                    "UnresolvedReference": false,
                    "Reference": null
                  },
                  "superAdministrativeArea": {
                    "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
                  },
                  "administrativeArea": {
                    "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
                  },
                  "subAdministrativeArea": {
                    "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
                  },
                  "organization": {
                    "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": "GB Group"
                    },
                    "Enum": [],
                    "Nullable": false,
                    "ExternalDocs": null,
                    "Deprecated": false,
                    "Xml": null,
                    "Extensions": {},
                    "UnresolvedReference": false,
                    "Reference": null
                  },
                  "quality": {
                    "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": {
                      "avc": {
                        "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
                      },
                      "aqi": {
                        "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
                      }
                    },
                    "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
                  },
                  "location": {
                    "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": {
                      "latitude": {
                        "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
                      },
                      "longitude": {
                        "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
                      },
                      "geoAccuracy": {
                        "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
                      }
                    },
                    "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
                  }
                },
                "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
              },
              "resident": {
                "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": [
                  "from"
                ],
                "Items": null,
                "MaxItems": null,
                "MinItems": null,
                "UniqueItems": null,
                "Properties": {
                  "from": {
                    "Title": null,
                    "Type": "string",
                    "Format": null,
                    "Description": "Specified in year, month and day separated by - which conforms to ISO 8601, should be two digit month and day",
                    "Maximum": null,
                    "ExclusiveMaximum": null,
                    "Minimum": null,
                    "ExclusiveMinimum": null,
                    "MaxLength": null,
                    "MinLength": null,
                    "Pattern": "^\\d{4}-\\d{2}-\\d{2}$",
                    "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": "2000-01-01"
                    },
                    "Enum": [],
                    "Nullable": false,
                    "ExternalDocs": null,
                    "Deprecated": false,
                    "Xml": null,
                    "Extensions": {},
                    "UnresolvedReference": false,
                    "Reference": null
                  },
                  "to": {
                    "Title": null,
                    "Type": "string",
                    "Format": null,
                    "Description": "Specified in year, month and day separated by - which conforms to ISO 8601, should be two digit month and day",
                    "Maximum": null,
                    "ExclusiveMaximum": null,
                    "Minimum": null,
                    "ExclusiveMinimum": null,
                    "MaxLength": null,
                    "MinLength": null,
                    "Pattern": "^\\d{4}-\\d{2}-\\d{2}$",
                    "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": "2000-01-01"
                    },
                    "Enum": [],
                    "Nullable": false,
                    "ExternalDocs": null,
                    "Deprecated": false,
                    "Xml": null,
                    "Extensions": {},
                    "UnresolvedReference": false,
                    "Reference": null
                  }
                },
                "MaxProperties": null,
                "MinProperties": null,
                "AdditionalPropertiesAllowed": false,
                "AdditionalProperties": null,
                "Discriminator": null,
                "Example": null,
                "Enum": [],
                "Nullable": false,
                "ExternalDocs": null,
                "Deprecated": false,
                "Xml": null,
                "Extensions": {},
                "UnresolvedReference": false,
                "Reference": null
              },
              "enrichments": {
                "Title": null,
                "Type": "object",
                "Format": null,
                "Description": "Any enrichments done by GBG for this address is supplied here.  Such as converting the supplied address to a nationaly recognised format",
                "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": {
                  "cleansed": {
                    "Title": null,
                    "Type": "object",
                    "Format": null,
                    "Description": "GBG Global Address format used across the GBG product and services",
                    "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": {
                      "lines": {
                        "Title": null,
                        "Type": "array",
                        "Format": null,
                        "Description": "If you don't know the address fields to use then put them in here.  If a cleansed result is returned then these fields will be populated as well with the full address for usability purposes",
                        "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": {
                          "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
                        },
                        "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
                      },
                      "address": {
                        "Title": null,
                        "Type": "string",
                        "Format": null,
                        "Description": "Used in the response to contain the full address.",
                        "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
                      },
                      "premise": {
                        "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": "128"
                        },
                        "Enum": [],
                        "Nullable": false,
                        "ExternalDocs": null,
                        "Deprecated": false,
                        "Xml": null,
                        "Extensions": {},
                        "UnresolvedReference": false,
                        "Reference": null
                      },
                      "building": {
                        "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
                      },
                      "subBuilding": {
                        "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
                      },
                      "thoroughfare": {
                        "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": "Queen Victoria Street"
                        },
                        "Enum": [],
                        "Nullable": false,
                        "ExternalDocs": null,
                        "Deprecated": false,
                        "Xml": null,
                        "Extensions": {},
                        "UnresolvedReference": false,
                        "Reference": null
                      },
                      "dependentThoroughfare": {
                        "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
                      },
                      "locality": {
                        "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": "London"
                        },
                        "Enum": [],
                        "Nullable": false,
                        "ExternalDocs": null,
                        "Deprecated": false,
                        "Xml": null,
                        "Extensions": {},
                        "UnresolvedReference": false,
                        "Reference": null
                      },
                      "dependentLocality": {
                        "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
                      },
                      "doubleDependentLocality": {
                        "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
                      },
                      "postalCode": {
                        "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": "EC4V 4BJ"
                        },
                        "Enum": [],
                        "Nullable": false,
                        "ExternalDocs": null,
                        "Deprecated": false,
                        "Xml": null,
                        "Extensions": {},
                        "UnresolvedReference": false,
                        "Reference": null
                      },
                      "postBox": {
                        "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
                      },
                      "country": {
                        "Title": null,
                        "Type": "string",
                        "Format": null,
                        "Description": "Country the address is in.  It must be a valid ISO2 or ISO3 country code",
                        "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": "GBR"
                        },
                        "Enum": [],
                        "Nullable": false,
                        "ExternalDocs": null,
                        "Deprecated": false,
                        "Xml": null,
                        "Extensions": {},
                        "UnresolvedReference": false,
                        "Reference": null
                      },
                      "superAdministrativeArea": {
                        "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
                      },
                      "administrativeArea": {
                        "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
                      },
                      "subAdministrativeArea": {
                        "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
                      },
                      "organization": {
                        "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": "GB Group"
                        },
                        "Enum": [],
                        "Nullable": false,
                        "ExternalDocs": null,
                        "Deprecated": false,
                        "Xml": null,
                        "Extensions": {},
                        "UnresolvedReference": false,
                        "Reference": null
                      },
                      "quality": {
                        "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": {
                          "avc": {
                            "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
                          },
                          "aqi": {
                            "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
                          }
                        },
                        "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
                      },
                      "location": {
                        "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": {
                          "latitude": {
                            "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
                          },
                          "longitude": {
                            "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
                          },
                          "geoAccuracy": {
                            "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
                          }
                        },
                        "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
                      }
                    },
                    "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
                  }
                },
                "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
              }
            },
            "MaxProperties": null,
            "MinProperties": null,
            "AdditionalPropertiesAllowed": false,
            "AdditionalProperties": null,
            "Discriminator": null,
            "Example": null,
            "Enum": [],
            "Nullable": false,
            "ExternalDocs": null,
            "Deprecated": false,
            "Xml": null,
            "Extensions": {},
            "UnresolvedReference": false,
            "Reference": 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
        },
        "phones": {
          "Title": null,
          "Type": "array",
          "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": {
            "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": {
              "type": {
                "Title": null,
                "Type": "string",
                "Format": null,
                "Description": "Specifies the type of phone this is",
                "Maximum": null,
                "ExclusiveMaximum": null,
                "Minimum": null,
                "ExclusiveMinimum": null,
                "MaxLength": null,
                "MinLength": null,
                "Pattern": null,
                "MultipleOf": null,
                "Default": {
                  "PrimitiveType": 4,
                  "AnyType": 0,
                  "Value": "HOME"
                },
                "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": [
                  {
                    "PrimitiveType": 4,
                    "AnyType": 0,
                    "Value": "HOME"
                  },
                  {
                    "PrimitiveType": 4,
                    "AnyType": 0,
                    "Value": "WORK"
                  },
                  {
                    "PrimitiveType": 4,
                    "AnyType": 0,
                    "Value": "MOBILE"
                  }
                ],
                "Nullable": false,
                "ExternalDocs": null,
                "Deprecated": false,
                "Xml": null,
                "Extensions": {},
                "UnresolvedReference": false,
                "Reference": null
              },
              "number": {
                "Title": null,
                "Type": "string",
                "Format": null,
                "Description": "GBG Global Phone format used across the GBG product and services, Required in international format with +(Country Code)",
                "Maximum": null,
                "ExclusiveMaximum": null,
                "Minimum": null,
                "ExclusiveMinimum": null,
                "MaxLength": null,
                "MinLength": null,
                "Pattern": "^(\\+)(?:\\d\\s?){1,14}$",
                "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": "+44 207 4281250"
                },
                "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
          },
          "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
        }
      },
      "score": 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

    • {
      • 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

    • {
      • 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

    • {
      • 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

    • {
      • 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

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

    Verify Document Details

    Get /verify/people/v4/person/documentData/documentTypes

    A helper API call to return the set of currently supported document types and related information.

    • cURL
    • JavaScript
    • C#
    • PHP
    • Java (Spring)
    curl -X GET \
     - H 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c' \
     - H 'Content-Type: application/json' \
    "https://api.gbgplc.com/verify/people/v4/person/documentData/documentTypes"
    
    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/documentData/documentTypes');
    xhr.setRequestHeader('Authorization', 'Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c');
    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/documentData/documentTypes");
    message.Headers.Add("Authorization", "Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c");
    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/documentTypes';
    $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 eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c',
        '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 eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c");
    String host = "https://api.gbgplc.com/verify/people/v4/person/documentData/documentTypes";
    //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.

    Header Parameters
    Name Description Example

    Authorization*

    Required

    A JWT token to allow access


    Type: string
    Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c

    Response

    Success

    • [
      • {
        • documentName string

          name of the supported document, this should be used as the documentType header for image upload or the body object name for data upload

          Enum: [passport, drivingLicence, europeanID, australianMedicare, chineseID]
        • journeyIDs [
          • journeyID {
            • journeyID string

              A journey ID which can be used with this document type.

            • description string

              A text description of this journey, if available.

            • supportedVersions [
              • supportedVersion integer

                a currently supported version of this journey

              ]
            }
          ]
        • schema string

          a string representation of the expected schema for document details of this document type.

        }
      ]
    {})

    Unauthorized

    • {
      • 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

    • {
      • 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

    • {
      • 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
      }
    })
    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.

    • 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.

    Header Parameters
    Name Description Example

    Authorization*

    Required

    A JWT token to allow access


    Type: string

    cleanse-address

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


    Type: boolean
    true

    journey-id*

    Required

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


    Type: string
    9d75d85e-f7bc-4d22-a93b-60c04881193d

    journey-version*

    Required

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


    Type: integer
    1

    customer-reference

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


    Type: string
    9d75d86e-f7bc-4d22-a93b-59c04881193f

    Request Body

    • {
      One of ->
      • UKDrivingLicence {
        • 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
        • mailSort string
        • microfiche string
        • 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
        • licenceNumber 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
        }
      • 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 Description Example
    verification-id

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


    Type: string
    customer-reference

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


    Type: string
    person-id

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


    Type: string
    • {
      • 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}/response
      • person {
        • 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
        • addresses [
          • address {
            • type string

              specify if this is a current or previous address

              Enum: [CURRENT, PREVIOUS]
            • 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
                }
              }
            • resident {
              • from 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
              • to 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
              }
            • enrichments {
              • cleansed {
                • 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
                  }
                }
              }
            }
          ]
        • phones [
          • phone {
            • type string

              Specifies the type of phone this is

              Enum: [HOME, WORK, MOBILE]
            • number string

              GBG Global Phone format used across the GBG product and services, Required in international format with +(Country Code)

              Pattern: ^(\+)(?:\d\s?){1,14}$ example: +44 207 4281250
            }
          ]
        }
      • score integer

        The cumulative score of all the checks done against this verification as specified by you

      • 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}/response"
      },
      "person": {
        "title": {
          "Title": null,
          "Type": "string",
          "Format": null,
          "Description": "Title of an individual such as Mr, Mrs, Dr, Sir",
          "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": "Mr"
          },
          "Enum": [],
          "Nullable": false,
          "ExternalDocs": null,
          "Deprecated": false,
          "Xml": null,
          "Extensions": {},
          "UnresolvedReference": false,
          "Reference": null
        },
        "firstName": {
          "Title": null,
          "Type": "string",
          "Format": null,
          "Description": "A person's name used by their collegues and friends to address them",
          "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": "David"
          },
          "Enum": [],
          "Nullable": false,
          "ExternalDocs": null,
          "Deprecated": false,
          "Xml": null,
          "Extensions": {},
          "UnresolvedReference": false,
          "Reference": null
        },
        "middlenames": {
          "Title": null,
          "Type": "array",
          "Format": null,
          "Description": "Any other registered names used by the individual, not aliases",
          "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": {
            "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": "James"
            },
            "Enum": [],
            "Nullable": false,
            "ExternalDocs": null,
            "Deprecated": false,
            "Xml": null,
            "Extensions": {},
            "UnresolvedReference": false,
            "Reference": 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
        },
        "lastnames": {
          "Title": null,
          "Type": "array",
          "Format": null,
          "Description": "Any family names for the individual",
          "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": {
            "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": "Jones"
            },
            "Enum": [],
            "Nullable": false,
            "ExternalDocs": null,
            "Deprecated": false,
            "Xml": null,
            "Extensions": {},
            "UnresolvedReference": false,
            "Reference": 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
        },
        "gender": {
          "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": "MALE"
          },
          "Enum": [
            {
              "PrimitiveType": 4,
              "AnyType": 0,
              "Value": "MALE"
            },
            {
              "PrimitiveType": 4,
              "AnyType": 0,
              "Value": "FEMALE"
            },
            {
              "PrimitiveType": 4,
              "AnyType": 0,
              "Value": "UNSPECIFIED"
            }
          ],
          "Nullable": false,
          "ExternalDocs": null,
          "Deprecated": false,
          "Xml": null,
          "Extensions": {},
          "UnresolvedReference": false,
          "Reference": null
        },
        "birthdate": {
          "Title": null,
          "Type": "string",
          "Format": null,
          "Description": "Specified in year, month and day separated by - which conforms to ISO 8601, should be two digit month and day",
          "Maximum": null,
          "ExclusiveMaximum": null,
          "Minimum": null,
          "ExclusiveMinimum": null,
          "MaxLength": null,
          "MinLength": null,
          "Pattern": "^\\d{4}-\\d{2}-\\d{2}$",
          "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": "2000-01-01"
          },
          "Enum": [],
          "Nullable": false,
          "ExternalDocs": null,
          "Deprecated": false,
          "Xml": null,
          "Extensions": {},
          "UnresolvedReference": false,
          "Reference": null
        },
        "addresses": {
          "Title": null,
          "Type": "array",
          "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": {
            "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": [
              "address"
            ],
            "Items": null,
            "MaxItems": null,
            "MinItems": null,
            "UniqueItems": null,
            "Properties": {
              "type": {
                "Title": null,
                "Type": "string",
                "Format": null,
                "Description": "specify if this is a current or previous address",
                "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": [
                  {
                    "PrimitiveType": 4,
                    "AnyType": 0,
                    "Value": "CURRENT"
                  },
                  {
                    "PrimitiveType": 4,
                    "AnyType": 0,
                    "Value": "PREVIOUS"
                  }
                ],
                "Nullable": false,
                "ExternalDocs": null,
                "Deprecated": false,
                "Xml": null,
                "Extensions": {},
                "UnresolvedReference": false,
                "Reference": null
              },
              "address": {
                "Title": null,
                "Type": "object",
                "Format": null,
                "Description": "GBG Global Address format used across the GBG product and services",
                "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": {
                  "lines": {
                    "Title": null,
                    "Type": "array",
                    "Format": null,
                    "Description": "If you don't know the address fields to use then put them in here.  If a cleansed result is returned then these fields will be populated as well with the full address for usability purposes",
                    "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": {
                      "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
                    },
                    "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
                  },
                  "address": {
                    "Title": null,
                    "Type": "string",
                    "Format": null,
                    "Description": "Used in the response to contain the full address.",
                    "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
                  },
                  "premise": {
                    "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": "128"
                    },
                    "Enum": [],
                    "Nullable": false,
                    "ExternalDocs": null,
                    "Deprecated": false,
                    "Xml": null,
                    "Extensions": {},
                    "UnresolvedReference": false,
                    "Reference": null
                  },
                  "building": {
                    "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
                  },
                  "subBuilding": {
                    "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
                  },
                  "thoroughfare": {
                    "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": "Queen Victoria Street"
                    },
                    "Enum": [],
                    "Nullable": false,
                    "ExternalDocs": null,
                    "Deprecated": false,
                    "Xml": null,
                    "Extensions": {},
                    "UnresolvedReference": false,
                    "Reference": null
                  },
                  "dependentThoroughfare": {
                    "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
                  },
                  "locality": {
                    "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": "London"
                    },
                    "Enum": [],
                    "Nullable": false,
                    "ExternalDocs": null,
                    "Deprecated": false,
                    "Xml": null,
                    "Extensions": {},
                    "UnresolvedReference": false,
                    "Reference": null
                  },
                  "dependentLocality": {
                    "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
                  },
                  "doubleDependentLocality": {
                    "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
                  },
                  "postalCode": {
                    "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": "EC4V 4BJ"
                    },
                    "Enum": [],
                    "Nullable": false,
                    "ExternalDocs": null,
                    "Deprecated": false,
                    "Xml": null,
                    "Extensions": {},
                    "UnresolvedReference": false,
                    "Reference": null
                  },
                  "postBox": {
                    "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
                  },
                  "country": {
                    "Title": null,
                    "Type": "string",
                    "Format": null,
                    "Description": "Country the address is in.  It must be a valid ISO2 or ISO3 country code",
                    "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": "GBR"
                    },
                    "Enum": [],
                    "Nullable": false,
                    "ExternalDocs": null,
                    "Deprecated": false,
                    "Xml": null,
                    "Extensions": {},
                    "UnresolvedReference": false,
                    "Reference": null
                  },
                  "superAdministrativeArea": {
                    "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
                  },
                  "administrativeArea": {
                    "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
                  },
                  "subAdministrativeArea": {
                    "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
                  },
                  "organization": {
                    "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": "GB Group"
                    },
                    "Enum": [],
                    "Nullable": false,
                    "ExternalDocs": null,
                    "Deprecated": false,
                    "Xml": null,
                    "Extensions": {},
                    "UnresolvedReference": false,
                    "Reference": null
                  },
                  "quality": {
                    "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": {
                      "avc": {
                        "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
                      },
                      "aqi": {
                        "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
                      }
                    },
                    "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
                  },
                  "location": {
                    "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": {
                      "latitude": {
                        "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
                      },
                      "longitude": {
                        "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
                      },
                      "geoAccuracy": {
                        "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
                      }
                    },
                    "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
                  }
                },
                "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
              },
              "resident": {
                "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": [
                  "from"
                ],
                "Items": null,
                "MaxItems": null,
                "MinItems": null,
                "UniqueItems": null,
                "Properties": {
                  "from": {
                    "Title": null,
                    "Type": "string",
                    "Format": null,
                    "Description": "Specified in year, month and day separated by - which conforms to ISO 8601, should be two digit month and day",
                    "Maximum": null,
                    "ExclusiveMaximum": null,
                    "Minimum": null,
                    "ExclusiveMinimum": null,
                    "MaxLength": null,
                    "MinLength": null,
                    "Pattern": "^\\d{4}-\\d{2}-\\d{2}$",
                    "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": "2000-01-01"
                    },
                    "Enum": [],
                    "Nullable": false,
                    "ExternalDocs": null,
                    "Deprecated": false,
                    "Xml": null,
                    "Extensions": {},
                    "UnresolvedReference": false,
                    "Reference": null
                  },
                  "to": {
                    "Title": null,
                    "Type": "string",
                    "Format": null,
                    "Description": "Specified in year, month and day separated by - which conforms to ISO 8601, should be two digit month and day",
                    "Maximum": null,
                    "ExclusiveMaximum": null,
                    "Minimum": null,
                    "ExclusiveMinimum": null,
                    "MaxLength": null,
                    "MinLength": null,
                    "Pattern": "^\\d{4}-\\d{2}-\\d{2}$",
                    "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": "2000-01-01"
                    },
                    "Enum": [],
                    "Nullable": false,
                    "ExternalDocs": null,
                    "Deprecated": false,
                    "Xml": null,
                    "Extensions": {},
                    "UnresolvedReference": false,
                    "Reference": null
                  }
                },
                "MaxProperties": null,
                "MinProperties": null,
                "AdditionalPropertiesAllowed": false,
                "AdditionalProperties": null,
                "Discriminator": null,
                "Example": null,
                "Enum": [],
                "Nullable": false,
                "ExternalDocs": null,
                "Deprecated": false,
                "Xml": null,
                "Extensions": {},
                "UnresolvedReference": false,
                "Reference": null
              },
              "enrichments": {
                "Title": null,
                "Type": "object",
                "Format": null,
                "Description": "Any enrichments done by GBG for this address is supplied here.  Such as converting the supplied address to a nationaly recognised format",
                "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": {
                  "cleansed": {
                    "Title": null,
                    "Type": "object",
                    "Format": null,
                    "Description": "GBG Global Address format used across the GBG product and services",
                    "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": {
                      "lines": {
                        "Title": null,
                        "Type": "array",
                        "Format": null,
                        "Description": "If you don't know the address fields to use then put them in here.  If a cleansed result is returned then these fields will be populated as well with the full address for usability purposes",
                        "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": {
                          "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
                        },
                        "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
                      },
                      "address": {
                        "Title": null,
                        "Type": "string",
                        "Format": null,
                        "Description": "Used in the response to contain the full address.",
                        "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
                      },
                      "premise": {
                        "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": "128"
                        },
                        "Enum": [],
                        "Nullable": false,
                        "ExternalDocs": null,
                        "Deprecated": false,
                        "Xml": null,
                        "Extensions": {},
                        "UnresolvedReference": false,
                        "Reference": null
                      },
                      "building": {
                        "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
                      },
                      "subBuilding": {
                        "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
                      },
                      "thoroughfare": {
                        "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": "Queen Victoria Street"
                        },
                        "Enum": [],
                        "Nullable": false,
                        "ExternalDocs": null,
                        "Deprecated": false,
                        "Xml": null,
                        "Extensions": {},
                        "UnresolvedReference": false,
                        "Reference": null
                      },
                      "dependentThoroughfare": {
                        "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
                      },
                      "locality": {
                        "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": "London"
                        },
                        "Enum": [],
                        "Nullable": false,
                        "ExternalDocs": null,
                        "Deprecated": false,
                        "Xml": null,
                        "Extensions": {},
                        "UnresolvedReference": false,
                        "Reference": null
                      },
                      "dependentLocality": {
                        "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
                      },
                      "doubleDependentLocality": {
                        "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
                      },
                      "postalCode": {
                        "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": "EC4V 4BJ"
                        },
                        "Enum": [],
                        "Nullable": false,
                        "ExternalDocs": null,
                        "Deprecated": false,
                        "Xml": null,
                        "Extensions": {},
                        "UnresolvedReference": false,
                        "Reference": null
                      },
                      "postBox": {
                        "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
                      },
                      "country": {
                        "Title": null,
                        "Type": "string",
                        "Format": null,
                        "Description": "Country the address is in.  It must be a valid ISO2 or ISO3 country code",
                        "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": "GBR"
                        },
                        "Enum": [],
                        "Nullable": false,
                        "ExternalDocs": null,
                        "Deprecated": false,
                        "Xml": null,
                        "Extensions": {},
                        "UnresolvedReference": false,
                        "Reference": null
                      },
                      "superAdministrativeArea": {
                        "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
                      },
                      "administrativeArea": {
                        "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
                      },
                      "subAdministrativeArea": {
                        "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
                      },
                      "organization": {
                        "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": "GB Group"
                        },
                        "Enum": [],
                        "Nullable": false,
                        "ExternalDocs": null,
                        "Deprecated": false,
                        "Xml": null,
                        "Extensions": {},
                        "UnresolvedReference": false,
                        "Reference": null
                      },
                      "quality": {
                        "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": {
                          "avc": {
                            "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
                          },
                          "aqi": {
                            "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
                          }
                        },
                        "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
                      },
                      "location": {
                        "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": {
                          "latitude": {
                            "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
                          },
                          "longitude": {
                            "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
                          },
                          "geoAccuracy": {
                            "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
                          }
                        },
                        "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
                      }
                    },
                    "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
                  }
                },
                "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
              }
            },
            "MaxProperties": null,
            "MinProperties": null,
            "AdditionalPropertiesAllowed": false,
            "AdditionalProperties": null,
            "Discriminator": null,
            "Example": null,
            "Enum": [],
            "Nullable": false,
            "ExternalDocs": null,
            "Deprecated": false,
            "Xml": null,
            "Extensions": {},
            "UnresolvedReference": false,
            "Reference": 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
        },
        "phones": {
          "Title": null,
          "Type": "array",
          "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": {
            "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": {
              "type": {
                "Title": null,
                "Type": "string",
                "Format": null,
                "Description": "Specifies the type of phone this is",
                "Maximum": null,
                "ExclusiveMaximum": null,
                "Minimum": null,
                "ExclusiveMinimum": null,
                "MaxLength": null,
                "MinLength": null,
                "Pattern": null,
                "MultipleOf": null,
                "Default": {
                  "PrimitiveType": 4,
                  "AnyType": 0,
                  "Value": "HOME"
                },
                "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": [
                  {
                    "PrimitiveType": 4,
                    "AnyType": 0,
                    "Value": "HOME"
                  },
                  {
                    "PrimitiveType": 4,
                    "AnyType": 0,
                    "Value": "WORK"
                  },
                  {
                    "PrimitiveType": 4,
                    "AnyType": 0,
                    "Value": "MOBILE"
                  }
                ],
                "Nullable": false,
                "ExternalDocs": null,
                "Deprecated": false,
                "Xml": null,
                "Extensions": {},
                "UnresolvedReference": false,
                "Reference": null
              },
              "number": {
                "Title": null,
                "Type": "string",
                "Format": null,
                "Description": "GBG Global Phone format used across the GBG product and services, Required in international format with +(Country Code)",
                "Maximum": null,
                "ExclusiveMaximum": null,
                "Minimum": null,
                "ExclusiveMinimum": null,
                "MaxLength": null,
                "MinLength": null,
                "Pattern": "^(\\+)(?:\\d\\s?){1,14}$",
                "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": "+44 207 4281250"
                },
                "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
          },
          "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
        }
      },
      "score": 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

    • {
      • 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

    • {
      • 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

    • {
      • 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

    • {
      • 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

    • {
      • 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
      }
    })
    Post /verify/people/v4/{person-id}/documentData/

    Allows the calling system to submit document data and have it verified against a preset list of checks. This call should be used where the person has been given an id from a previous verification step.

    • 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 'document-id: 9d75d86e-f7bc-4d22-a93b-59c04881193f' \
     - H 'triangulation-verification-id: 9d75d85e-f7bc-4d22-a93b-60c04881193d' \
     - H 'Content-Type: application/json' \
    "https://api.gbgplc.com/verify/people/v4/{person-id}/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-id}/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('document-id', '9d75d86e-f7bc-4d22-a93b-59c04881193f');
    xhr.setRequestHeader('triangulation-verification-id', '9d75d85e-f7bc-4d22-a93b-60c04881193d');
    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-id}/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");
    message.Headers.Add("document-id", "9d75d86e-f7bc-4d22-a93b-59c04881193f");
    message.Headers.Add("triangulation-verification-id", "9d75d85e-f7bc-4d22-a93b-60c04881193d");
    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}/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',
        'document-id: 9d75d86e-f7bc-4d22-a93b-59c04881193f',
        'triangulation-verification-id: 9d75d85e-f7bc-4d22-a93b-60c04881193d',
        '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");
    headers.set("document-id", "9d75d86e-f7bc-4d22-a93b-59c04881193f");
    headers.set("triangulation-verification-id", "9d75d85e-f7bc-4d22-a93b-60c04881193d");
    HttpEntity<MultiValueMap<String, String>> request = new HttpEntity<>("", headers);
    String host = "https://api.gbgplc.com/verify/people/v4/{person-id}/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.

    Path Parameters
    Name Description Example

    person-id*

    Required

    Use to identify the verification made against a person


    Type: string
    9d75d85e-f7bc-4d22-a93b-60c04881193d
    Header Parameters
    Name Description Example

    Authorization*

    Required

    A JWT token to allow access


    Type: string

    cleanse-address

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


    Type: boolean
    true

    journey-id*

    Required

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


    Type: string
    9d75d85e-f7bc-4d22-a93b-60c04881193d

    journey-version*

    Required

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


    Type: integer
    1

    customer-reference

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


    Type: string
    9d75d86e-f7bc-4d22-a93b-59c04881193f

    document-id

    Use to link this verification step to a partial document created by an earlier step


    Type: string
    9d75d86e-f7bc-4d22-a93b-59c04881193f

    triangulation-verification-id

    ID of a previous verification step which this input should be compared with. The matching person-id header must be populated to use this option.


    Type: string
    9d75d85e-f7bc-4d22-a93b-60c04881193d

    Request Body

    • {
      One of ->
      • UKDrivingLicence {
        • 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
        • mailSort string
        • microfiche string
        • 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
        • licenceNumber 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
        }
      • 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 Description Example
    verification-id

    The unique key for the verification undertaken. This is the same as the one supplied in the payload


    Type: string
    customer-reference

    The same id as provided by the customer


    Type: string
    • {
      • 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}/response
      • person {
        • 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
        • addresses [
          • address {
            • type string

              specify if this is a current or previous address

              Enum: [CURRENT, PREVIOUS]
            • 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
                }
              }
            • resident {
              • from 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
              • to 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
              }
            • enrichments {
              • cleansed {
                • 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
                  }
                }
              }
            }
          ]
        • phones [
          • phone {
            • type string

              Specifies the type of phone this is

              Enum: [HOME, WORK, MOBILE]
            • number string

              GBG Global Phone format used across the GBG product and services, Required in international format with +(Country Code)

              Pattern: ^(\+)(?:\d\s?){1,14}$ example: +44 207 4281250
            }
          ]
        }
      • score integer

        The cumulative score of all the checks done against this verification as specified by you

      • 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}/response"
      },
      "person": {
        "title": {
          "Title": null,
          "Type": "string",
          "Format": null,
          "Description": "Title of an individual such as Mr, Mrs, Dr, Sir",
          "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": "Mr"
          },
          "Enum": [],
          "Nullable": false,
          "ExternalDocs": null,
          "Deprecated": false,
          "Xml": null,
          "Extensions": {},
          "UnresolvedReference": false,
          "Reference": null
        },
        "firstName": {
          "Title": null,
          "Type": "string",
          "Format": null,
          "Description": "A person's name used by their collegues and friends to address them",
          "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": "David"
          },
          "Enum": [],
          "Nullable": false,
          "ExternalDocs": null,
          "Deprecated": false,
          "Xml": null,
          "Extensions": {},
          "UnresolvedReference": false,
          "Reference": null
        },
        "middlenames": {
          "Title": null,
          "Type": "array",
          "Format": null,
          "Description": "Any other registered names used by the individual, not aliases",
          "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": {
            "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": "James"
            },
            "Enum": [],
            "Nullable": false,
            "ExternalDocs": null,
            "Deprecated": false,
            "Xml": null,
            "Extensions": {},
            "UnresolvedReference": false,
            "Reference": 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
        },
        "lastnames": {
          "Title": null,
          "Type": "array",
          "Format": null,
          "Description": "Any family names for the individual",
          "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": {
            "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": "Jones"
            },
            "Enum": [],
            "Nullable": false,
            "ExternalDocs": null,
            "Deprecated": false,
            "Xml": null,
            "Extensions": {},
            "UnresolvedReference": false,
            "Reference": 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
        },
        "gender": {
          "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": "MALE"
          },
          "Enum": [
            {
              "PrimitiveType": 4,
              "AnyType": 0,
              "Value": "MALE"
            },
            {
              "PrimitiveType": 4,
              "AnyType": 0,
              "Value": "FEMALE"
            },
            {
              "PrimitiveType": 4,
              "AnyType": 0,
              "Value": "UNSPECIFIED"
            }
          ],
          "Nullable": false,
          "ExternalDocs": null,
          "Deprecated": false,
          "Xml": null,
          "Extensions": {},
          "UnresolvedReference": false,
          "Reference": null
        },
        "birthdate": {
          "Title": null,
          "Type": "string",
          "Format": null,
          "Description": "Specified in year, month and day separated by - which conforms to ISO 8601, should be two digit month and day",
          "Maximum": null,
          "ExclusiveMaximum": null,
          "Minimum": null,
          "ExclusiveMinimum": null,
          "MaxLength": null,
          "MinLength": null,
          "Pattern": "^\\d{4}-\\d{2}-\\d{2}$",
          "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": "2000-01-01"
          },
          "Enum": [],
          "Nullable": false,
          "ExternalDocs": null,
          "Deprecated": false,
          "Xml": null,
          "Extensions": {},
          "UnresolvedReference": false,
          "Reference": null
        },
        "addresses": {
          "Title": null,
          "Type": "array",
          "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,
          "Requ