This is the technical documentation to get started with the IntelliProve solution. A stepwise approach to get started quickly is given in the next section.

For an overview of the different concepts, functionalities and features referred to in the next pages, refer to the product documentation.

Four primary types of objects are central to IntelliProve's functionality:

By associating Face Scans with users, IntelliProve ensures accurate tracking and meaningful health insights. The relation between the differet objects is displayed in the figure below.



The typical flow to let users perform Face Scans with the IntelliProve Plug-in and fetch the corresponding results and health insights involves five simple steps, as shown in the figure below.



To request a Face Scan URL, the user performing the scan must be registered with IntelliProve. This only needs to be done once for each user. For users that have already performed Face Scans before – and thus area already registered – you can skip this step.

To register a user via the API, you must provide a unique ID for the user as a query parameter external_user_id. The response of the call will contain the IntelliProve user_id, which is the pseudonimized user ID IntelliProve uses internally to keep track of the user's Face Scans and Health Profile.

You can use either the external_user_id or the user_id in other API calls when specifying the user.

To embed the plug-in within your web platform or mobile app and perform Face Scans, you will need an authenticated URL. This URL is linked to a specific user and is valid for 6 hours.

With the Plug-In URL, you can now embed the Plug-in component in your web platform or mobile app.

Once the Plug-in is embedded in your platform, you can start performing Face Scans.

In order to obtain the Biomarkers corresponding to a face scan, you'll need the ID of the Face Scan. This is the unique reference to the Face Scan that the user performed.

You can obtain the Face Scan ID by listening to events generated by the Plug-in. The faceScanSuccessful event is generated when the Face Scan is completed successfully and signals that the results are ready. The event JSON message contains the Face Scan ID.

With the Face Scan ID, you can now request the results of the Face Scan – i.e. the Biomarkers – using the API.

For more elaborate information on how the different ways to fetch the Health Insights, go to the page Fetch and visualise insights .

Next to the results of the specific Face Scan, the Biomarkers, IntelliProve also provides longer term insights and broader assessments, i.e. the user's health Metrics. These are organized in the user's Health Profile.