Vital Link API covers only cloud-based providers.

Your mobile app has to manage connections with SDK-based providers — such as Apple HealthKit and Android Health Connect — through the Vital Mobile Health SDK, separately from Vital Link.

The Vital Link flow starts when a user wants to connect a wearable device with Vital. An overview of the process can be found below.

1

Pre-requisites

Make sure that:

  1. You have your Vital API Key dashboard ready to use.

  2. You have created a Vital User that corresponds to a user in your domain. See for an example.

2

Generate a Link Token

Call the Generate a Link Token endpoint with the target User ID using your Vital API Key.

3

Initiate the Link Flow

The API response provides a short-lived Link Token (link_token), as well as a Web URL (link_web_url).

You can use the Web URL to launch the Vital Link Widget directly. Alternatively, you can use the Link Token in concert with the Vital Link API to build your custom Link Widget experience.