This article explains the different IDs used in the Smartvatten platform and API, and how they can be used when integrating with Smartvatten data.

To help identify Smartvatten devices, water meters, and premises consistently across systems, several types of IDs are available through the API.

The ID is assigned when a Smartvatten device is connected to a premise and remains unchanged throughout its lifecycle. In most cases, this ID matches the Meter Serial. If a Meter Serial is not available, the Device ID is used instead. While the ID can be used for identification purposes, it is generally not recommended as the primary identifier when building integrations.

The Device ID is the unique identifier of the Smartvatten device itself.

This value remains unchanged unless the physical Smartvatten device is replaced. For integrations, the Device ID is the recommended primary identifier.

The Meter Serial is the serial number of the physical water meter.

Customers are responsible for providing meter serial numbers to Smartvatten. This information can only be added or updated by Smartvatten.

The Meter Serial should only be used for identifying the water meter and not for other integration purposes.

The Custom ID is a customer-defined identifier that can be assigned to each meter.

It can be used for internal tracking, reporting, or integration purposes based on customer requirements. Customers can add and modify Custom IDs directly in the Smartvatten HUB.

The External ID is used to link a premise in Smartvatten with a corresponding identifier in a customer's or partner's system.

This is particularly useful when integrating with platforms that use their own property, building, or location identifiers.

External IDs can only be added or updated by Smartvatten.

A current list of all meters connected to your API key is available through the /data/meters endpoint.

When building an integration with the Smartvatten API, we recommend querying this endpoint regularly, for example on a weekly basis, to ensure any changes to meter information or identifiers are reflected in your system.

For more information about data integrations and available integration options, please explore the other articles in this section. If you need further assistance, contact integrations@smartvatten.com.