Skip to content

Matchcode360 Global Services REST Services


This service provides an endpoint to Matchcode Global Services via a REST interface.

Authentication

The Matchcode Global services require authentication and authorisation. The authentication is done using an ad hoc web service which is described in the next section.

The authorisation check is done in each call that is made to Matchcode as it depends on the profile and configuration id provided.

Request

The authentication credentials are sent by a GET request. Two parameters must be provided: username and password. Therefore, a request will be as follows:

GET host/idm-core-rest-globalservices/21a/authentication/authenticateUser?username=username@domain&password=userpass

Response

The authentication service response is a JSON object:

{
   "authenticationToken": "BB9E4E51-BA83-4448-B011-3DEF1748E3B1",
   "authenticationTime": 1433151365754,
   "fullUsername": "username@domain",
   "userGuid": "78367064-26A5-404A-8EFA-D4C7F0F4663D",
   "username": "username",
   "domain": "domain",
   "domainType": "ORGANISATION",
   "lastLogin": 1433151229000,
   "sessionExpiryTime": 1433154965754
}

The field authenticationToken will give the guid to be used for the following calls to Matchcode. This token does not change in each web service call and is valid for the current session. The expiry time is updated in each call to any REST Matchcode service. If the expiry time is reached before any new call is made, the token is invalidated and the session terminated. A new authetication request would be needed in order to do any new Matchcode service calls.

The session expiry time is organisation specific and returned as a timestamp.

Execute capture

Once an authentication token has been retrieved it can be used to call one of the Matchcode services.

All the Matchcode Services offered by the SOAP interface can be also requested by this REST interface, by using the ExecuteCapture path.

The Request message to be sent must be JSON. Either case, the message must meet the message structure for every service. JSON examples can be found for every specific Matchcode service.

NOTE that for 15b Service Protocol Version, if "maxReturn" field (within "options" element) is not present in the Request, this field will be defaulted to 75.

NOTE that from 16a Service Protocol Version on, if "maxReturn" field (within "options" element) is not present in the Request, a Bad Request (HTTP code 400) will be returned by the REST Service.

Example Requests

Two extra fields need to be provided as Header Parameters: username and authenticationToken. The query details are sent in the post section as an application/json object:

POST host/idm-core-rest-globalservices/21a/gbg/executeCapture HTTP/1.1
Accept-Encoding: gzip,deflate
username: username@domain
authenticationToken: ED914037-0B03-4CCA-A761-285BBCA2F794
Content-Type: application/json
Content-Length: 356
Host: idmp.gb.co.uk
Connection: Keep-Alive
User-Agent: Apache-HttpClient/4.1.1 (java 1.5)
Global Addressing Request
{
    "customerReference": "Test",
    "profileGuid": "90C3BA3B-491D-4119-B5B6-0B8B624EEFAA",
    "configurationId": "1",
    "requestData": {
      "address": {
        "postCode": "20500",
        "building": "1600",
        "street": "Pennsylvania Avenue",
        "stateRegion":"WASHINGTON DC",
        "countryCode":"USA"
      },
      "options": {
        "offset": "0",
        "maxReturn": "10",
        "addressSearchLevel": "PREMISE",
        "casing": "MIXED"
      }
    }
}
Global Addressing Response

The result of the query is returned in another json object.

{
   "profileHeader":    {
      "profileGuid": "90C3BA3B-491D-4119-B5B6-0B8B624EEFAA",
      "profileName": "Matchcode Global",
      "transactionGuid": "7CA162F9-3D1E-47FA-AD6A-F88CB71E0630",
      "transactionTimeStamp": "2016-02-23T14:06:24.694Z",
      "profileStatus": "SUCCESS"
   },
   "profileResponseDetails": [   {
      "transactionGuid": "74DD5BA3-B4E1-40EF-818D-C981FC374DC2",
      "componentName": "Matchcode International Address Lookup",
      "componentStatus": "SUCCESS",
      "componentAction": "REGISTER",
      "responseType": "CAPTURE",
      "notes": "[]",
      "invoice": {"invoiceList":       [
                  {
            "invoiceGuid": "23B893ED-F8F0-4AD6-A209-4B98818BF6A9",
            "billingInformationGuid": "BF0AF5C8-8186-42CD-BE27-67D49DE6CFDC",
            "billingPoints": 1,
            "dataSetInvoices": [            {
               "dataSetCode": "GLOBAL_ADDRESSING",
               "billingPoints": 1,
               "recordsReturned": 1,
               "dataLicenceGuid": "BF0AF5C8-8186-42CD-BE27-67D49DE6CFDC"
            }]
         },
                  {
            "billingInformationGuid": "8CC899E0-B691-41DC-97DC-AB6326C2761A",
            "billingPoints": 0,
            "dataSetInvoices": []
         }
      ]},
      "captureResponse":       {
         "resultStatus": "SINGLE",
         "recordsReturned": 1,
         "moreData": false,
         "totalRecordCount": 1,
         "totalPages": 1,
         "matchScore": 98,
         "matchLevel": "PREMISE",
         "outputStatus": "CORRECTED",
         "fieldStatus": "55015000",
         "responseCount": 1,
         "response": [         {
            "address": [            {
               "street": "Pennsylvania Ave Nw",
               "town": "Washington",
               "postCode": "20500",
               "buildingNumber": "1600",
               "stateRegion": "Dc",
               "subAdministrativeArea": "District Of Columbia",
               "administrativeArea": "Dc",
               "countryCode": "USA",
               "countryName": "United States",
               "formattedAddress": "1600 Pennsylvania Ave Nw,Washington DC 20500,,,,,",
               "additionalItems": {"item": [               {
                  "key": "DATASOURCE",
                  "value": "GLOBAL_ADDRESSING"
               }]},
               "groupedAdditionalItems": []
            }],
            "groupedRelatedData": []
         }]
      }
   }]
}

