Working with external records
✓ EnergyID for Business
With external records you offer customers or members EnergyID Premium and additional energy services, while they remain the owners of their own record.
An external record is the record of a customer or member that is linked to your workspace. The customer or member remains the owner of the record. Your organisation only gets access to the data and features the owner gives permission for.
Do you need external records?
External records are useful if you offer services to private individuals or members who remain the owners of their record. For example as an energy supplier, installer, cooperative or energy community.
Do you only follow up the buildings or installations of your own organisation? Then you usually don’t need external records. Create them as records of your workspace. If you want to give a tenant or installer access to a record of your workspace, you can share that record with that person as a guest user.
A business customer that works with EnergyID itself can also link its record to your workspace. If that customer doesn’t work with EnergyID itself, you manage the building as a record of your workspace.
Activate the feature
Only administrators of the workspace can activate the External records feature.
- In your workspace, go to Configuration.
- Click Activate next to External records.
- Set up the configuration. Among other things, you decide who may link a record and which permissions you request.
You can switch the feature off again later. To do so, open External records in Configuration, click the three dots at the top right and choose Deactivate. This is only possible when no external records are linked to your workspace anymore.
Let customers or members sign up
Customers or members link their record through your organisation’s sign-up page. You decide who may sign up. There are three options:
- Invited users only: only people you invite can link their record.
- Shared code: anyone with the activation code can sign up.
- Personal code: EnergyID checks the code through your COFY back office.
Signing up with a personal code is available from the Standard subscription.
An activation code from an invitation always works, whichever sign-up method you choose.
You can adapt the sign-up page to your organisation, for example with your own name, logo and privacy statement. Set up a personalised sign-up page →
Manage invitations: you can invite customers or members one by one or import a list of invitations. Invite customers or members →
Which permissions do you request?
As a service provider, you decide which data and access you request from the owner. The owner sees these permissions while linking. In the texts, [Name] is automatically replaced by the name you set as service provider.
| Permission | What does it mean? |
|---|---|
| View your profile information (required) | Your organisation gets the owner’s name, email address, photo and preferred language. This data is used to identify the owner. |
| Use your essential record data for the offered services (optional) | Your organisation may use the record data needed for the services offered. |
| Access to your record for help and support (optional) | Employees of your organisation get access to the record as guest users, to view and edit it. |
| Send you messages and collect your responses (optional) | Your organisation may send messages through EnergyID to the owner and the guest users of the record, and collect their answers. |
You decide which optional permissions you request.
Which features need which permission?
Not every feature needs the same access:
- Data consent (the permission Use your essential record data for the offered services) is needed for features that use meter data, such as Collective self-consumption, Solar power settlement, PV performance, data export, API keys and MQTT data forwarding. Without this consent, the external record is not included in those features.
- Access for help and support is needed if employees of your organisation want to view or edit the record themselves. They then get the guest user role.
- Messaging consent (the permission Send you messages and collect your responses) is needed to send messages through EnergyID to the owner and guest users of the external record.
On the External records page you see per record which data consent and messaging consent the owner has given.
If you later request an additional permission, you can also have it requested from owners of records that are already linked. If you switch on a feature for which you don’t request the necessary permission yet, you get a notification.
What does the owner see after linking?
As soon as the customer or member has linked the record, the services of your organisation automatically appear in their EnergyID account.
- Linked services: your organisation appears under this menu item, with your name and logo. The owner doesn’t see your workspace itself.
- Premium: the record automatically gets Premium as long as it is linked to your workspace. The owner pays nothing for this.
- Dashboards and analyses: dashboard templates and additional analyses your organisation offers automatically appear in the record.
The owner can also link their record to several organisations, for example to their energy cooperative and to their energy supplier.
What is the difference with other records?
Your workspace can contain records of your organisation and external records. The differences:
| Record of your organisation | External record | |
|---|---|---|
| Owner | Your organisation | The customer or member |
| Access for workspace users | According to their role | Only if the owner gave access for help and support |
| Sharing with a guest user | By a workspace administrator or editor | Only by the owner |
| Premium | Yes | Yes, as long as the record is linked |
| Meter data in reports, exports and integrations | Yes | Only with data consent |
| Record diagnostics | Always | Only with access for help and support |
| Messages | To the owner and guest users who subscribed | To the owner and the guest users, only with messaging consent |
Labels and custom fields work for all records in your workspace, including external records. Only workspace users can see them. The owner of an external record doesn’t see them.
Unlink a record
The owner can unlink the record at any time. To do so, they open Linked services in their record, select your organisation and choose Unlink service provider. After confirmation, the link is removed immediately.
As a workspace administrator, you can also remove an external record from your workspace. The owner gets a notification about this in EnergyID.
In both cases:
- The record loses the Premium status it got through your workspace.
- Your organisation’s services are no longer available for that record.
- The record stays Premium if it is still linked to another workspace.
Meter data of the removed record is no longer included in reports that use the data directly. For features that calculate results in advance, such as Collective self-consumption, this doesn’t happen automatically. If needed, start a recalculation yourself through the configuration of that feature.
Frequently asked questions
Can I prepare a record myself and transfer it to the customer or member later?
Yes. You can first create and set up a record yourself, for example with the meters and building characteristics. Then you transfer it to the customer or member.
During the transfer you can choose to keep the record in your workspace as an external record. The customer or member then becomes the owner, while the record stays linked to your workspace. During the transfer, the owner also accepts the permissions your organisation requests.
My business customer already has its own workspace with a subscription. What happens if the record is also linked to my workspace?
The record is then Premium through both workspaces. Both organisations pay the subscription for that record.
Does your customer no longer use its own workspace for other records or services? Then it can stop its own subscription and use EnergyID through your organisation from then on. The record stays Premium as long as it is linked to your workspace.