Skip to main content
This guide explains how to access GBGroup’s MatchCode 360 MultiDatabase web service product using the Identity Management Platform (IdM), available via SOAP web services. The fundamentals of integrating with the service are described here: Integration Fundamentals Please note: Wherever (LatestWSDLVersion) is shown in Example Code below, please replace this with GlobalServices21a.wsdl.

Matchcode MultiDatabase Web Service Product Information

Matchcode360 MultiDatabase is a tailored address management solution from GBG plc providing you with the ability to access industry-standard address sources from a number of suppliers such as Ordnance Survey, Royal Mail and Business Data Matchcode360 MultiDatabase has been configured in a way to provide you with access to the most complete database of the UK property stock from multiple address sources through a single lookup service. The address-reference data underpinning Matchcode360 MultiDatabase is thus presented as a single ‘consolidated’ database giving you a single logical view of a number of disparate data sources that have been matched and keyed together in a way to allow fast and flexible searching. These sources are as follows:-
  • Royal Mail PAF data (PAF)
  • Royal Mail Not Yet Built data (NYB)
  • Royal Mail Multi-Residence data (MRS)
  • OS AddressBase Premium data (ABP)
  • OS AddressBase Core data (ABC)
  • GEO+ data (GEOPLUS)
  • OSNI Pointer data (PNT)
  • Business File (BUSINESS_DATA_V2)
The WebService is set-up in such a way that various combinations of these data sets can be used however we advise the following:
  • At least one of PAF, ABC, ABP or GEOPLUS should be enabled
  • Only one of ABP or ABC should be enabled
If this is not the case, then please contact your Account Manager or the Onboarding team (Customer.Care@gbgplc.com) The Matchcode MultiDatabase web service products are available via the Identity Management ExecuteCapture web service method.

Input Format

The ExecuteCapture method takes in a ExecuteCaptureRequest data structure, which contains all the information neccessary to carry out the request. Type: ExecuteCaptureRequest The SecurityHeader structure holds security data to access products and services in the IdM Platform. The ProfileRequestCapture structure contains the criteria to identify the target product being called and the search data for the product request. Within the profileRequest element, the profileGuid element should contain the GUID value listed below:

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 → address

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

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. Using this feature to reduce the amount of data request can often speed up searches. An example usage of this would be to perform an initial search which only requests certain keys be returned (e.g. UPRN), and then after selecting a record or records of interest perform a second lookup on the UPRN which returns more detailed information. For each value provided, the corresponding additional data is returned, and the corresponding additional data for all the values not provided, are not returned. If no values are provided, then the data marked as returned by default below, is returned. The following values are supported by this service.

Additional Request 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 Each dataset, when enabled, supports a set of values which can be used in the related data items property of the request options, these values are listed below.

PAF

AddressBase Premium

AddressBase Core

Geo+

Multi Occupancy

Multiple Residency

Not Yet Built

Business Data

Pointer

Location Intelligence

The Location Intelligence Dataset is detailed here.

Premise Level Geocodes

The Premise Level Geocodes dataset is detailed here.

Congestion Zone

The Congestion Zone dataset is detailed here.

Red Route

The Red Route dataset is detailed here.

Address Filters

Addresses which have been found by the web service, which match a particular kind of address, can be filtered out from the search results by using the address filters functionality described here.

Output Format

The results of the Matchcode Names web service search are returned in a ProfileResponseDetails structure with a ProfileResponseDetail.responseType of ‘CAPTURE’. The ProfileResponseDetails structure contains a single CaptureResponse data structure which holds an array of IdmDataAddress records containing the returned address data. ExecuteCaptureResponse > ProfileResponse [0] > ProfileResponseDetails [0] > CaptureResponse > CaptureResponseData > IdmDataAddress [n] Additional data from a search may be returned in the additionalItems or the groupedAdditionalItems of the IdmDataAddress.

Address Source

The fields which are populated in the response data will depend on the source of the data for that record. This source information is returned in the ADDRESSSOURCE item in the additional items of the response. The possible values for this is given below. Further details on each of the data sources can be found via the links below.

Geographic Data

The geographic data which is returned will depend on the source of the data for that record. The easting and northing data may be come from either the AddressBase Premium, OSNI Pointer or PAF data sources, which may have different levels of accuracy. The web service will return the best, most accurate, values for the record, with precedence between the choices being the above order.

Output Fields

Apart from the standard address fields, the following additional fields are returned by the service:

Sample XML

The following output XML demonstrates the ProfileResponse for the Multidatabase component. The component name is MultiDatabase and the response type is CAPTURE. The search results are contained in a single ProfileResponse structure, which in turn contains a single ProfileResponseDetails structure. The ProfileResponseDetails structure contains a single CaptureResponse data structure which holds an array of IdmDataAddress records containing the returned address data.

Error Information

Information on possible error codes is given here: Error Code Information