---
title: Biomarker
slug: technical-docs/biomarker
icon: 🔹
docTags: 
createdAt: 2026-03-23T15:58:48.904Z
---

# Intro

A **biomarker** displays an objective indicator of health captured during a Face Scan, such as heart rate or respiratory rate. If a measurement was performed on a previous day, the previous value will be shown in the footnote.&#x20;

This component is essential for usecases where immediate, real-time feedback on specific health parameters is desired. It’s designed for quick, actionable insights. Integrate it within your platform to give users a clear, snapshot view of a particular aspect of their health.

:::Iframe{iframeHeight="0" code="<iframe &#xA;    srcdoc='&#xA;        <html lang=&#x22;en&#x22; class=&#x22;size-full&#x22;>&#xA;            <head>&#xA;                <meta charset=&#x22;UTF-8&#x22; />&#xA;                <meta name=&#x22;viewport&#x22; content=&#x22;width=device-width, initial-scale=1.0&#x22; />&#xA;                <script src=&#x22;https://cdn.jsdelivr.net/npm/@tailwindcss/browser@4&#x22;></script>&#xA;                <script type=&#x22;module&#x22; src=&#x22;https://cdn.intelliprove.com/packages/intelli-widgets/v3/latest.js&#x22;></script>&#xA;                <style>&#xA;                    @import &#x22;tailwindcss&#x22;;&#xA;                    :root { --tw-border-style: solid; }&#xA;                    @layer base { ip-session, ip-session * { all: revert-layer; } }&#xA;                    body { margin: 0; display: flex; justify-content: center; align-items: center; min-height: 100vh; }&#xA;                </style>&#xA;            </head>&#xA;            <body>&#xA;                <ip-session class=&#x22;flex&#x22; action-token=&#x22;demo&#x22;>&#xA;                    <ip-biomarker></ip-biomarker>&#xA;                </ip-session>&#xA;            </body>&#xA;        </html>&#xA;    '&#xA;    style=&#x22;width: 100%; height: 120px;&#x22;&#xA;></iframe>"}

:::



:::hint{type="info"}
**Learn more**

****[→  What are biomarkers?](docId\:Buhj-Nt45FUXCPgeS0qPH)&#x20;
:::

# Set-up

The Biomarker widget is available under the HTML tag `ip-biomarker`. Ensure to nest it somewhere within your `ip-session` , as described in the [Set-up](docId\:ftRgwNTKfclUm0_V_Effj) documentation.

### Properties

| ****     | **Requirement**                               | **Description**                                                                                                                                                                                                                                                                                                                   | **Default value**               |
| -------- | --------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------- |
| **type** | <font color="#0C121D">**r****equired**</font> | `"heart-rate" \| "heart-rate-variability" \| "respiratory-rate" \| "resonant-breathing-score" \| "blood-pressure"`<br /><br />Selects the biomarker you want to display. Note that blood pressure is not divided into separate types; both systolic and diastolic values are combined into a single biomarker `"blood-pressure"`. | <font color="#6b7280">––</font> |

### Usage

```html
<ip-session 
	action-token="eyJhbG..."
	language="en-GB" 
>
  <!-- IntelliProve components go here -->
  <ip-biomarker type="heart-rate"></ip-biomarker>
</ip-session>
```

