1. Smart Meter Onboarding
Glow Platform
  • Welcome to Glow Data Service!
  • Getting Started
  • Glow Portals
  • Introducing the Glow System
  • API Authentication
  • Smart Meter Onboarding
    • Introducing Smart Meter Onboarding
    • Smart Meter Eligibility Check
    • Terms and Conditions APIs and Management
    • Onboarding Methods — Direct Integration
      • EUI/Postcode Check
      • AVS Check
    • Onboarding Methods — Hosted Integration
      • Glow IDV SDK
        • Introducing the Glow SDK
        • Supported Verification Methods
        • Implementation Guide — Web
        • Implementation Guide — Mobile
        • Verifiable Credentials
        • Verification Result Screen
        • Consent Capture & Onboarding
    • Onboarding Methods — No Integration
      • Invitation Functionality
      • Agent Verification Portal
  • Data Retrieval
    • Retrieving Time Series Data from Onboarded Users
  • Consent Management and Offboarding
    • Consent Management
    • Offboarding
  • Glow CADs & Fulfilment
    • Glow CAD Fulfilment
  • API Reference
    • Smart Meter Elgibility
      • eligibility
        • smets-ihd-cad
          • Check MPxN has CAD/PPMID
        • checksmetsihd
          • postcode
            • Match EUI IHD with postcode
          • Match EUI IHD with MPxN
        • checksmetsmpxn
          • Check MPXN is eligible in DCC.
    • Content System
      • content
        • {contentId}
          • get a content object
          • Update an existing content object
        • Find all the content objects of an application
        • Add a content object
      • languagecontent
        • {languageContentId}
          • get a language content object by ID
          • Update an existing language content object
        • Find all the language content objects of an application
        • Add a language content object
      • termsconditions
        • {tcId}
          • get a terms and conditions object by ID
        • current
          • Find the terms and conditions that are in force.
        • Find all the terms and conditions of an application
        • Add terms and conditions
      • termsconditionsuser
        • {tcUserId}
          • get a specified terms and conditions user obj
        • Find all the responses to terms and conditions documents.
        • Add a user's response to Terms & Conditions document
      • supportdetails
        • {supportDetailsId}
          • get a support details object
        • Find all the support detail objects of an application
        • Add a support details object
      • faq
        • {faqId}
          • get a FAQ object
        • Find all the FAQ objects of an application
        • Add a faq object
      • prompttype
        • {promptTypeId}
          • get a Prompt Type object
        • Find all the prompt type objects of an application
        • Add a Prompt Type object
      • prompt
        • {promptId}
          • get a Prompt object
        • Find all the prompt objects of an application
        • Add a Prompt object
      • promptuser
        • {promptUserId}
          • get a Prompt User object
        • Find all the prompt user objects of an application
        • Add a Prompt User object
      • useraction
        • {userActionId}
          • get a User Action object
        • Find all the user action objects of an application
        • Add a User Action object
      • useractiontype
        • {userActionTypeId}
          • get a User Action Type object
        • Find all the user action type objects of an application
        • Add a User Action Type object
    • User System
      • register
        • User self registers
      • account
        • {accountId}
          • status
            • Find the status of a specified account. If the account is using an external directory service, this call will confirm whether the user is authenticated against it. This call requires administrative application level credentials.
          • mobileapptoken
            • Add mobile app token to a user
            • Remove a mobile app token to a user
          • Find specific account of an application.
          • Updates the account's metadata.
          • Delete account
        • status
          • With a given JWT token a user can have their account status verfied. If their account is created under an external directory service, this call will establish whether a user's token to the external service is still valid.
        • email
          • Change a user's email
        • name
          • Change a user's name
        • changepassword
          • Change a user's password
        • Find all accounts of an application
        • Add an account to an existing user
      • user
        • {userId}
          • username
            • Change a user's username
          • Find specific user that has an account in an application.
          • Delete specific user. This will delete all the accounts of a user. Please refer to delete account API. This API requires specific permissions.
        • verify
          • Generate a user verification token
          • Verify a user verification token
        • resetpassword
          • Generate a token that can be used by user to reset their password.
          • A user resets their password
        • verification
          • status
            • mpxns
              • renewal
                • Renew consent for a number of meterpoints
              • revocation
                • Revoke consent for a number of meterpoints
            • mpxn
              • {mpxn}
                • renewal
                  • Get meter point consent renewals
                  • Renew meter point consent
                • revocation
                  • Get meter point consent revocations
                  • Revoke meter point consent
            • API to retrieve user's meter points' consent and verification
        • Find specific user that has an account in an application from the username.
        • Create a user
      • accountprofile
        • {profileName}
          • Find specific group of application
        • Find all the profiles of an account
        • Create an account profile under a given profileName.
      • accountsession
        • get the session of an account
        • Update an account session.
      • auth
        • token
          • {tokenId}
            • Deletes a token, specified by its tokenId.
          • Returns all the tokens that are active and valid for a specified user.
        • newToken
          • Generate a new token for an account.
        • deleteToken
          • delete a token
        • oauth
          • access
            • Exchange the Authorization Code for an Access Token.
          • Check and validate an Oauth Access token.
          • Authenticate a user and generate an OAuth 2.0 Authorization Code Grant.
        • Checks whether a user token is valid.
        • authenticate an account
    • Virtual Entity System
      • vesys
        • appstats
          • find statistics on the number of Virtual Entities per application
      • virtualentity
        • {id}
          • resources
            • Find the resources of that belong to Virtual Entity with ID
          • attribute
            • Find a Virtual Entity's metadata by ID
            • Add/Update a Virtual Entity's metadata
            • delete metadata from the Virtual Entity
          • Find Virtual Entity by ID
          • Update a Virtual Entity
          • Delete a Virtual Entity
        • Add a new Virtual Entity
        • Find all Virtual Entities
      • vetype
        • {id}
          • resources
            • Find all resources that belong to a user that satisfy the Resource Types in the Virtual Entity Type definition.
          • Find Virtual Entity Type by ID
          • Update a Virtual Entity Type
        • Add a new Virtual Entity Type
        • Find all Virtual Entity Types
    • Webhook System
      • webhook
        • {webhookId}
          • Find webhook by ID
        • error
          • {errorId}
            • Find a particular webhook error
          • Find all the webhooks that have failed
        • Find all webhooks of an application (or user)
    • Resource System
      • resource
        • {id}
          • readings
            • Get resource readings
          • current
            • Get the current resource reading.
          • first-time
            • Get the UTC time of the first available reading
          • last-time
            • Get the UTC time of the most recent available reading
          • meterread
            • Get the cumulative value reported on a metering device. (Not supported for all resource types).
          • tariff
            • Get the latest tariff that is being applied to a resource.
          • tariff-list
            • Get the tariff history that is being applied to a cost resource.
          • catchup
            • Trigger a request to retrieve the latest available readings from the DCC.
          • glowbinary
            • API that returns the resource's raw data in the Glow Binary format.
          • Find resource by ID
        • count
          • Count the number of resources per resourceType
        • Add a new resource
        • Find all resources per user or application
      • resourcetype
        • {id}
          • resource
            • Find resources of a specific resource type that belong to a user
          • appresource
            • Find resources of a specific resource type that an application has access to
          • Find resourceType by ID
        • Add a new resource type.
        • Find all resource types
    • Notification System
      • alerttype
        • {alertTypeId}
          • Find alert type by ID
          • Updates the alert type's metadata.
        • Find all alert types of an application
        • Create an alert type
      • alert
        • {alertId}
          • Get an alert by Id
        • user
          • Get the alerts sent to a user
        • Send an alert
      • template
        • {templateId}
          • Find template type by ID
          • Updates the teplate's metadata.
        • {alertTypeId}
          • {channelType}
            • {cultureCode}
              • Find template by alertTypeId, channeType and cultureCode
              • Create template by alertTypeId, channeType and cultureCode
        • Find all templates of an application
        • Create a template
      • notification
        • {notificationId}
          • log
            • Get the logs of a particular notification
          • Get a notification by Id
    • DFS
      • dfs
        • termsconditions
          • The current version of terms and conditions that is pertinent to DFS for a particular application.
        • user
          • Get all the users that have opted in the DFS functionality
          • User opts in to DFS functionality for a particular MPxN. The mpxn field is only required if a user has more than one MPxN.
          • User opts out of DFS functionality
        • event
          • {dfsEventId}
            • user
              • Get all the users that have participated in a particular DFS event
          • user
            • participation
              • API to indicate User participating in particular DFS event
            • Get all the events a user has signed up for
    • Device Management System
      • devicetype
        • {id}
          • Find Device Type by ID
        • Add a new Device Type
        • Find all device types
      • device
        • {id}
          • status
            • This call can be used to see whether a gateway device is sending packets to the Glow Platform (i.e. via WiFi).
          • Find device by ID
        • resource
          • {resourceId}
            • Find the device that sources a specified resource.
        • meter-point
          • {meterPointNumber}
            • inventory
              • Get the DCC inventory of a meter point
            • resources
              • Get the resources associated to a meter point
        • smart-meter
          • {eui}
            • inventory
              • Get the DCC inventory of a meter point by providing an EUI.
        • status
          • This call can be used to see whether a gateway device is sending packets to the Glow Platform (i.e. via WiFi).
        • Get a user's devices
        • Add a new device
      • discover
        • {hardwareId}
          • Find device by ID
  1. Smart Meter Onboarding

