Utilities enrichment

Overview

Using a single, real-time API, users can capture accurate customer address data and append comprehensive utilities information in just a few key-strokes; for easy, speedy switching with no compromise on customer experience. Plus, with our broad enrichment capabilities, it extends beyond faster switching to support a deeper understanding of your customer base. With a wealth of enrichment intelligence available, our API does more than offer compliance, it provides the insights to support business strategy, planning, and execution, and is fully compliant with Ofgem and REC requirements.

Highlights

  • Our comprehensive utilities data, updated constantly for accuracy and reliability, includes MPAN (Meter Point Administration Number), MRPN (Meter Point Reference Number), REL (Retail Energy Location), MSN (Meter Serial Number), and GSP (Grid Supply Point). You may require an additional dataset license. Get in touch with your account manager or contact support.
  • Search by United Kingdom Postal Address, United Kingdom Business Names, United Kingdom Not Yet Build, and United Kingdom Multi-Residence, for high precision address data capture. You may require additional licenses to access these datasets. Get in touch with your account manager or contact support.
  • The ability to increase business insight by appending MOSAIC Household data.
  • Supported functionality for Autocomplete, Singleline, and Typedown address search types.
  • Customizable layouts for predictable and fixed address formatting.
  • Search against GES and EES in a single call.

Integration

  1. Pass a gas or electricity meter number to the /address/lookup/v2 endpoint. Use type of MPAN for retrieving electricity data and MPRN for gas data.

    POST /address/lookup/v2 HTTP/1.1
    Add-FinalAddress: true
    
    {
        "country_iso": "GBR",
        "datasets": [
            "gb-additional-electricity"
        ],
        "key": {
            "type": "MPAN",
            "value": "1234567890123"
        },
        "layouts": [
            "ElectricityUtilityLookup"
        ]
    }
    
    POST /address/lookup/v2 HTTP/1.1
    Add-FinalAddress: true
    
    {
        "country_iso": "GBR",
        "datasets": [
            "gb-additional-gas"
        ],
        "key": {
            "type": "MPRN",
            "value": "1234567890"
        },
        "layouts": [
            "GasUtilityLookup"
        ]
    }
    
  2. The end user is presented with the utility information retrieved for the provided meter number. This includes the REL address associated with the meter number as held by REC, as well as enrichment elements like the Energisation Status, Grid Supply Point, and much more.

    The available layouts are:

    • ElectricityUtilityLookup - Returns utility elements for the electricity dataset only.
    • GasUtilityLookup - Returns utility elements for the gas dataset only.

    Find a full list of available electricity and gas enrichment elements, in our /address/format/v1 endpoint API specification.

  1. Pass the user input from an address search field to the /address/search/v1/ endpoint. Our Utilities Enrichment proposition supports Autocomplete, Singleline and Typedown search types.

    POST /address/search/v1 HTTP/1.1
    
    {
        "country_iso": "GBR",
        "datasets": [
            "gb-additional-business",
            "gb-additional-electricity",
            "gb-additional-gas"
        ],
        "max_suggestions": 15,
        "components": {
            "unspecified": [
                "Experian, cardinal place"
            ]
        }
    }
    
    POST /address/search/v1 HTTP/1.1
    
    {
        "country_iso": "GBR",
        "max_suggestions": 15,
        "datasets": [
            "gb-additional-electricity"
        ],
        "components": {
            "unspecified": [
                "1 main st, london"
            ]
        },
        "options": [
            {
                "name": "search_type",
                "value": "singleline"
            }
        ]
    }
    
  2. For Singleline and Typedown, the end user may need to provide additional information or your integration might need to step into an address suggestion to get more detailed information.

    • To step into a suggestion (stepin=true on the response), pass the global_address_key to the /address/suggestions/stepin/v1/{global_address_key} endpoint as a path parameter.

    • Should the end user need to provide additional information for the request, for example to select a single building from building numbers returned in a range, pass the global_address_key to the /address/suggestions/refine/v1/{key} endpoint as a path parameter as well as the refinement in the body.

      POST /address/suggestions/refine/v1/{key} HTTP/1.1
      
      {
          "refinement": "1a"
      }
      
  3. Once the user selects an address, pass the global_address_key to the /address/format/v1/ endpoint to retrieve the formatted address and utilities enrichment elements.

    POST /address/format/v1 HTTP/1.1
    
    {
        "layouts": [
            "utilities"
        ],
        "layout_format": "default"
    }
    

    The available layouts are:

    • Utilities - Returns utility elements for both gas and electricity datasets in a single request.
    • ElectricityUtility - Returns utility elements for the electricity dataset only.
    • GasUtility - Returns utility elements for the gas dataset only.
    • ElectricityUtilityMosaicHousehold – Returns electricity and MOSAIC Household elements.
    • GasUtilityMosaicHousehold - Returns gas and MOSAIC Household elements.

    Find a full list of available electricity and gas enrichment elements, in our /address/format/v1 endpoint API specification.