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