Introducing Smart Meter Onboarding

Introduction#

Glow Data Service allows enrolled organisations to access smart meter data for their own energy consumers. Prior to accessing that data, however, they must complete the Smart Meter Onboarding process.
The Smart Meter Onboarding process is the end to end flow of onboarding an energy consumer into the Glow Platform and in the case of Glow Data Service, enabling a third-party organisation to access their energy data.

Definitions#

TermDefinition
Glow Data ServiceHildebrand's Data Service offering allowing third-party organisations to access smart meter data for their own customers.
OrganisationA third party signed up to Glow Data Service.
OnboardingProcess of enrolling an energy consumer into the Glow Platform.
VerificationProcess whereby a User's smart meters are verified to confirm they are compatible with Hildebrand's ability to retrieve data from them.
ConsentSpecific to the Smart Energy Code: formal process to capture permission from the User to retrieve their energy consumption and related data from their smart meters under the Terms and Conditions in place at the time their consent is captured.
MPxNMeter point identifier, every property has a unique MPxN. MPAN identifies electricity meter, MPRN identifies gas meter.
SECASSmart Energy Code Administrator; regulate Hildebrand's ability to offer the service.
DCCData Communications Company - manages the smart metering infrastructure in the UK.
DCC InventoryHolds the details of all smart metering devices against a property.
Direct IntegrationKeep your energy consumers on your own frontend by integrating the Glow Smart Meter Onboarding APIs directly into your application.
Hosted IntegrationImplement a third-party IDV service to facilitate a component of the onboarding process.
Terms and ConditionsHildebrand's Terms and Conditions. Approved by SECAS. Version controlled.
UserIndividual energy consumer (expected to have a valid smart meter).
EUI16-character identifier found on an IHD - sometimes labeled as a GUID or MAC. This is a unique code that can be used for verification.
IHDIn-home display. Provided by an energy supplier to show energy usage.
SDKSoftware Development Kit — the embeddable Glow IDV SDK itself, which performs IDV when integrated into your application.
Verifiable Credential (VC)A cryptographically signed proof of identity or verification (as a claim), issued as the result of the IDV process.

