1. Onboarding Methods — No Integration
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. Onboarding Methods — No Integration

Invitation Functionality

Introduction#

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 giving the organisation consent to access their data.
An organisation can then invite that energy consumer to share their energy data with them by using the Glow Invitation functionality.
This option is designed for organisations who do not want to integrate Glow Data Service into their own front end.

High level description of functionality#

1.
Upon request, Glow will provide access to the Invitation functionality for an organisation.
2.
The organisation captures the email addresses that their energy consumers used to sign up for their own Glow accounts.
3.
All email addresses will be added to a single csv file.
4.
Using the Invitation functionality tab in the Support portal, the organisation user will upload the CSV file from Step 3.
5.
The Glow system will then trigger invitations (sent via push notifications in the Bright app and email) to all people in Step 2 who are successfully signed up to Bright, asking them to provide their permission to Glow to share their data with the organisation.
6.
The energy consumers will accept their invitations, upon which data is automatically shared.
7.
During the process, the organisation can monitor statuses of the invitations via the Support portal.
8.
The energy consumer can use their chosen Glow application(s) to monitor who they are sharing their energy consumption data with and revoke their consent to share with an organisation at any point.
If an energy consumer revokes their permission for Glow to retrieve their energy data, the organisation will no longer get their data either.

Requirements for use#

The Invitation functionality must be activated for an organisation by the Glow team, either upon sign up or later on, if the functionality is requested.
The organisation must also provide a logo and content for the invitation message, to be delivered to the energy consumer.

Example invitation content#

The following can be added to in order to suit the organisation's needs, but needs to include the details below. The energy consumer will then be presented with what they are agreeing to underneath the narrative paragraph.
Organisation's name would like to have access to your energy consumption data so that they can Purpose of data processing. We need you to confirm that you’re happy to share your smart meter data with Organisation's name.

  • I give consent for Hildebrand Technology Ltd to share my electricity and gas meter consumption data with Organisation's name.
  • I understand that Organisation's name will use this information to understand my household and energy use over time.
  • I understand that I can withdraw consent at any time within the Bright App.

Status descriptions#

The below table shows the list of statuses applied to an energy consumer depending on their stage in the Invitation journey.
Status field identifierStatus field description
pending-user-registrationWaiting for energy consumer to register for a Glow application - for example, Bright.
pending-user-eligibilityEnergy consumer has registered on Bright, but they have not been through the Bright Verification and consent process which gives Hildebrand the information required to start capturing data from their smart meter. This means they are not eligible to accept the invitation as they don't yet have any data.
pending-invite-acceptanceEnergy consumer successfully receiving their consumption data and can be/has been invited to participate. Users will receive their invitations via the Bright app.
accepted-data-availabilityEnergy consumer has accepted invitation, at this point the organisation can get the data via the Dev Portal, etc.
invitation-dismissedEnergy consumer dismissed the invitation (the organisation never had access to the data).
permission-revokedEnergy consumer revoked the permission from the organisation to see their data. The organisation will no longer be revoked able to get the data for this user over the API.

Using the Invitation functionality#

Initiation#

The organisation will navigate to the Invitation tab in the Support Portal to upload a CSV file of email addresses. Once the CSV has been uploaded, it will return a correlating CSV file with the status of each email address.
If an email address exists in a Glow application and is verified, the energy consumer is immediately sent an invitation to share their data as an email and as a push message.
Acceptance is done within the Bright app (instructions in the email User receives).
Once data has been shared, the energy consumer can see who their data is shared with, and withdraw their sharing permission whenever they like.
When a energy consumer's data is shared with an organisation, the organisation will see their data update date set to today, and the energy consumer's invitation list in the Support portal will reflect the updated status against their email address.

Ongoing management#

Energy consumers' whose email addresses have been uploaded recently, or are already in the system, are listed within the Invitations / Reporting screens with their current status.
Glow's systems run a nightly process to check if there have been any status changes (e.g. accepted invitation / signed up to Bright) and that status is automatically updated on the Support portal.

Energy consumer consent revocation#

When an energy consumer says ’stop sharing’ the organisation can no longer see the user, their data or their data history. Their email address will still appear in the Invitation list, but now with an Account Revoked status.
If an energy consumer asks for their Glow account to be deleted, their email address will also be removed from the Invitation list, but the list would still have their accountID for reference purposes.
Please note that Glow occasionally have people ask to be deleted - sometimes they want everything related to them deleted, sometimes they just want data flow to stop - we vary the level of deletion based on what we are asked.

CSV format#

The Support portal includes a template for the CSV upload.
We’ve designed the functionality for a new list of Invitations to work even if an email address was uploaded previously. The repeated email address will be ‘ignored’ if it is already on the Invitation list from a previous upload.
Modified at 2026-08-14 16:19:23
Previous
Consent Capture & Onboarding
Next
Agent Verification Portal
Built with