# Auth Energy

## Docs

- [Obtain Bearer Token](https://docs.auth.energy/api-reference/authentication/obtain-bearer-token.md): Exchange Basic Auth credentials for a short-lived JWT bearer token. Cache and reuse until expiry. Credentials Base64-encoded as `account_id:secret_key`.
- [Retrieve individual CIM XML Difference Model file from a Development Project](https://docs.auth.energy/api-reference/cim-xml-files/retrieve-individual-cim-xml-difference-model-file-from-a-development-project.md): Returns a single CIM XML Difference Model file (EQ, SC, or GL) from within a Development Project archive. Difference Models contain both forwardDifferences (additions) and reverseDifferences (deletions) against a base Full Model.
- [Retrieve individual CIM XML file from Fault Level case](https://docs.auth.energy/api-reference/cim-xml-files/retrieve-individual-cim-xml-file-from-fault-level-case.md): Returns a single CIM XML Full Model file (EQ, SC, or SCR) from within the Existing Fault Level case.
- [Retrieve individual CIM XML file from NETS Maximum Demand case](https://docs.auth.energy/api-reference/cim-xml-files/retrieve-individual-cim-xml-file-from-nets-maximum-demand-case.md): Returns a single CIM XML Full Model file from within the NETS Maximum Demand solved case. Each file conforms to its corresponding LTDS merged profile and uses RDF/XML serialisation. The header (md:FullModel) is present at the start of every file and contains profile IRI, scenarioTime, modelingAuthor…
- [Register consumer consent](https://docs.auth.energy/api-reference/consent/register-consumer-consent.md): <Warning>No idea how/if this works or even why it's here as specific customer tariffs are now out of scope</Warning>
- [Revoke consumer consent](https://docs.auth.energy/api-reference/consent/revoke-consumer-consent.md): <Warning>No idea how/if this works or even why it's here as specific customer tariffs are now out of scope</Warning>
- [Get customer-specific tariff details](https://docs.auth.energy/api-reference/consumer-tariffs/get-customer-specific-tariff-details.md): Returns tariff pricing tied to a specific consumer's metering point. Use this when public tariff data is insufficient to determine correct pricing — for example, where a supplier's tariff varies in ways not resolvable from name and postcode alone.
- [Look Up a Data User by DUID](https://docs.auth.energy/api-reference/data-providers/look-up-a-data-user-by-duid.md): Returns profile and status information for a registered Data User organisation identified by DUID.
- [Verify Access Record](https://docs.auth.energy/api-reference/data-providers/verify-access-record.md): Returns the full access record for a given access key. Called by Data Providers before releasing meter data.
- [Create an Access Record](https://docs.auth.energy/api-reference/data-users/create-an-access-record.md): Registers a new access record on behalf of a Controller. Returns `201` and an `access-token` containing the new access key (`ak`), plus a `Location` header pointing to the created resource.
- [List Access Records for a Meter Point](https://docs.auth.energy/api-reference/data-users/list-access-records-for-a-meter-point.md): Returns all Access Records and Discovered Records for a given meter point.
- [List Own Access Records](https://docs.auth.energy/api-reference/data-users/list-own-access-records.md): Returns all Access Records registered by the authenticated Data User, scoped to their DUID. Supports filtering by state and legal basis.
- [Replace an Access Record](https://docs.auth.energy/api-reference/data-users/replace-an-access-record.md): Replaces the full payload of an existing access record. The record identified by `ak` must have been registered by the authenticated Data User.
- [Revoke Access Record](https://docs.auth.energy/api-reference/data-users/revoke-access-record.md): Revokes an access record. Transitions the record to `REVOKED` state with a `revoked-at` timestamp. Records are retained for audit — not deleted.
- [Submit a Change of Tenancy Event](https://docs.auth.energy/api-reference/dcc/submit-a-change-of-tenancy-event.md): Records a Change of Tenancy (CoT) against an MPxN and triggers `tenancy.change` webhooks to all Data Users with one or more `ACTIVE` access records on that MPxN.
- [Submit a Discovered Access Record](https://docs.auth.energy/api-reference/dcc/submit-a-discovered-access-record.md): Submits a sparse, system-generated access record derived from DCC historic meter transaction logs. Used when the DCC detects that an organisation has been making data requests against a meter point but has not yet registered as a Data User in the DAR.
- [Get Capacity Heatmap Dataset](https://docs.auth.energy/api-reference/get-capacity-heatmap-dataset.md): Returns a capacity heatmap dataset for a network operator's licence area.
- [Anonymise an Identity Record](https://docs.auth.energy/api-reference/identity-records/anonymise-an-identity-record.md): Anonymises an Identity Record in response to a GDPR Art. 17 erasure request. The record is retained in a tombstoned state for audit continuity — the `ir` key remains valid and the linked AccessRecord continues to reference it — but all PII fields (`pii-principal`, `email`, `credentials`, and `princi…
- [Create an Identity Record](https://docs.auth.energy/api-reference/identity-records/create-an-identity-record.md): Creates an Identity Record holding the person-property relationship for a consent or access registration. Returns an `ir` key that must be supplied as `record-metadata.identity-record-ref` when creating the linked AccessRecord.
- [Look Up Identity Records](https://docs.auth.energy/api-reference/identity-records/look-up-identity-records.md): Returns Identity Records matching the supplied lookup parameters. Used by a Data User to locate an existing record for a returning customer before initiating re-identification.
- [Remove a Passkey Credential](https://docs.auth.energy/api-reference/identity-records/remove-a-passkey-credential.md): Removes a registered passkey credential from an Identity Record. The credential can no longer be used for passkey assertion after removal.
- [Retrieve an Identity Record](https://docs.auth.energy/api-reference/identity-records/retrieve-an-identity-record.md): Returns the full Identity Record for a given `ir` key. Only accessible to the authenticated Data User that created the record.
- [Check Identity Record Existence by MPxN](https://docs.auth.energy/api-reference/re-identification/check-identity-record-existence-by-mpxn.md): Returns a boolean indicating whether an Identity Record exists for the given MPxN across all Data Users. No `ir` key or PII is returned.
- [Confirm Re-identification Status](https://docs.auth.energy/api-reference/re-identification/confirm-re-identification-status.md): Confirms the status of a magic-link or passkey re-identification flow. The `token-ref` is returned in the `magic-link` or `passkey` object from `POST /identity-records/{ir}/re-identify`, and also appended as a query parameter when the register redirects the customer back to the Data User's applicati…
- [Initiate Cross-DUID Re-identification by MPxN](https://docs.auth.energy/api-reference/re-identification/initiate-cross-duid-re-identification-by-mpxn.md): Initiates a re-identification flow against an existing Identity Record for the given MPxN, without exposing the `ir` key. Used when a Data User wants to create an Access Record linked to an Identity Record originally created by another Data User.
- [Initiate Re-identification](https://docs.auth.energy/api-reference/re-identification/initiate-re-identification.md): Initiates or completes a re-identification flow for a returning customer, reconnecting them to their existing Identity Record without re-collecting all their details.
- [Poll Cross-DUID Re-identification Status](https://docs.auth.energy/api-reference/re-identification/poll-cross-duid-re-identification-status.md): Polls the status of a cross-DUID re-identification flow initiated via `POST /identity-records/reidentify`. Used by Data User B who holds a `token-ref` but not the `ir` key.
- [Get third-party user details](https://docs.auth.energy/api-reference/registry/get-third-party-user-details.md): Returns a single RTI User by their `user_id`.
- [List suppliers](https://docs.auth.energy/api-reference/registry/list-suppliers.md): Returns all TI Energy Suppliers with their API endpoint URLs and active status. Use this to discover where to send tariff requests for a given supplier MPID.
- [List third-party users](https://docs.auth.energy/api-reference/registry/list-third-party-users.md): Returns organisations registered to access consumer-specific tariff data (RTI Users).
- [Submit performance report](https://docs.auth.energy/api-reference/reporting/submit-performance-report.md): Suppliers submit periodic performance metrics to RECCo as part of their assurance obligations. Reporting frequency and full PARC requirements will be confirmed in a 2026 REC Change.
- [Get Stage 2 Existing Fault Level case archive](https://docs.auth.energy/api-reference/stage-2-publications/get-stage-2-existing-fault-level-case-archive.md): Returns the .zip archive for the Existing Fault Level "case". The archive contains three CIM XML Full Model files: - EQ.xml  — Equipment profile (merged LTDS Equipment profile) - SC.xml  — Short Circuit profile (merged LTDS Short Circuit profile) - SCR.xml — Short Circuit Result profile (LTDS-specif…
- [Get Stage 2 Existing System Capacity case archive](https://docs.auth.energy/api-reference/stage-2-publications/get-stage-2-existing-system-capacity-case-archive.md): Returns the .zip archive for the Existing System Capacity "case" (outturn non-coincident load, firm capacity). The archive contains two CIM XML Full Model files: - EQ.xml     — Equipment profile - SYSCAP.xml — System Capacity profile (merged LTDS System Capacity profile) Zip naming convention: `LTDS…
- [Get Stage 2 Future Year 1 System Capacity case archive](https://docs.auth.energy/api-reference/stage-2-publications/get-stage-2-future-year-1-system-capacity-case-archive.md): Returns the .zip archive for the Future Year 1 System Capacity "case" (forecast non-coincident load). The archive contains two CIM XML Full Model files: - EQ.xml     — Equipment profile - SYSCAP.xml — System Capacity profile Zip naming convention: `LTDS_<licenceArea>_<pubYear>-<period>_SystemCapacit…
- [Get Stage 3 Existing Fault Level case archive](https://docs.auth.energy/api-reference/stage-3-publications/get-stage-3-existing-fault-level-case-archive.md): Returns the .zip archive for the Existing Fault Level "case". The archive contains three CIM XML Full Model files: - EQ.xml  — Equipment profile - SC.xml  — Short Circuit profile - SCR.xml — Short Circuit Result profile (LTDS-specific extension) Zip naming convention: `LTDS_<licenceArea>_<pubYear>-<…
- [Get Stage 3 Existing System Capacity case archive](https://docs.auth.energy/api-reference/stage-3-publications/get-stage-3-existing-system-capacity-case-archive.md): Returns the .zip archive for the Existing System Capacity "case" (outturn non-coincident load, firm capacity). The archive contains four CIM XML Full Model files: - EQ.xml     — Equipment profile - SYSCAP.xml — System Capacity profile Zip naming convention: `LTDS_<licenceArea>_<pubYear>-<period>_Sys…
- [Get Stage 3 firm grid Development Project archive](https://docs.auth.energy/api-reference/stage-3-publications/get-stage-3-firm-grid-development-project-archive.md): Returns the .zip archive for a specific firm future grid Development Project. The archive contains three CIM XML Difference Model files: - EQ.xml — Equipment profile (Difference Model) - SC.xml — Short Circuit profile (Difference Model) - GL.xml — Geographical Location profile (Difference Model) Dif…
- [Get Stage 3 Future Year System Capacity case archive](https://docs.auth.energy/api-reference/stage-3-publications/get-stage-3-future-year-system-capacity-case-archive.md): Returns the .zip archive for a specified Future Year System Capacity "case" (forecast non-coincident load). Up to five future year cases are published (Years 1–5). The archive contains two CIM XML Full Model files: - EQ.xml     — Equipment profile - SYSCAP.xml — System Capacity profile Zip naming co…
- [Get Stage 3 NETS Maximum Demand solved case archive](https://docs.auth.energy/api-reference/stage-3-publications/get-stage-3-nets-maximum-demand-solved-case-archive.md): Returns the .zip archive for the NETS Maximum Demand "solved case". The archive contains seven CIM XML Full Model files: - EQ.xml  — Equipment profile - SC.xml  — Short Circuit profile - GL.xml  — Geographical Location profile - DL.xml  — Diagram Layout profile - SSH.xml — Steady State Hypothesis pr…
- [Get Stage 3 NETS Minimum Demand solved case archive](https://docs.auth.energy/api-reference/stage-3-publications/get-stage-3-nets-minimum-demand-solved-case-archive.md): Returns the .zip archive for the NETS Minimum Demand "solved case". Identical structure to the Maximum Demand case (7 CIM XML Full Models: EQ, SC, GL, DL, SSH, TP, SV). Zip naming convention: `LTDS_<licenceArea>_<pubYear>-<period>_GBMinimum_<dateTimeOfMinimum>_v<version>.zip` where dateTimeOfMinimum…
- [Get tariff details](https://docs.auth.energy/api-reference/tariffs/get-tariff-details.md): Returns full pricing detail for a specific tariff: unit rates, standing charge, validity windows, regional pricing, and green energy percentage.
- [List tariffs](https://docs.auth.energy/api-reference/tariffs/list-tariffs.md): Returns a summary of all tariffs offered by the specified supplier — tariff ID, display name, and when pricing data was last updated.
- [Delete a Webhook Subscription](https://docs.auth.energy/api-reference/webhooks/delete-a-webhook-subscription.md): Permanently removes a webhook subscription. In-flight deliveries already queued at the time of deletion will still be attempted.
- [List Webhook Subscriptions](https://docs.auth.energy/api-reference/webhooks/list-webhook-subscriptions.md): Returns all active webhook subscriptions registered by the authenticated Data User.
- [Register a webhook endpoint](https://docs.auth.energy/api-reference/webhooks/register-a-webhook-endpoint.md): Registers (or replaces) the HTTPS URL to which the supplier will deliver event notifications. Each RTI User has one active webhook URL per supplier.
- [Register a Webhook Subscription](https://docs.auth.energy/api-reference/webhooks/register-a-webhook-subscription.md): Registers an HTTPS callback URL to receive lifecycle event notifications dispatched by the register.
- [Tariff event notification received by rti user](https://docs.auth.energy/api-reference/webhooks/tariff-event-notification-received-by-rti-user.md): The supplier POSTs this payload to the RTI User's registered webhook URL whenever a relevant event occurs for a consumer with active consent.
- [Update a Webhook Subscription](https://docs.auth.energy/api-reference/webhooks/update-a-webhook-subscription.md): Updates an existing webhook subscription. Only fields supplied in the request body are modified; omitted fields retain their current values.
- [Change Log](https://docs.auth.energy/data-access-register/change-log.md): History of changes
- [Central Customer Portal](https://docs.auth.energy/data-access-register/customer-portal.md): A centralised web interface allowing customers to view and withdraw their energy data access records, accessed directly or via a Data User link.
- [Smart Energy Data Governance Framework](https://docs.auth.energy/data-access-register/data-zones.md): Mitigating third-party data access risks beyond the SEC perimeter
- [Proof of Concept / Demo Overview](https://docs.auth.energy/data-access-register/demo.md): What the DAR reference implementation demonstrates and the principles behind it.
- [Github Data Access Register Repository](https://docs.auth.energy/data-access-register/github.md)
- [Identity Records](https://docs.auth.energy/data-access-register/identity-guide.md): How the DAR separates person-property identity from access records, and how re-identification works for returning customers.
- [Data Access Register](https://docs.auth.energy/data-access-register/index.md): A lightweight central register of lawful customer energy data access across all UK GDPR legal bases.
- [Authorised Portal Operators](https://docs.auth.energy/data-access-register/portal-operators.md): How to build a branded customer-facing transparency portal using the DAR API.
- [FMAR - From Registration to Characterisation](https://docs.auth.energy/fmar/index.md): A Meter-Data-Native Approach to Flexibility Market Asset Registration
- [Auth Energy Library](https://docs.auth.energy/general/index.md): Independent technical assessment, scrutiny, and advisory for UK energy digitalisation. Our documentation covers our published views, programme analysis, open specifications, and commentary on industry governance.
- [Change Log](https://docs.auth.energy/tariff-interop/change-log.md): A log of changes to the Tariff Interoperability API spec
- [Tariff Interoperability](https://docs.auth.energy/tariff-interop/index.md): RECCo's tariff interoperability programme

## OpenAPI Specs

- [ltds_grid_modelling_openapi](https://docs.auth.energy/neso-dsi/api/ltds_grid_modelling_openapi.yaml)
- [capacity-heatmaps-openapi](https://docs.auth.energy/neso-dsi/api/capacity-heatmaps-openapi.yaml)
- [openapi-tariff](https://docs.auth.energy/tariff-interop/api/openapi-tariff.yaml)
- [openapi-dar](https://docs.auth.energy/data-access-register/api/openapi-dar.yaml)
- [api_schema.oas](https://docs.auth.energy/api-reference/api_schema.oas.yaml)
- [openapi](https://docs.auth.energy/api-reference/openapi.json)