High Level Onboarding Process#

The high level onboarding process is best described as follows, though there are slight changes in the process flows depending on the chosen integration method. These methods will be discussed later in the document and in the subsequent sections.
1
Registration
The energy consumer initiates the process by registering for the organisation's service in some capacity. In this step, the energy consumer must select or be assigned a subject, which will be assigned to them as their username in the Glow Platform.
2
Eligibility (recommended)
This recommended step in part pertains to Step 3 for direct integration onboarding methods, as it is based on what is submitted in the verification process. The energy consumer's submitted metering details are checked for eligibility for the service prior to being checked for verification.
3
Verification
The energy consumer will provide evidence to verify their occupancy of the property they are registering with the service. The evidence that they provide - and how - is dependent on the method they are using.
4
Consent
A verified energy consumer must grant their explicit consent for their data to be accessed. This is done through acceptance of the service Terms and Conditions.
5
Onboarding
The final step to complete the Smart Meter Onboarding process to onboard an energy consumer. The details and evidence obtained in the previous steps are all required to call the Registration API to onboard the energy consumer.

Registration#

At a point in your organisation's onboarding journey, you must either capture or assign a subject for the energy consumer who is registering for the service. This could be an email address or a unique identifier you use for your customers.
At the end of the onboarding process, this will be assigned to the energy consumer as their username. They will also be separately assigned a unique User ID in the Glow Platform.

Eligibility#

It is good practice to include eligibility checks when facilitating Smart Meter Onboarding. This eligibility check can be added to a direct integration onboarding method to confirm if there is a eligible smart meter at the property.
A smart meter is eligible when it is a SMETS meter that is enrolled in the DCC. See our Smart Meter Eligibility Check documentation for more detail and the API references.

Verification#

Verification is a key component of the Smart Meter Onboarding process. Smart meter data is highly regulated, and can only be released for an energy consumer who has confirmed their occupancy at a property through an approved verification method, and given explicit consent for their data to be accessed.