Note that the expiry time will be updated, but the new value won't be returned in the response.

UK Address Request

This request shows requestable datasets.

{
  "customerReference": "Test",
  "profileGuid": "A86F1483-822B-4CB8-A683-349F54F4A6C6",
  "configurationId": "1",
  "requestData": {
    "address": { "postCode": "CH4 9GB" },
    "options": {
      "addressEnvelopeFormat": "A4P",
      "offset": "0",
      "maxReturn": "100",
      "addressSearchLevel": "PREMISE",
      "casing": "MIXED"
       
    },
    "additionalData": {
      "item": [
        {
          "key": "MULTI_OCC",
          "value": "yes"
        },
        {
          "key": "MULTI_RES",
          "value": "yes"
        },
        {
          "key": "NOT_YET_BUILT",
          "value": "yes"
        },
        {
          "key": "LOC_INT",
          "value": "yes"
        }
      ]
    }
  }
}
UK Address Response
{
   "profileHeader":    {
      "profileGuid": "A86F1483-822B-4CB8-A683-349F54F4A6C6",
      "profileName": "Matchcode UK Address",
      "transactionGuid": "83174381-4DCF-4EDD-809C-335387AEC531",
      "transactionTimeStamp": 1497962287061,
      "profileStatus": "SUCCESS",
      "remarks": null
   },
   "profileResponseDetails": [   {
      "transactionGuid": "E7B43B83-75D9-4AB5-8731-53C6CCBDAFC6",
      "componentName": "Matchcode Edited Electoral Roll Names",
      "componentStatus": "SUCCESS",
      "componentAction": "REGISTER",
      "responseType": "CAPTURE",
      "notes": "[]",
      "invoice":       {
         "invoiceList":          [
                        {
               "invoiceGuid": "CB343A2E-6535-46B1-8D6B-200984CFD54A",
               "billingInformationGuid": "CCB1C022-BF7C-4C71-B445-710110FA0FC7",
               "dataLicenceDescription": null,
               "billingPoints": 1,
               "creditsUsed": 1,
               "dataSetInvoices": [               {
                  "dataSetCode": "NAMES",
                  "billingPoints": 1,
                  "recordsReturned": 1,
                  "dataLicenceGuid": "CCB1C022-BF7C-4C71-B445-710110FA0FC7"
               }]
            },
                        {
               "invoiceGuid": null,
               "billingInformationGuid": "C7370CEF-5405-43FB-BC39-E3104588685C",
               "dataLicenceDescription": null,
               "billingPoints": 0,
               "creditsUsed": null,
               "dataSetInvoices": []
            },
                        {
               "invoiceGuid": "C025348A-D4CF-4570-BBF6-786510100ADF",
               "billingInformationGuid": "96DE78B6-DED1-4A52-ACD0-20C987275738",
               "dataLicenceDescription": null,
               "billingPoints": 1,
               "creditsUsed": null,
               "dataSetInvoices": [               {
                  "dataSetCode": "MULTI_RES",
                  "billingPoints": 1,
                  "recordsReturned": 1,
                  "dataLicenceGuid": "96DE78B6-DED1-4A52-ACD0-20C987275738"
               }]
            },
                        {
               "invoiceGuid": "45E0A0B7-605E-4386-AEF2-E706D3CE6222",
               "billingInformationGuid": "5FD71487-D4FF-4F49-86B0-4CC77C280AF5",
               "dataLicenceDescription": null,
               "billingPoints": 1,
               "creditsUsed": null,
               "dataSetInvoices": [               {
                  "dataSetCode": "NOT_YET_BUILT",
                  "billingPoints": 1,
                  "recordsReturned": 1,
                  "dataLicenceGuid": "5FD71487-D4FF-4F49-86B0-4CC77C280AF5"
               }]
            },
                        {
               "invoiceGuid": "74EE1366-B1F3-40D8-AE1D-2C197623AA08",
               "billingInformationGuid": "EDDD74CA-9310-43F0-8BBA-63516C6DAFB8",
               "dataLicenceDescription": null,
               "billingPoints": 1,
               "creditsUsed": null,
               "dataSetInvoices": [               {
                  "dataSetCode": "MULTI_OCC",
                  "billingPoints": 1,
                  "recordsReturned": 1,
                  "dataLicenceGuid": "EDDD74CA-9310-43F0-8BBA-63516C6DAFB8"
               }]
            },
                        {
               "invoiceGuid": null,
               "billingInformationGuid": "44DD514B-2998-42ED-B9CD-58C79558776D",
               "dataLicenceDescription": null,
               "billingPoints": 0,
               "creditsUsed": null,
               "dataSetInvoices": []
            },
                        {
               "invoiceGuid": "D81D8A2E-7537-43A4-B0CB-5B97E6917F4C",
               "billingInformationGuid": "F64C8CB0-7546-42A0-A62A-9A65B1EBB6EB",
               "dataLicenceDescription": null,
               "billingPoints": 1,
               "creditsUsed": null,
               "dataSetInvoices": [               {
                  "dataSetCode": "LOC_INT",
                  "billingPoints": 1,
                  "recordsReturned": 1,
                  "dataLicenceGuid": "F64C8CB0-7546-42A0-A62A-9A65B1EBB6EB"
               }]
            },
                        {
               "invoiceGuid": null,
               "billingInformationGuid": "9E0CA920-DF0D-4AA2-A009-B051EADEE7E3",
               "dataLicenceDescription": null,
               "billingPoints": 0,
               "creditsUsed": null,
               "dataSetInvoices": []
            },
                        {
               "invoiceGuid": null,
               "billingInformationGuid": "7BECF680-1A4C-49EB-AEE0-1C5DF541AE8F",
               "dataLicenceDescription": null,
               "billingPoints": 0,
               "creditsUsed": null,
               "dataSetInvoices": []
            }
         ],
         "tmp": null
      },
      "captureResponse":       {
         "resultStatus": "SINGLE",
         "resultStatusDetail": null,
         "recordsReturned": 1,
         "moreData": false,
         "totalRecordCount": 1,
         "totalPages": 1,
         "matchScore": 0,
         "matchLevel": "NA",
         "outputStatus": "NOTMATCHED",
         "fieldStatus": "55555555",
         "responseCount": 1,
         "response": [         {
            "input": null,
            "address": [            {
               "organisation": "Gb Group Plc",
               "street": "Herons Way",
               "town": "CHESTER",
               "postCode": "CH4 9GB",
               "locality": "Chester Business Park",
               "addPoint": null,
               "department": null,
               "subBuilding": null,
               "buildingNumber": null,
               "buildingName": "The Foundation",
               "buildingGroup": null,
               "poBox": null,
               "subStreet": null,
               "subLocality": null,
               "stateRegion": "Cheshire",
               "subAdministrativeArea": null,
               "administrativeArea": null,
               "superAdministrativeArea": null,
               "countryCode": "GBR",
               "countryName": null,
               "dpsZipPlus": "1AR",
               "formattedAddress": "Gb Group Plc,The Foundation,Herons Way Chester Business Park,Chester Cheshire,CH4 9GB",
               "geographicInformation":                {
                  "easting": "340009",
                  "northing": "363191",
                  "latitude": "53.1624456651",
                  "longitude": "-2.8987260320",
                  "status": null,
                  "level": null,
                  "distance": null,
                  "radius": null
               },
               "additionalItems":                {
                  "item": [                  {
                     "key": "DATASOURCE",
                     "value": "NAMES"
                  }],
                  "tmp": null
               },
               "groupedAdditionalItems": [               {
                  "name": "LocationIntelligence",
                  "item":                   [
                                          {
                        "key": "ADULTOCC",
                        "value": "2"
                     },
                                          {
                        "key": "ADULTOCCC",
                        "value": "0.8"
                     },
                                          {
                        "key": "ADULTOCCS",
                        "value": "0"
                     },
                                          {
                        "key": "BATHROOMS",
                        "value": "1"
                     },
                                          {
                        "key": "BATHROOMSC",
                        "value": "0.73"
                     },
                                          {
                        "key": "BATHROOMSS",
                        "value": "0"
                     },
                                          {
                        "key": "BEDROOMS",
                        "value": "3"
                     },
                                          {
                        "key": "BEDROOMSC",
                        "value": "0.63"
                     },
                                          {
                        "key": "BEDROOMSS",
                        "value": "19"
                     },
                                          {
                        "key": "BHEIGHT",
                        "value": "11.47"
                     },
                                          {
                        "key": "BHEIGHTC",
                        "value": "0.95"
                     },
                                          {
                        "key": "BHEIGHTS",
                        "value": "7"
                     },
                                          {
                        "key": "BUS_USAGE",
                        "value": "1"
                     },
                                          {
                        "key": "BUS_USAGEC",
                        "value": "0.95"
                     },
                                          {
                        "key": "BUS_USAGES",
                        "value": "16"
                     },
                                          {
                        "key": "CADASTRAL",
                        "value": "10899.8"
                     },
                                          {
                        "key": "CADASTRALC",
                        "value": "0.95"
                     },
                                          {
                        "key": "CADASTRALS",
                        "value": "2"
                     },
                                          {
                        "key": "ESTCTAX",
                        "value": "4"
                     },
                                          {
                        "key": "ESTCTAXBAND",
                        "value": "E"
                     },
                                          {
                        "key": "ESTCTAXC",
                        "value": "0.25"
                     },
                                          {
                        "key": "ESTCTAXS",
                        "value": "20"
                     },
                                          {
                        "key": "ESTVAL",
                        "value": "0"
                     },
                                          {
                        "key": "ESTVALC",
                        "value": "0"
                     },
                                          {
                        "key": "ESTVALS",
                        "value": "0"
                     },
                                          {
                        "key": "FLOORS",
                        "value": "2"
                     },
                                          {
                        "key": "FLOORSC",
                        "value": "0.92"
                     },
                                          {
                        "key": "FLOORSS",
                        "value": "7"
                     },
                                          {
                        "key": "FOOTPRINT",
                        "value": "1972.0"
                     },
                                          {
                        "key": "FOOTPRINTC",
                        "value": "0.95"
                     },
                                          {
                        "key": "FOOTPRINTS",
                        "value": "25"
                     },
                                          {
                        "key": "LASTDATE",
                        "value": "1900-01-01"
                     },
                                          {
                        "key": "LASTDATEC",
                        "value": "0"
                     },
                                          {
                        "key": "LASTDATES",
                        "value": "0"
                     },
                                          {
                        "key": "LASTPRICE",
                        "value": "0"
                     },
                                          {
                        "key": "LASTPRICEC",
                        "value": "0"
                     },
                                          {
                        "key": "LASTPRICES",
                        "value": "0"
                     },
                                          {
                        "key": "LISTED",
                        "value": "No"
                     },
                                          {
                        "key": "LISTEDC",
                        "value": "0.95"
                     },
                                          {
                        "key": "LISTEDS",
                        "value": "3"
                     },
                                          {
                        "key": "LSOA11",
                        "value": "E01018335"
                     },
                                          {
                        "key": "MAXOCCS",
                        "value": "2"
                     },
                                          {
                        "key": "MAXOCCSC",
                        "value": "0.8"
                     },
                                          {
                        "key": "MAXOCCSS",
                        "value": "0"
                     },
                                          {
                        "key": "OA11",
                        "value": "E00092477"
                     },
                                          {
                        "key": "OUTDR_AREA",
                        "value": "8927.8"
                     },
                                          {
                        "key": "OUTDR_AREAC",
                        "value": "0.95"
                     },
                                          {
                        "key": "OUTDR_AREAS",
                        "value": "25"
                     },
                                          {
                        "key": "PROPAGE",
                        "value": "5"
                     },
                                          {
                        "key": "PROPAGEC",
                        "value": "0.51"
                     },
                                          {
                        "key": "PROPAGED",
                        "value": "1980 to date (Modern)"
                     },
                                          {
                        "key": "PROPAGES",
                        "value": "15"
                     },
                                          {
                        "key": "PROPTYPE",
                        "value": "0"
                     },
                                          {
                        "key": "PROPTYPEC",
                        "value": "0.8"
                     },
                                          {
                        "key": "PROPTYPED",
                        "value": "Detached"
                     },
                                          {
                        "key": "PROPTYPES",
                        "value": "16"
                     },
                                          {
                        "key": "ROOMS",
                        "value": "4"
                     },
                                          {
                        "key": "ROOMSC",
                        "value": "0.76"
                     },
                                          {
                        "key": "ROOMSS",
                        "value": "14"
                     },
                                          {
                        "key": "WAT200",
                        "value": "No"
                     },
                                          {
                        "key": "WAT200C",
                        "value": "0.95"
                     },
                                          {
                        "key": "WAT200S",
                        "value": "21"
                     },
                                          {
                        "key": "YEAR_BUILT",
                        "value": "0"
                     },
                                          {
                        "key": "YEAR_BUILTC",
                        "value": "0"
                     },
                                          {
                        "key": "YEAR_BUILTS",
                        "value": "0"
                     }
                  ],
                  "tmp": null
               }],
               "persons": null,
               "uprn": null,
               "lpi": null,
               "blpu": null,
               "streetDescriptor": null,
               "streetInformation": null,
               "companyInformation": null,
               "classification": null,
               "osAl2Toid": null,
               "osItnToid": null,
               "osTopoToid": null,
               "voaCtRecord": null,
               "voaNdrRecord": null,
               "apOSAPR": null,
               "rmUDPRN": 4624695,
               "utilitiesInformation": null
            }],
            "relatedData": null,
            "groupedRelatedData": []
         }]
      },
      "validateResponse": null,
      "verifyResponse": null,
      "traceResponse": null
   }]
}
Multidatabase Request

