Consent Management

Once an energy consumer has granted your organisation consent to access their energy data for a particular MPxN, that consent is typically valid for 18 months.

Consent is managed at the MPxN (meter point) level. This ensures that consent is explicitly associated with individual electricity or gas meter points at a property or site.

Using the Glow APIs, your organisation can:

check the current consent status for a user and their associated MPxNs ;

renew consent before it expires;

revoke consent;

retrieve the renewal history for a meter point; and

retrieve the revocation history for a meter point.

A Glow user’s consent status is queried using their userId. The response lists the MPxNs for which the user has granted consent, together with the current verification status and expiry date. Specifically this is the API that can be used:

Input header fields (case sensitive):

Field	Required/Optional	Explanation
userId	required	The userId of the user to check the user's verification status
Authentication	required	Basic auth token comprised of the API key and password found in the Developer Portal

Successful response is a 200:

{
    "meterPointVerification": [
        {
            "isVerified": true,
            "isValidUntil": "2022-12-01T23:59:59.000Z",
            "mpxnKey": "mpan",
            "mpxn": "19*******34"
        }
    ]
}

where the meterPointVerification array contains the meter points associated with the user and their current consent status.

Return fields

Field	Explanation
isVerified	boolean value to indicate that the verification status of an MPxN
isValidUntil	Date and time at which the current consent expires, in ISO 8601 format.
mpxnKey	Meter point identifier type: `mpan` for electricity or `mprn` for gas.
mpxn	the value of either the MPAN or MPRN

Once consent has been granted, it is valid for 18 months. It can however be renewed prior to its expiry, for a further 18 months.

We recommend notifying energy consumers when they are approaching their consent expiry date. For example, your application may begin prompting the consumer to renew within the final 6 months of the consent period.

Use this API to renew the consent of a meter point:

Response

{
    "valid": true,
    "meterPointVerificationRenewalId": "de122a5b-7c3d-4f0d-a894-40bc72a62cf6",
    "isValidUntil": "2023-10-22T23:59:59",
    "mpxn": "19*******34"
}

If at any time you want to revoke consent for an energy consumer, then the following call can be used. This call must also be used if an energy consumer contacts you and asks to revoke their consent for you to access their data.

By revoking consent the data retrieval from the DCC and the CAD join/unjoin will stop. If you wish to additionally remove access, use the Offboarding API.

curl -L -X POST 'https://api.glowmarkt.com/api/v0-1/user/verification/status/mpxn/19*******34/revocation' \
-H 'Content-Type: application/json' \
-H 'userId: USERID' \
-H 'Authentication: Basic ***********' \
--data-raw '{"isValidUntil": "2022-03-22T00:00:00"}'

Response

{
    "valid": true,
    "meterPointVerificationRevocationId": "de122a5b-7c3d-4f0d-a894-40bc72a62cf6",
    "isValidUntil": "2022-03-22T00:00:00",
    "mpxn": "19*******34"
}

The isValidUntil value records the point from which the consent is no longer valid. It can be set to a value in the future.

This API returns with a list of all consent renewals against an MPxN.

curl -L -X GET 'https://api.glowmarkt.com/api/v0-1/user/verification/status/mpxn/19*******34/renewal' \
-H 'Content-Type: application/json' \
-H 'Authorization: Basic RW********************Q'

Response

{
    "valid": true,
    "meterPointRenewals": [
        {
            "auditReference": {
                "applicationId": "b0f1b774-a586-4f72-9edd-27ead8aa7a8d"
            },
            "createdAt": "2022-04-22T15:15:22.125Z",
            "mpxn": "19*******34",
            "mpxnKey": "mpan",
            "renewedBy": {
                "key": "userId",
                "value": "141f0770-3a2e-40eb-9960-cdb92f6e32f3"
            },
            "meterPointVerificationRenewalId": "de122a5b-7c3d-4f0d-a894-40bc72a62cf6"
        },
        {
            "auditReference": {
                "applicationId": "b0f1b774-a586-4f72-9edd-27ead8aa7a8d"
            },
            "createdAt": "2022-04-22T15:18:53.123Z",
            "mpxn": "19*******34",
            "mpxnKey": "mpan",
            "renewedBy": {
                "key": "userId",
                "value": "141f0770-3a2e-40eb-9960-cdb92f6e32f3"
            },
            "meterPointVerificationRenewalId": "8488ed5d-6347-4e05-8cad-993ef4817498"
        },
        {
            "auditReference": {
                "applicationId": "b0f1b774-a586-4f72-9edd-27ead8aa7a8d"
            },
            "createdAt": "2022-04-22T15:19:07.275Z",
            "mpxn": "19*******34",
            "mpxnKey": "mpan",
            "renewedBy": {
                "key": "userId",
                "value": "141f0770-3a2e-40eb-9960-cdb92f6e32f3"
            },
            "meterPointVerificationRenewalId": "30fdca3e-d12e-4a65-9666-b47f90be9696"
        }
    ]
}

Each entry provides an audit record of a consent renewal, including when it occurred, which meter point was affected and the user responsible for the renewal.

You can also view all consent revocations against an MPxN using this API:

curl -L -X GET 'https://api.glowmarkt.com/api/v0-1/user/verification/status/mpxn/2*****6/revocation' \
-H 'Content-Type: application/json' \
-H 'Authorization: Basic R*****Q' \
-H 'applicationId: b0f1b774-a586-4f72-9edd-27ead8aa7a8d'

Response

{
    "valid": true,
    "meterPointRevocations": [
        {
            "auditReference": "b0f1b774-a586-4f72-9edd-27ead8aa7a8d",
            "createdAt": "2021-08-13T16:36:18.209Z",
            "mpxn": "2*****6",
            "mpxnKey": "mprn",
            "revokedBy": {
                "key": "userId",
                "value": "ccb94244-80b5-4197-affd-75f968ada451"
            },
            "meterPointVerificationRevocationId": "3d001fe4-1385-4515-98a8-2cbda16c1f3f"
        },
        {
            "auditReference": "6dc7e58b-4f10-4897-9a6b-a0971bee1235",
            "createdAt": "2021-08-19T08:35:21.147Z",
            "mpxn": "2*****6",
            "mpxnKey": "mprn",
            "revokedBy": {
                "key": "userId",
                "value": "453abdab-f0f1-436c-b231-5fc26754a25e"
            },
            "meterPointVerificationRevocationId": "dcd4bb90-da78-4bf8-bd7f-90f1eea5eded"
        }
    ]
}

Each entry provides an audit record of a consent revocation, including when the revocation occurred, the affected meter point and the entity responsible for the action.

Get Consent Status#

Input header fields (case sensitive):#

Return fields#

Renew consent#

Response#

Revoke consent#

Response#

Get consent renewals of meter point#

Response#

Get consent revocations of meter point#

Response#

Get Consent Status

Input header fields (case sensitive):

Return fields

Renew consent

Response

Revoke consent

Response

Get consent renewals of meter point

Response

Get consent revocations of meter point

Response