FAQ

What is the purpose of the Withings SDK?

Withings allows partners to set up and sync devices from their own mobile app, removing the difficulty of setting up the device in the Withings app. Withings Mobile SDK handles both the installation user interface and the technology behind device synchronisation without exposing the technical complexity.

Which Withings devices are compatible with the SDK?

At the moment, the following Withings devices are compatible:

• Withings Body
• Withings Body+
• Withings Move
• Withings BPM Connect
• Withings Sleep
• Withings Pulse HR
• Withings Thermo

Do users need a smartphone?

Yes, the end-users will need a compatible smartphne or tablet to use your application that embeds the Withings SDK.

Is Bluetooth or Wi-Fi required?

During the setup of any devices, the Bluetooth Low Energy (BLE) will be used to communicate with the device. Depending on the type of device, it can be configured to be used using a Wi-Fi network or using the Bluetooth LE of the smartphone. Please refer here to get more information.

How the data is synchronized?

The data is synchronized using the configured network Wi-fi or using the Bluetooth LE of the smartphone (more information). The data is always synchronized with the Withings Cloud whatever the communication method.

Can I synchronize the data locally?

No, the data is always synchronized with the Withings Cloud whatever the communication method. Once the data is synchronized, you need to use the Withings Data API to fetch it and synchronize it with your mobile application.

The setup and the synchronization are managed by the Withings server using the Withings proprietary protocol through an end-to-end encrypted funnel to ensure a high level of data protection. This implementation also keeps the native packages of the Withings SDK as light as possible and avoid regular upgrades of your mobile application. Withings also ensures a full compatibility with the past and future device softwares. In addition, new features can be released without any upgrade of your mobile application.

How long does it take to get the readings after measurement?

In most cases, the synchronization time does not exceed a minute. Please note that a poor internet connection may delay synchronization.

When the data is synced using the Bluetooth, your app needs to be running in the background or foreground for background Bluetooth sync to work. Synchronisation might not work properly if the app is force-killed by the end user. In addition, the smartphone needs to have access to the Internet and be in device's Bluetooth range when synchronising data.

How the data is secured during the transit?

When the synchronization is done over the Wi-Fi, the data is secured in transit using HTTPS 1.2/1.3.

When the synchronization is done using the Bluetooth, it uses the Withings SDK as a proxy and the data transits into a secured TLS 1.3+ funnel encrypted using both Withings device and server TLS certificates.

Can I get the Withings SDK privileges if I don't have a Withings contract ?

No, you must sign a contract before getting the privileges. Please contact us if you are interested in providing the device setup feature in your native iOS and Android app.

How do I get access to the Withings SDK?

Once registered, the partner must send their client ID to Withings by email to authorization-api@withings.com. Withings will notify you when authorisation to use the SDK has been granted.

Does Withings provide a mobile application?

No, Withings only provides the SDK. It is your responsability to develop a mobile application that will embeds the Withings SDK.

Which OS are compatible with the Withings SDK?

The Withings SDK is compatible with:

• Apple iOS 13.0 or higher (Xcode 11+ / Swift 4+)
• Android 7.0 or higher (Androidx)

It is not compatible with any other OS.