Reverse lookup on UDPRN restricting fields returned to Location Intelligence BEDROOMS,BATHROOMS and FLOORS and requesting punctuation/hyphenation

{
   "customerReference":"Test",
   "profileGuid":"C7547A80-79C9-4D43-9681-01098B045E9C",
   "configurationId":"1",
   "requestData":{
      "address":{
         "additionalItems":{
            "item":[
               {
                  "key":"UDPRN",
                  "value":"04624695"
               }
            ]
         }
      },
      "options":{
         "relatedDataItems":{
            "key":[
               "BEDROOMS",
               "BATHROOMS",
               "FLOORS"
            ]
         },
         "offset":"0",
         "maxReturn":"100",
         "addressSearchLevel":"PREMISE",
         "casing":"MIXED",
         "additionalItems":{
            "item":[
               {
                  "key":"PUNCTUATION",
                  "value":"yes"
               },
               {
                  "key":"HYPHENATION",
                  "value":"yes"
               }
            ]
         }
      },
      "additionalData":{
         "item":[
            {
               "key":"ABP",
               "value":"yes"
            },
            {
               "key":"LOC_INT",
               "value":"yes"
            },
            {
               "key":"PREMISE_GEOCODE",
               "value":"yes"
            },
            {
               "key":"POINTER",
               "value":"yes"
            },
            {
               "key":"MULTI_OCC",
               "value":"yes"
            },
            {
               "key":"MULTI_RES",
               "value":"yes"
            },
            {
               "key":"NOT_YET_BUILT",
               "value":"yes"
            },
            {
               "key":"BUSINESS_DATA_V2",
               "value":"yes"
            },
            {
               "key":"PAF",
               "value":"yes"
            }
         ]
      }
   }
}
Multidatabase Response
{
   "profileHeader":    {
      "profileGuid": "C7547A80-79C9-4D43-9681-01098B045E9C",
      "profileName": "MultiDatabase",
      "transactionGuid": "5EB41CC9-5EDA-4D11-8DBC-D547FFE4D3B2",
      "transactionTimeStamp": 1497970598451,
      "profileStatus": "SUCCESS",
      "remarks": null
   },
   "profileResponseDetails": [   {
      "transactionGuid": "AD5A0982-F44A-4AAA-A049-A1F213C4C589",
      "componentName": "MultiDatabase Data",
      "componentStatus": "SUCCESS",
      "componentAction": "VERIFY",
      "responseType": "CAPTURE",
      "notes": "[]",
      "invoice":       {
         "invoiceList":          [
                        {
               "invoiceGuid": "3B134920-4A58-4A68-B36A-9A1357A7EA9E",
               "billingInformationGuid": "9880A2A3-5C78-4F48-AE92-1F7630278D46",
               "dataLicenceDescription": null,
               "billingPoints": 1,
               "creditsUsed": 1,
               "dataSetInvoices": [               {
                  "dataSetCode": "NOT_YET_BUILT",
                  "billingPoints": 1,
                  "recordsReturned": 2,
                  "dataLicenceGuid": "9880A2A3-5C78-4F48-AE92-1F7630278D46"
               }]
            },
                        {
               "invoiceGuid": "BF601F49-B0F9-4671-AB4B-353B23E77E2F",
               "billingInformationGuid": "8CAE5178-5BC4-4A1A-9CCE-218D0FA4CEE9",
               "dataLicenceDescription": null,
               "billingPoints": 1,
               "creditsUsed": 1,
               "dataSetInvoices": [               {
                  "dataSetCode": "PAF",
                  "billingPoints": 1,
                  "recordsReturned": 2,
                  "dataLicenceGuid": "8CAE5178-5BC4-4A1A-9CCE-218D0FA4CEE9"
               }]
            },
                        {
               "invoiceGuid": "DBAAC661-D396-4826-8D3D-E20F977A711D",
               "billingInformationGuid": "901608DD-B7BF-4FF6-8E77-F282B483747B",
               "dataLicenceDescription": null,
               "billingPoints": 1,
               "creditsUsed": 1,
               "dataSetInvoices": [               {
                  "dataSetCode": "MULTI_OCC",
                  "billingPoints": 1,
                  "recordsReturned": 2,
                  "dataLicenceGuid": "901608DD-B7BF-4FF6-8E77-F282B483747B"
               }]
            },
                        {
               "invoiceGuid": "BE765943-B117-41E4-851E-133777BD4A49",
               "billingInformationGuid": "05B49AAE-80FA-4428-A8F2-18DCB152AEAA",
               "dataLicenceDescription": null,
               "billingPoints": 1,
               "creditsUsed": 1,
               "dataSetInvoices": [               {
                  "dataSetCode": "MULTI_RES",
                  "billingPoints": 1,
                  "recordsReturned": 2,
                  "dataLicenceGuid": "05B49AAE-80FA-4428-A8F2-18DCB152AEAA"
               }]
            },
                        {
               "invoiceGuid": "C3605BC6-589F-46D2-A1A3-8C804BA24059",
               "billingInformationGuid": "91FE3471-092F-4C62-9D74-BC646D1DCDE1",
               "dataLicenceDescription": null,
               "billingPoints": 1,
               "creditsUsed": 1,
               "dataSetInvoices": [               {
                  "dataSetCode": "ABP",
                  "billingPoints": 1,
                  "recordsReturned": 2,
                  "dataLicenceGuid": "91FE3471-092F-4C62-9D74-BC646D1DCDE1"
               }]
            },
                        {
               "invoiceGuid": "28E9439B-1806-4213-8A05-FBA62D333B7C",
               "billingInformationGuid": "868DD1F0-D014-4EB5-832D-37CC3715F32C",
               "dataLicenceDescription": null,
               "billingPoints": 1,
               "creditsUsed": 1,
               "dataSetInvoices": [               {
                  "dataSetCode": "LOC_INT",
                  "billingPoints": 1,
                  "recordsReturned": 2,
                  "dataLicenceGuid": "868DD1F0-D014-4EB5-832D-37CC3715F32C"
               }]
            },
                        {
               "invoiceGuid": "0CF2B473-C897-4547-B5C3-7CFC8E57C02F",
               "billingInformationGuid": "A916450D-9BDB-480E-93FB-FB44E3334B48",
               "dataLicenceDescription": null,
               "billingPoints": 1,
               "creditsUsed": 1,
               "dataSetInvoices": [               {
                  "dataSetCode": "POINTER",
                  "billingPoints": 1,
                  "recordsReturned": 2,
                  "dataLicenceGuid": "A916450D-9BDB-480E-93FB-FB44E3334B48"
               }]
            },
                        {
               "invoiceGuid": "5BD50A02-FF5B-4199-BA17-0606555E622B",
               "billingInformationGuid": "21C213F0-401B-4177-8D0C-D129B0D1254A",
               "dataLicenceDescription": null,
               "billingPoints": 1,
               "creditsUsed": 1,
               "dataSetInvoices": [               {
                  "dataSetCode": "BUSINESS_DATA_V2",
                  "billingPoints": 1,
                  "recordsReturned": 2,
                  "dataLicenceGuid": "21C213F0-401B-4177-8D0C-D129B0D1254A"
               }]
            },
                        {
               "invoiceGuid": "86CE06C1-48F7-4F7F-B966-2B24413170FD",
               "billingInformationGuid": "F6FFA5D7-8D7D-44C1-854B-703E34C1764A",
               "dataLicenceDescription": null,
               "billingPoints": 1,
               "creditsUsed": 1,
               "dataSetInvoices": [               {
                  "dataSetCode": "PREMISE_GEOCODE",
                  "billingPoints": 1,
                  "recordsReturned": 2,
                  "dataLicenceGuid": "F6FFA5D7-8D7D-44C1-854B-703E34C1764A"
               }]
            },
                        {
               "invoiceGuid": null,
               "billingInformationGuid": "A3A49222-6099-4A65-9174-483C0A31A731",
               "dataLicenceDescription": null,
               "billingPoints": 0,
               "creditsUsed": null,
               "dataSetInvoices": []
            },
                        {
               "invoiceGuid": null,
               "billingInformationGuid": "10813835-FD7B-4F4A-A37C-E28AD4B6F5A4",
               "dataLicenceDescription": null,
               "billingPoints": 0,
               "creditsUsed": null,
               "dataSetInvoices": []
            },
                        {
               "invoiceGuid": null,
               "billingInformationGuid": "9275B262-0ACF-4C30-9B94-9EBDB939A8B9",
               "dataLicenceDescription": null,
               "billingPoints": 0,
               "creditsUsed": null,
               "dataSetInvoices": []
            }
         ],
         "tmp": null
      },
      "captureResponse":       {
         "resultStatus": "MULTIPLE",
         "resultStatusDetail": null,
         "recordsReturned": 2,
         "moreData": false,
         "totalRecordCount": 2,
         "totalPages": 1,
         "matchScore": 0,
         "matchLevel": "NA",
         "outputStatus": "NOTMATCHED",
         "fieldStatus": "55555555",
         "responseCount": 1,
         "response": [         {
            "input": null,
            "address":             [
                              {
                  "organisation": null,
                  "street": "Kingsfield Court",
                  "town": "CHESTER",
                  "postCode": "CH4 9GB",
                  "locality": "Eccleston",
                  "addPoint": null,
                  "department": null,
                  "subBuilding": null,
                  "buildingNumber": null,
                  "buildingName": "Edward House",
                  "buildingGroup": null,
                  "poBox": null,
                  "subStreet": null,
                  "subLocality": null,
                  "stateRegion": "Cheshire",
                  "subAdministrativeArea": null,
                  "administrativeArea": null,
                  "superAdministrativeArea": null,
                  "countryCode": null,
                  "countryName": null,
                  "dpsZipPlus": "9ZI",
                  "formattedAddress": "Edward House,Kingsfield Court,Eccleston,CHESTER,Cheshire,CH4 9GB",
                  "geographicInformation":                   {
                     "easting": null,
                     "northing": null,
                     "latitude": null,
                     "longitude": null,
                     "status": null,
                     "level": null,
                     "distance": null,
                     "radius": null
                  },
                  "additionalItems":                   {
                     "item":                      [
                                                {
                           "key": "GBGURN_1",
                           "value": "ABP,19318037,00000000"
                        },
                                                {
                           "key": "ADDRESSSOURCE",
                           "value": "ABP"
                        },
                                                {
                           "key": "DATASOURCE",
                           "value": "MULTIDATABASE_GENERIC"
                        }
                     ],
                     "tmp": null
                  },
                  "groupedAdditionalItems": [                  {
                     "name": "LocationIntelligence",
                     "item":                      [
                                                {
                           "key": "BATHROOMS",
                           "value": "1"
                        },
                                                {
                           "key": "BEDROOMS",
                           "value": "3"
                        },
                                                {
                           "key": "FLOORS",
                           "value": "2"
                        }
                     ],
                     "tmp": null
                  }],
                  "persons": null,
                  "uprn": null,
                  "lpi":                   {
                     "lpiKey": null,
                     "lpiLanguage": null,
                     "lpiLogicalStatus": null,
                     "lpiStartDate": null,
                     "lpiEndDate": null,
                     "lpiLastUpdateDate": null,
                     "lpiEntryDate": null,
                     "saoStartNumber": null,
                     "saoStartSuffix": null,
                     "saoEndNumber": null,
                     "saoEndSuffix": null,
                     "saoText": null,
                     "paoStartNumber": null,
                     "paoStartSuffix": null,
                     "paoEndNumber": null,
                     "paoEndSuffix": null,
                     "paoText": null,
                     "usrn": null,
                     "usrnMatchIndicator": null,
                     "areaName": null,
                     "level": null,
                     "officialFlag": null
                  },
                  "blpu":                   {
                     "blpuLogicalStatus": null,
                     "blpuState": null,
                     "blpuStateDate": null,
                     "parentUprn": null,
                     "easting": null,
                     "northing": null,
                     "rpc": null,
                     "localCustodianCode": null,
                     "blpuStartDate": null,
                     "blpuEndDate": null,
                     "blpuLastUpdateDate": null,
                     "blpuEntryDate": null,
                     "postalAddressable": null,
                     "postcodeLocator": "CH4 9GB",
                     "multiOccCount": null
                  },
                  "streetDescriptor":                   {
                     "streetDescription": null,
                     "locality": null,
                     "townName": null,
                     "administrativeArea": null,
                     "streetLanguage": null
                  },
                  "streetInformation":                   {
                     "streetType": null,
                     "swaOrgRefNaming": null,
                     "streetState": null,
                     "stateDate": null,
                     "streetSurface": null,
                     "streetClassification": null,
                     "streetVersion": null,
                     "streetLastUpdateDate": null,
                     "streetEntryDate": null,
                     "streetStartDate": null,
                     "streetEndDate": null,
                     "streetStartEasting": null,
                     "streetStartNorthing": null,
                     "streetEndEasting": null,
                     "streetEndNorthing": null,
                     "streetTolerance": null
                  },
                  "companyInformation":                   {
                     "organisationName": null,
                     "legalOrganisationLegalName": null,
                     "organisationStartDate": null,
                     "organisationEndDate": null,
                     "organisationLastUpdateDate": null,
                     "organisationEntryDate": null
                  },
                  "classification":                   {
                     "classKey": null,
                     "classificationCode": null,
                     "classScheme": null,
                     "classStartDate": null,
                     "classEndDate": null,
                     "classLastUpdateDate": null,
                     "entryDate": null
                  },
                  "osAl2Toid": null,
                  "osItnToid": null,
                  "osTopoToid": null,
                  "voaCtRecord": null,
                  "voaNdrRecord": null,
                  "apOSAPR": null,
                  "rmUDPRN": null,
                  "utilitiesInformation": null
               },
                              {
                  "organisation": null,
                  "street": "Kingsfield Court",
                  "town": "CHESTER",
                  "postCode": "CH4 9GB",
                  "locality": "Eccleston",
                  "addPoint": null,
                  "department": null,
                  "subBuilding": null,
                  "buildingNumber": null,
                  "buildingName": "Nextgear House",
                  "buildingGroup": null,
                  "poBox": null,
                  "subStreet": null,
                  "subLocality": null,
                  "stateRegion": "Cheshire",
                  "subAdministrativeArea": null,
                  "administrativeArea": null,
                  "superAdministrativeArea": null,
                  "countryCode": null,
                  "countryName": null,
                  "dpsZipPlus": "9ZI",
                  "formattedAddress": "Nextgear House,Kingsfield Court,Eccleston,CHESTER,Cheshire,CH4 9GB",
                  "geographicInformation":                   {
                     "easting": null,
                     "northing": null,
                     "latitude": null,
                     "longitude": null,
                     "status": null,
                     "level": null,
                     "distance": null,
                     "radius": null
                  },
                  "additionalItems":                   {
                     "item":                      [
                                                {
                           "key": "GBGURN_1",
                           "value": "ABP,19318038,00000000"
                        },
                                                {
                           "key": "ADDRESSSOURCE",
                           "value": "ABP"
                        },
                                                {
                           "key": "DATASOURCE",
                           "value": "MULTIDATABASE_GENERIC"
                        }
                     ],
                     "tmp": null
                  },
                  "groupedAdditionalItems": [                  {
                     "name": "LocationIntelligence",
                     "item":                      [
                                                {
                           "key": "BATHROOMS",
                           "value": "1"
                        },
                                                {
                           "key": "BEDROOMS",
                           "value": "3"
                        },
                                                {
                           "key": "FLOORS",
                           "value": "2"
                        }
                     ],
                     "tmp": null
                  }],
                  "persons": null,
                  "uprn": null,
                  "lpi":                   {
                     "lpiKey": null,
                     "lpiLanguage": null,
                     "lpiLogicalStatus": null,
                     "lpiStartDate": null,
                     "lpiEndDate": null,
                     "lpiLastUpdateDate": null,
                     "lpiEntryDate": null,
                     "saoStartNumber": null,
                     "saoStartSuffix": null,
                     "saoEndNumber": null,
                     "saoEndSuffix": null,
                     "saoText": null,
                     "paoStartNumber": null,
                     "paoStartSuffix": null,
                     "paoEndNumber": null,
                     "paoEndSuffix": null,
                     "paoText": null,
                     "usrn": null,
                     "usrnMatchIndicator": null,
                     "areaName": null,
                     "level": null,
                     "officialFlag": null
                  },
                  "blpu":                   {
                     "blpuLogicalStatus": null,
                     "blpuState": null,
                     "blpuStateDate": null,
                     "parentUprn": null,
                     "easting": null,
                     "northing": null,
                     "rpc": null,
                     "localCustodianCode": null,
                     "blpuStartDate": null,
                     "blpuEndDate": null,
                     "blpuLastUpdateDate": null,
                     "blpuEntryDate": null,
                     "postalAddressable": null,
                     "postcodeLocator": "CH4 9GB",
                     "multiOccCount": null
                  },
                  "streetDescriptor":                   {
                     "streetDescription": null,
                     "locality": null,
                     "townName": null,
                     "administrativeArea": null,
                     "streetLanguage": null
                  },
                  "streetInformation":                   {
                     "streetType": null,
                     "swaOrgRefNaming": null,
                     "streetState": null,
                     "stateDate": null,
                     "streetSurface": null,
                     "streetClassification": null,
                     "streetVersion": null,
                     "streetLastUpdateDate": null,
                     "streetEntryDate": null,
                     "streetStartDate": null,
                     "streetEndDate": null,
                     "streetStartEasting": null,
                     "streetStartNorthing": null,
                     "streetEndEasting": null,
                     "streetEndNorthing": null,
                     "streetTolerance": null
                  },
                  "companyInformation":                   {
                     "organisationName": null,
                     "legalOrganisationLegalName": null,
                     "organisationStartDate": null,
                     "organisationEndDate": null,
                     "organisationLastUpdateDate": null,
                     "organisationEntryDate": null
                  },
                  "classification":                   {
                     "classKey": null,
                     "classificationCode": null,
                     "classScheme": null,
                     "classStartDate": null,
                     "classEndDate": null,
                     "classLastUpdateDate": null,
                     "entryDate": null
                  },
                  "osAl2Toid": null,
                  "osItnToid": null,
                  "osTopoToid": null,
                  "voaCtRecord": null,
                  "voaNdrRecord": null,
                  "apOSAPR": null,
                  "rmUDPRN": null,
                  "utilitiesInformation": null
               }
            ],
            "relatedData": null,
            "groupedRelatedData": []
         }]
      },
      "validateResponse": null,
      "verifyResponse": null,
      "traceResponse": null
   }]
}

Get started for free today

  • No credit card required
  • Cancel any time
  • 24/5 support
Get started