{
    "tenantId": "e0736b86-[....]-e0396846f1f8",
    "type": "SmartMeter",
    "manufacturer": "Fluvius",
    "ean": "123987000009876543",
    "properties": {
      "flow": "B2C" 
    }
}

​
What you’ll need

  • Your API credentials and a Tenant or Collective ID
  • The European Article Number (EAN) for the smart meter
  • A way to reach out to the meter’s owner for consent
  • The meter’s owner needs a Fluvius account to provide consent

​
Getting access to ‘Mijn Fluvius’

The meter has to be linked with a ‘Mijn Fluvius’ account. More information can be found on Fluvius’ website.

​
Let’s get started

1

Start the onboarding process

Create an Entity Onboarding Request, setting the to SmartMeter and to Fluvius.

You’ll also need to specify its as a unique device identifier, and an additional object specifing whether the meter is owned by an individual or a business.

​
type
enum<string>
required
​
manufacturer
string
required
​
ean
string
required
​
properties
object
required

Lastly, you may need to include either a or to complete the request.

2

Check for required actions

In most cases, the onboarding request will have the Pending until a required is completed.

Fluvius always requires an action of Redirect. Such actions contain a . You can redirect your user here or share this link directly with the meter’s owner to complete the action.

Response (Body)
{
    "id": "3c90c3cc-[....]-8dd25736052a",
    "status": "Pending",
    "requestType": "Entity",
    "action": {
        "type": "Redirect",
        "redirectLink": "<string>"
    },
    "data": {
        ...
    }, ...
}
​
action
object
3

Track the onboarding status

Periodically poll the Onboarding API to check if the status of your request has updated to Succeeded. Once it’s complete, you’ll find the newly created Entity and its ID in the object.

You can reference the when using our Readings API, Commands API, and our Charge Sessions API.

{
   "id": "3c90c3cc-[....]-8dd25736052a",
   "status": "Succeeded",
   "data": {
       "entity": {
           "id": "3c90c3cc-[...]-8dd25736052a",
           ...
       },
   }, ...
}

​
Good to know

  • Readings might not be available right away. After the Entity was onboarded successfully, it may take up to 2 days before you start seeing Readings due to manufacturer limitations.

​
Work with your newly created Entity

Tip: Take note of your Entity ID before you get started with our APIs.

Readings API

List meter readings.

{
    "tenantId": "e0736b86-[....]-e0396846f1f8",
    "type": "SmartMeter",
    "manufacturer": "Fluvius",
    "ean": "123987000009876543",
    "properties": {
      "flow": "B2C" 
    }
}