Initial integration
This is the technical documentation to get started with the IntelliProve solution, targeted at developers. 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 this documentation, refer to the product documentation.
Notice: This documentation correponds to the latest version of the IntelliProve API (v2). If you are still using IntelliProve API v1, please refer to technical docs - v1. You can verify your version by checking the API Base URL: if it contains "v1," you are on the v1 version of our API.
Four primary types of objects are central to IntelliProve's functionality:
- User: Represents a unique end-user accessing IntelliProve's services. Each User must be created once, enabling IntelliProve to track their Face Scans and build a personalized User Health Profile. Every user is assigned a unique User ID.
- Face Scan: Refers to a single scan performed by a user. Each scan is identified by a unique Face Scan ID. Read more about the Face Scan.
- Biomarkers: Biomarkers are Health Insights associated with a single Face Scan. More detailed info can be found Read more about the Biomarkers.
- Metrics: Metrics are Health Insights derived from the analysis of multiple Face Scans and organized in a Health Profile associated with each User. Read more about the Metrics.
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 created with IntelliProve. This only needs to be done once for each user.
To create 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.
POST /v2/users → Go to the API endpoint for creating a new User
To embed the plug-in within your web platform or mobile app and perform Face Scans, you will need to request an authenticated URL via the API. This URL is linked to a specific user and is valid for 6 hours.
GET /v2/userjourneys/scan → Request the Plug-in URL using the API
With the Plug-In URL, you can now embed the Plug-in component in your web platform or mobile app.
We provide detailed guides to embed the Plug-in based on your platform. → Go to the 'Embed plug-in' documentation
Once the Plug-in is embedded in your platform, you can start performing Face Scans.
You can request the the Biomarkers related to the latest Face Scan(s) of the user via the API.
GET /v2/face_scans/latest → Get the Biomarkers of the latest Face Scan(s) using the API
Alongside the results determined during a specific Face Scan, the Biomarkers, IntelliProve also provides longer term, deeper assessments, i.e. the user's health Metrics. These are organized in the user's Health Profile.
GET /v2/userprofiles/:profile → Get the user's health metrics
For more information, refer to our dedicated page for fetching and visualizing health metrics.
Want to customise the UI/UX of the solution? -> Customize the appearance of the Plug-in