Verification Methods#

The steps in the high level process above describe the onboarding process at a very high level, but each step changes slightly depending on the chosen verification method(s).
Glow offers the most options for verification in the industry, and our methods require different types of integration by an organisation in order to build the processes into their own front-end.
The integration method will be Direct or Hosted.
We also offer two verification methods that require no integration, which are completely facilitated by the Glow Platform to complete the onboarding process.
The table below outlines each method, how it works and its integration type.
Verification MethodDescriptionIntegration TypeDocumentation
EUI/Postcode CheckThe energy consumer inputs their EUI off their in-home display and their postcode to instantly verify.Direct
AVS CheckThe energy consumer inputs their MPAN and card details. Stripe is used to check for a match between the addresses associated to both and instantly verify.Direct
Glow IDV SDKAn embeddable verification component that integrates as an iframe, enabling automatic verification through either an MPxN/EUI check or a document upload.Hosted
Invitation FunctionalityThe energy consumer signs up to a Glow application; the organisation invites them to share their data with them using the Invitation Functionality tab in the Support Portal.No Integration
Agent Verification PortalA webpage that permits a trusted Agent working on behalf of an organisation to take an energy consumer through the Glow onboarding process during a site visit.No Integration

Consent#

Once an energy consumer has been verified, they can give their explicit consent for their data to be accessed. To do so, they must be presented with and accept the current Terms and Conditions for the service.
When using either a direct or hosted integration onboarding method, you must include the Terms and Conditions presentation in your onboarding flow. It is required for capturing consent and later onboarding the energy consumer.

Terms and Conditions Management#

For a full description on managing your organisation's Terms and Conditions, see our Terms and Conditions APIs and Management documentation.

Onboarding#

The final step is to onboard the energy consumer. This process creates their account in the Glow Platform and enables the organisation to start retrieving their smart meter data.
The 1) subject, 2) verification evidence and 3) evidence of the Terms and Conditions document that the energy consumer has accepted and granted consent against must all be used to onboard the energy consumer using the Glow Provisioning APIs.

Onboarding your Energy Consumers#

The API used to onboard depends on the verification method that was used by the energy consumer, as each method captures a different form of verification evidence.
Each method has its own dedicated guide on integration and use in the subsequent folders in this section of the Glow Data Service documentation. We have split our Glow Onboarding Processes into three categories, as defined below: Direct, Hosted, and No Integration.

Direct Integration Onboarding Processes#

Our Direct Integration Onboarding Processes encompasses our our verification methods that can be fully integrated into an organisation's own front-end using our APIs.

EUI/Postcode Check#

Your energy consumers can verify instantly on your platform using a unique code from an installed IHD/CAD/PPMID (we refer to this code as an EUI in our systems, but it can be labeled as a GUID or MAC on the device itself) and their postcode.
Read the full documentation here .

AVS Check#

This verification method compares an address registered to a bank card to that registered against a smart meter that an end user is attempting to grant consent for, resulting in automatic verification providing submitted details match.
Read the full documentation here .

Hosted Integration Onboarding Processes#

Glow IDV SDK#

The Glow SDK is an embeddable identity and address verification component that integrates directly into your own front end as an iframe.
It confirms that someone lives at a given address, establishing verified proof of residency before your application requests their consent to access their energy data.
The SDK can be integrated into either a web page or a mobile application. The full Glow IDV SDK documentation is available here

No Integration Onboarding Processes#

These methods do not require any integration, as they are facilitated entirely through our existing Glow applications.
The Glow team must enable an organisation to use either of these onboarding methods - interest in these methods must be expressed either at sign up or by contacting the team directly.

Invitation Functionality#

The Glow Invitation Functionality is an approved method for onboarding energy consumers, where the energy consumer independently signs up for a Glow application, completing the verification process themselves, and then gives the organisation consent to access their data.
The Invitation Functionality requires no integration work from your own organisation. See full details in our documentation here .

Agent Verification Portal#

The Agent Verification Portal gives a trusted Agent, working on behalf of an organisation, the authority and ability to take an energy consumer through the Glow onboarding process to complete the required verification and consent protocols to start retrieving smart meter data (and potentially join a CAD to the smart meter(s).
See Agent Verification Portal Guide here for more information and a walkthrough of its use. Additional support and training materials are provided to organisations as part of their unique portal configuration.
Modified at 2026-08-25 11:32:11
Previous
API Authentication
Next
Smart Meter Eligibility Check
Built with