- 33m+ records
- Unique Property Reference Number (UPRN) - which remains constant for the entire lifecycle of all buildings in the UK
- Geocodes accurate to 1m
About This Guide
This guide explains how to access GBGroup’s web service products using their Identity Management Platform (IdM), available via SOAP web services. The document provides a general description of the available functionality along with a definition of the corresponding interfaces used to access different datasets and services. The fundamentals of integrating with the service are described here: Integration Fundamentals Section 2 of the document gives product specific details regarding the use of the Matchcode AddressBase Core Web Service products via IdM. The Matchcode AddressBase Core service provides access to the AddressBase Core data, in a similar manner to Matchcode UK Address searching (see Matchcode UK Address Integration Guide ). The Matchcode AddressBase Core web service products are available via the Identity Management ExecuteCapture web service method. Please note: Wherever (LatestWSDLVersion) is shown in Example Code below, please replace this with GlobalServices21a.wsdl.Input Format
The ExecuteCapture method takes in a ExecuteCaptureRequest data structure, which contains all the information neccessary to carry out the request. Type: ExecuteCaptureRequest| Field Name | Type | Description |
|---|---|---|
| securityHeader | SecurityHeader | The username and authentication token used to access the system. |
| profileRequest | ProfileRequestCapture | Details of the request |
| Profile | GUID |
|---|---|
| AddressBase Core | BCB96C1A-BC4C-4110-8A9E-A097B55380BB |
Search Criteria
The address search criteria should be entered into the IdmDataSearchAddress data structure, which is located within the input details as follows: ExecuteCapture → ProfileRequestCapture → ProfileRequestCaptureData → addressAlternative Search Criteria
Along with the standard address search criteria, this service supports address searching by one of the address identifiers listed below. This search criteria is specified by using the additionalItems property of the search address. To carry out a search with one of these identifiers, a key-value pair must be included in the additional items property, with the key being the identifier and the value being the search value. Only one identifier can be used in a search, if more than one are specified the others will be ignored. This alternative search criteria overrides the standard address search criteria, which will be ignored if a valid identifier is provided in the IDM request.| Key | Description |
|---|---|
| UPRN | Unique property reference number |
| USRN | Unique Street Reference Number |
| UDPRN | Royal Mail unique delivery point reference number |
| PARENT_UPRN | Parent Unique property reference number |
| OS_ADDRESS_TOID | OS Address Toid |
Additional Request Options
The additional search options, used for configuring options such as casing or transliteration of output results, can be set in the IdmRequestOptions structure located in the ProfileRequestCaptureData.options property.Additional Return Data
Additional data can be returned, or excluded from being returned, for each address by providing one or more values in the IdmRequestOption.relatedDataItems property. For each value provided, the corresponding additional data is returned, and the corresponding additional data for all the values not provided, are not returned. The following values are supported by this service.| Key Mnemonic | Description | Returned By Default? |
|---|---|---|
| COUNTRYCODE | Country code | Yes |
| UPRN | Unique property reference number from Ordnance Survey | Yes |
| UDPRN | Royal Mail Unique Delivery Point Reference Number from Royal Mail PAF or Not-Yet-Built file | Yes |
| USRN | Unique Street Reference Number | Yes |
| PARENT_UPRN | Parent UPRN. | Yes |
| X_COORDINATE | Easting | Yes |
| Y_COORDINATE | Northing | Yes |
| OS_LATITUDE | Easting | Yes |
| OS_LONGITUDE | Northing | Yes |
| OS_ADDRESS_TOID | OS Address Toid | Yes |
| RPC | Representative Point Code | Yes |
| OS_COUNTRY | OS Country Code | Yes |
| OS_CLASS | OS Class | Yes |
| LAST_UPDATE_DATE | Last Update Date | Yes |
| TOWN_NAME | Town Name | Yes |
| PO_BOX | PO Box | Yes |
| GSS_CODE | ONS GSS Code | Yes |
| ISLAND | Island | Yes |
Request Additional Datasets
Data from additional datasets can be enabled or disabled for an address search, by populating the ProfileRequestCaptureData.additionalData property with key-value pairs from the applicable list table below. To use a particular dataset, the user must be subscribed to the dataset. This information should be entered into the IdmDataArrayAdditionalData data structure, which is located within the input details as follows: ExecuteCapture → ProfileRequestCapture → ProfileRequestCaptureData → additionalData| Key | Possible Values | Description |
|---|---|---|
| LOC_INT | ”Yes” or “No” | Request Property Intelligence information to be returned |
| PREMISE_GEOCODE | ”Yes” or “No” | Request Premise Level Geocode information to be returned |
| CONGESTION_ZONES | ”Yes” or “No” | Request Congestion Zone information to be returned |
| RED_ROUTE | ”Yes” or “No” | Request Red Route information to be returned |