# Rest API ## Introduction The IntelliProve API is organised around [REST](http://en.wikipedia.org/wiki/Representational_State_Transfer). Our API has predictable resource-oriented URLs, accepts [JSON-encoded](https://en.wikipedia.org/wiki/JSON) request bodies, returns [JSON-encoded](http://www.json.org/) responses, and uses standard HTTP response codes, authentication, and verbs. ```text https://engine.intelliprove.com ``` _Examples:_ POST [https://engine.intelliprove.com/v2/users](https://engine.intelliprove.com/v2/users) GET [https://engine.intelliprove.com/v2/users](https://engine.intelliprove.com/v2/users) If you’re new to this developer portal, we recommend starting with the [product documentation](https://docs.intelliprove.com/product-docs) to get familiar with the main product concepts and functionalities. To integrate the plug-in into your platform and get started performing [Face Scans](https://docs.intelliprove.com/product-docs/face-scan-plug-in), follow our [Getting started](https://docs.intelliprove.com/technical-docs/getting-started) guide. ## Authentication The IntelliProve API supports both **API keys** and JWT **Action Tokens** to authenticate HTTP requests. All API requests must be made over [HTTPS](http://en.wikipedia.org/wiki/HTTP_Secure). Calls made over plain HTTP will fail. Authentication and permission roles are defined per resource. The API key provides full access, while an action token provides a temporary form of authentication only compatible with a selection of the API endpoints. Refer to the table below for an overview. ![](https://docs.intelliprove.com/_astro/7voyzcCJ7bCX7ihjTmWGO_image.Dya1xMqH_2pt2on.webp) ### API Keys API Keys are distributed when you sign up for a plan with IntelliProve. They can’t be created manually. Upon agreement, you’ll receive at least two API keys. Development API keys, which can be used during development, are aliased with a “-DEV” suffix. | **Alias** | **API Key** (non-working examples) | | --- | --- | | COMPANY\_NAME-DEV | `KUsWnp2vRGCfW8XPYJZeQdh-eT!n-Ms.UcyaETy3` | | COMPANY\_NAME | `fWeBpZ9CKaKb7pnk@vGtkQDjZFQ_U2g@GZu_Z74X` | API keys should be provided using **Header-based API Key Authentication**: HTTP Headers ```text x-api-key: ``` Your API keys carry many privileges and have no expiry date, so be sure to **keep them secure**! Do not share your secret API keys in publicly accessible areas such as GitHub, client-side code, and so forth. #### U**ser linking when using API keys** Some API resources are user-specific, which means they are tied to a [User](https://docs.intelliprove.com/technical-docs/rest-api#users). When accessing these resources with **API Key authentication**, you must explicitly specify **which user** the request should apply to. This is done by providing the **External User ID** in the request. Specify the `external_user_id` using a **query parameter**: ```text "&external_user_id=" ``` Or, specify `external_user_id` using a **body parameter**: Request Body ```json { "user_external_id": "", ... } ``` How to provide the `external_user_id` depends on the type of endpoint. Each endpoint clearly specifies whether it should be provided as query parameter or body parameter. ### Action Tokens Action tokens can be created using the IntelliProve API with a valid API key. Use the [Create user action token](https://docs.intelliprove.com/technical-docs/rest-api#create-user-action-token) endpoint to do this. Unlike API keys, User Action Tokens are always linked to a [User](https://docs.intelliprove.com/technical-docs/rest-api#X4Z5G), specified when creating the action token. Provide the action token in your request using the **Header-based Token Authentication**: HTTP Headers ```text Authorization: Token ``` #### When to use Action tokens are specifically designed to be used in frontend code, as they have restricted access and automatically expire after a predefined timespan. However, they may also be used in backend code for certain usecases. Action tokens can be used **for selected API endpoints** — an overview can be found in the table under [Authentication](https://docs.intelliprove.com/technical-docs/rest-api#authentication). When using an action token, the `external_user_id` should not be specified in the request anymore, since it is already embedded in the token. When using action tokens, always created the token right before a User performs an **action** in your front-end – hence the name _**Action Token.**_ This action token can be used while the user is performing the action (for example, consult the results of a Face Scan). If a user leaves a page and does another action, a new action token should be created. ### **Authentication Summary** | | **API key** | **Action token** | | --- | --- | --- | | **Scope** | Full access to all data. | Limited access to user-specific data. | | **Lifetime and creation** | Created when you sign up for a plan. Does not expire. | Created by you using your API key. Expires after a few hours. Recommended to create and use within the scope of a user’s action(s) on a page of your application. | | **Usage** | Used for M2M communication. | Used for performing action induced by the frontend. | | **Link to user** | Link manually via `external_user_id`. | Automatically linked, `external_user_id` should not be passed in the request. | ## Localisation ### Languages Some endpoints support localized content. You can request a specific language by providing the language code in the relevant parameter | **Language** | **Code** | | --- | --- | | Dutch | nl | | Danish | da | | English | en | | French | fr | | German | de | | Spanish | es | | Swedish | sv | When no language is provided, the default language is used. ### Unit systems IntelliProve supports both the metric and imperial unit system for displaying data to users. All data is stored in the metric system but can be converted to the imperial unit system if desired. The preference can be set for your entire account as a customer, or per user. If no preference is set, all responses default to the metric unit system. #### Order of unit system selection ![](https://docs.intelliprove.com/_astro/0KtnMO_jibFrgUCkvF2uD_image.Dy4js0V7_nB6rN.webp) The preferred account-wide unit system setting can be communicated with your Customer Success Manager. A user’s preferred unit system can be set using the [Users](https://docs.intelliprove.com/technical-docs/rest-api#users) endpoints. ### Errors In general, Status Codes in the **2xx** range indicate success. Codes in the **4xx** range indicate an error that failed given the information provided (e.g., a required parameter was omitted or the request format is invalid, etc.). Codes in the **5xx** range indicate an error with IntelliProve’s servers. | **Status Code** | **Description** | | --- | --- | | 200 - _OK_ | Everything worked as expected | | 204 - _No Content_ | The request is correct, but there is no content to be returned | | 400 - _Bad Request_ | The request was unacceptable | | 401 - _Not Authorized_ | No valid authentication provided | | 403 - _Forbidden_ | Invalid permissions to perform the request | | 404 - _Not Found_ | The request resource or endpoint does not exist | | 422 - _Unprocessable_ | One or more fields in the request body are invalid | | 500, 502, 503 - _Server Errors_ | Something went wrong on our end | The **4xx** and **5xx** errors can be handled programmatically and include an error description that briefly explains the error reported. Error Format ```json { "detail": "User not found!" } ``` An exception is made for the **422** errors, which give detailed information on which request parameter failed the validation. Validation Error Format ```json { "detail": [ { "loc": [ "body", "data" ], "msg": "field required", "type": "value_error.missing" } ] } ``` ## Users **The User Object** A User is a unique end-user accessing IntelliProve’s services through your platform or app. Each User must be created once, enabling IntelliProve to track their Face Scans and build a personalized Health Profile. When creating a user, you choose your own `external_user_id` (referred to as “External User ID”). Make sure it is an **URL-encoded value**. Once created, you can reference Users by their `external_user_id`. | **User object properties** | **Description** | | --- | --- | | `user_id` _uuid_ | Unique, IntelliProve internal User ID, assigned to each end user. | | `external_user_id` _nullable string_ | The unique ID you choose when creating an IntelliProve User. Stored in your own backend and used when requesting user data. Referred to as **External User ID** in the documentation. | | `customer` _read-only string_ | Your company’s name, which the end user is linked to. | | `birth_date` _nullable date object_ | Date of birth in YYYY-MM-dd format | | `sex` _nullable string enum_ | Sex at birth Values: “M”, “F” | | `language` _nullable string enum_ | Two-letter language code Values: “en”, “nl”, “fr”, “da”, “sv” | | `preferred_unit_system` _nullable string enum_ | The preferred unit system for this user. Values: “metric”, “imperial” | **Note on External User IDs** We do not store the values you provide for the `external_user_id` directly. We only store a hashed version of the value you provided. This “security first”-approach is great for privacy and safety, but it does limit us from returning the value of `external_user_id` back to you. So make sure that you use a **unique** and **persisted** value for the `external_user_id` that you provide. The user’s email address could be a good example of this. The External User ID can be changed after creating a user. See: [Update existing User](https://docs.intelliprove.com/technical-docs/rest-api#update-existing-user) ### Create new User POST`https://engine.intelliprove.com/v2/users` Create a new user with the provided user details. Header parameters
x-api-keystringrequiredYour API key
Body parameters
external_user_idstringrequiredExternal User ID, chosen when creating the user
birth_datestringoptionalUser birth date in YYYY-MM-dd notation
sexstringoptionalSex at birth value (M or F)
languagestringoptionalTwo-letter language code for preferred user language (default: en)
preferred_unit_systemstringoptionalThe preferred unit system for this user. "metric" or "imperial"
Response **201** ```json { "user_id": "df55e9ab-77b9-4b32-bd83-d76de23f6f3d", "customer": "", "external_user_id": "your_user_id", "birth_date": "1964-01-12", "sex": "M", "language": "en", "preferred_unit_system": "imperial" } ``` **401** ```json { "detail": "Missing or invalid authentication credentials." } ``` The `external_user_id` parameter is your own unique ID for the user. The `language`parameter can be used to set the user’s preferred language. If it is, this language will be used as default language for that user, e.g. when displaying widgets or for a [plug-in](https://docs.intelliprove.com/technical-docs/plug-in-url) component, without having to explictly provide it there anymore. * * * ### Get User Details GET`https://engine.intelliprove.com/v2/users` Get user details by user ID or external user ID. Query parameters
external_user_idstringrequiredExternal User ID, chosen when creating the user
Header parameters
x-api-keystringrequiredYour API key
Response **200** ```json { "user_id": "df55e9ab-77b9-4b32-bd83-d76de23f6f3d", "customer": "", "birth_date": "1964-01-12", "sex": "M", "weight": { "value": 91, "unit": "kg" }, "height": { "value": 183, "unit": "cm" }, "hypertension": 1, "language": "en", "preferred_unit_system": "metric" } ``` **401** ```json { "detail": "Missing or invalid authentication credentials." } ``` * * * ### Update existing User PUT`https://engine.intelliprove.com/v2/users/:user_id` Update a User's information. All fields that are not provided in the body will be left unchanged. Path parameters
user_idstringrequiredIntelliProve internal User ID. Obtain via 'Get User Details' endpoint.
Header parameters
x-api-keystringrequiredYour API key
Body parameters
external_user_idstringoptionalNew external User ID
birth_datestringoptionalUser birth date in YYYY-MM-dd notation
sexstringoptionalSex at birth value (M or F)
languagestringoptionalTwo-letter language code for preferred user language (default: en)
Response **200** ```json { "user_id": "df55e9ab-77b9-4b32-bd83-d76de23f6f3d", "customer": "", "birth_date": "1964-01-15", "sex": "F", "language": "nl", "preferred_unit_system": "metric" } ``` **401** ```json { "detail": "Missing or invalid authentication credentials." } ``` You can obtain the IntelliProve`user_id` via the the ‘Get User Details’ API endpoint, providing your own unique ID for the user via the`external_user_id` parameter. * * * ### Create user action token POST`https://engine.intelliprove.com/v2/users/authenticate` Create a new action token for a user based on the external user ID. Header parameters
x-api-keystringrequiredYour API key
Body parameters
external_user_idstringrequiredExternal User ID, chosen when creating the user
Response **201** ```json { "token": "" } ``` **401** ```json { "detail": "Missing or invalid authentication credentials." } ``` * * * ### Delete user DELETE`https://engine.intelliprove.com/v2/users/` Delete all user data, including user profiles and face scan results, based on the user ID. Query parameters
user_idstringrequiredIntelliProve internal User ID. Obtain via 'Get User Details' endpoint.
Header parameters
x-api-keystringrequiredYour API key
Response **401** ```json { "detail": "Missing or invalid authentication credentials." } ``` ## Face Scan 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 and can be done with the [Create New User](https://docs.intelliprove.com/technical-docs/rest-api#create-new-user) API endpoint. To create the user, you must provide a unique reference for the user as a query parameter: `external_user_id`. ### Get Face Scan URL GET`https://engine.intelliprove.com/v2/userjourneys/scan` Get the Face Scan URL for a specific user based on the user ID or external user reference. Query parameters
external_user_idstringrequiredExternal User ID, chosen when creating the user
languagestringoptionalTwo-letter language code for overriding user-level preferred language
Header parameters
x-api-keystringrequiredYour API key
Response **200** ```json "" ``` **401** ```json { "detail": "Missing or invalid authentication credentials." } ``` **Note**: The URL provided in the response may change over time. This applies not only to the `action token`, which is unique for each request, but also to the subdomain, which may update with new versions of the plug-in. To prevent issues, avoid hardcoding any part of the URL. Always use the full response URL as provided. Additionally, ensure that your HTML security headers (e.g., Content Security Policy headers) allow all **intelliprove.com** subdomains. This is essential for the proper functioning of the IntelliProve plug-in and future updates. Please note that the `language`, when specified here, overrides the default language set for the user, specified when [creating the user](https://docs.intelliprove.com/technical-docs/rest-api#create-new-user). ## Biomarkers ### Get Face Scan Biomarkers GET`https://engine.intelliprove.com/v2/face_scans/:face_scan_id` Get Biomarkers for a specific Face Scan, using the Face Scan ID. Path parameters
face_scan_idStringrequiredFace Scan UUID
Query parameters
external_user_idstringrequiredExternal User ID, chosen when creating the user
Header parameters
x-api-keystringrequiredYour API key
Response **200** ```json { "face_scan_id": "ea23e5cd-22c8-1e54-bd82-e89de12a7e1b" "heart_rate": 56, "respiratory_rate": 12, "heart_rate_variability": 123, "resonant_breathing_score": 18, "systolic_blood_pressure": 128, "diastolic_blood_pressure": 77, "timestamp_epoch": 1742919213, "timestamp": "2025-03-25T17:13:33.147258+01:00" } ``` * * * ### Get multiple Face Scan Biomarkers GET`https://engine.intelliprove.com/v2/face_scans/` Get the Biomarkers from multiple Face Scans of a user by specifying start date, end date and count. The user is specified through the action token. Query parameters
startstringoptionalStart date, all returned face scans will be after this date time. ISO Format
endstringoptionalEnd date, all returned face scans will be before this date time. ISO Format
orderstringoptionalOrder of the returned face scans: 'asc' or 'desc'. Default: 'asc'
countstringoptionalMax number of face scans to return. Defaults to 10.
external_user_idstringoptionalExternal User ID, chosen when creating the user
Header parameters
x-api-keystringrequiredYour API key
Response **200** ```json [ { "face_scan_id": "ea23e5cd-22c8-1e54-bd82-e89de12a7e1b" "heart_rate": 65, "respiratory_rate": 12, "heart_rate_variability": 123, "resonant_breathing_score": 18, "systolic_blood_pressure": 128, "diastolic_blood_pressure": 77, "timestamp_epoch": 1742919213, "timestamp": "2025-03-25T17:13:33.147258+01:00" }, ... ] ``` * * * ### Get Latest Face Scan Biomarkers GET`https://engine.intelliprove.com/v2/face_scans/latest` Get the Biomarkers from the latest Face Scan(s) of a user. The user is specified through the action token. The count can be specified to request more than one Face Scan. Query parameters
countstringoptionalLast x number of measurements. Default = 1
external_user_idstringrequiredExternal User ID, chosen when creating the user
Header parameters
x-api-keystringrequiredYour API key
Response **200** ```json [ { "face_scan_id": "ea23e5cd-22c8-1e54-bd82-e89de12a7e1b" "heart_rate": 65, "respiratory_rate": 12, "heart_rate_variability": 123, "resonant_breathing_score": 18, "systolic_blood_pressure": 128, "diastolic_blood_pressure": 77, "timestamp_epoch": 1742919213, "timestamp": "2025-03-25T17:13:33.147258+01:00" }, ... ] ``` ## Metrics Use this endpoint to get Health Metric data for users. ### Get Health metrics GET`https://engine.intelliprove.com/v2/metrics` Get the metrics for a single user. Query parameters
external_user_idstringrequiredExternal User ID, chosen when creating the user
Header parameters
x-api-keystringrequiredYour API key
Response **200** ```json { "metrics": { "energy_balance": { "score": 82.13, "confidence": 80.0 }, "general_fitness": { "score": 71.08, "confidence": 60.0 }, "hypertension": { "score": 92.0, "confidence": 33.33 }, "mental_health_risk": { "score": 49.85, "confidence": 66.67 }, "mental_stress": { "score": 86.56, "confidence": 70.0 }, "sleep_quality": null }, "last_update": "2025-10-13T14:49:02.111245+02:00" } ``` **400** ```json { "detail": "Invalid UUID provided!" } ``` All `score` and `confidence` values are percentages between 0 and 100, accurate to 2 decimal places. If a metric is `null`, like `sleep_quality` in the example above, no data is available for this user on this metric. ## Wellbeing topics Get scores related to the different [wellbeing topics.](https://docs.intelliprove.com/product-docs/understanding-wellbeing-topics) ### Get wellbeing scores GET`https://engine.intelliprove.com/v2/userprofiles/wellbeing` Get all the wellbeing scores for a user. A score is a value between 0-100, representing a percentage, per topic. The user is specified through the action token. Query parameters
external_user_idstringrequiredExternal User ID, chosen when creating the user
Header parameters
x-api-keystringrequiredYour API key
Response **200** ```json { "mental": , // e.g. 82 "physical": , // e.g. 82 "energy_sleep": , // e.g. 82 "status_label":