> ## Documentation Index
> Fetch the complete documentation index at: https://docs.anivahealth.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Embed-sessie aanmaken

> Een eenmalige URL ophalen die de labresultaten van een profiel in je app toont

Haal een URL op die de labresultaten van één profiel als alleen-lezen pagina toont. Open de URL in een WebView van je app of in een browsertabblad. Roep dit endpoint vanaf je server aan telkens wanneer de gebruiker de resultaten opent, en cache de URL nooit.

Vereist de scopes `embed` en `results_view` op een profielgroep van het profiel. Aniva kent de scope `embed` op aanvraag toe. Zonder een van beide scopes geeft het verzoek `403` terug.

> [!NOTE]
>
> De URL werkt één keer en 5 minuten lang. Zodra deze opent, start de pagina een sessie van
> 60 minuten die alleen voor die pagina geldt. Archiveer je API-sleutel om elke open pagina meteen
> te sluiten.

## Verzoek

### Padparameters

**id** `string` *required*

Unieke identifier (UUID) van het profiel waarvan de pagina de resultaten toont.

### Body

De body is optioneel. Zonder body opent de URL de lijst met biomarkers in de taal van het profiel.

**language** `string`

Taal van de pagina: `en`, `bg`, `ca`, `cs`, `da`, `de`, `el`, `es`, `et`, `fi`, `fr`, `ga`, `hr`, `hu`, `is`, `it`, `lb`, `lt`, `lv`, `mt`, `nl`, `no`, `pl`, `pt`, `ro`, `ru`, `sk`, `sl`, `sr`, `sv`, `tr` of `uk`. Standaard: de taal van het profiel.

**route** `object`

De pagina die de URL opent. Standaard: `{ "name": "biomarkers" }`. Elke andere `name` geeft `400` terug.

**vrijgegeven pagina's**

**name** `string` *required*

Een van:

* `biomarkers`: de lijst met alle biomarkers en hun nieuwste resultaten.
* `biomarker`: de detailpagina van één biomarker, met trend, bereiken en uitleg. Vereist `biomarker_id`.
* `twin`: het 3D-lichaam met een cijfer per gezondheidsgebied. De gebruiker kiest een gebied om de bijbehorende biomarkers te zien.

**biomarker\_id** `integer`

Alleen voor `biomarker`. Het `biomarker_id` van de biomarker, zoals in de resultaten, bijvoorbeeld `104`. Gebruik het id, niet de slug: een slug kan veranderen, het id blijft gelijk.

**report** `object`

Beperkt elke pagina tot één labrapport van het profiel. Standaard: alle rapporten van het profiel.
Stuur precies één van de drie id's mee. De lijst, de trend van een biomarker en de Twin tonen dan
alleen de resultaten van dat rapport, en de pagina verbergt het afsprakenfilter. De gebruiker kan
met deze URL geen ander rapport openen.

**eigenschappen**

**appointment\_id** `string`

Het `id` van een afspraak van het profiel. Je sleutel moet er toegang toe hebben, net als bij
[Labresultaten ophalen](https://docs.anivahealth.com/nl/api/appointments/get-results.md). Zo niet, dan geeft dit endpoint
`404` terug, niet `403`.

**home\_kit\_order\_id** `string`

Het `id` van een thuistestkitbestelling van het profiel. Je sleutel moet er toegang toe hebben,
net als bij [Labresultaten ophalen](https://docs.anivahealth.com/nl/api/home-kit-orders/get-results.md) voor
thuistestkitbestellingen, en heeft ook `home_kit_orders_view` of `home_kit_orders_manage` nodig.

**document\_id** `string`

Het `id` van een labrapport dat je voor het profiel hebt geüpload met
[Document uploaden](https://docs.anivahealth.com/nl/api/documents/upload-document.md). Je sleutel moet er toegang toe hebben,
net als bij [Documentresultaten ophalen](https://docs.anivahealth.com/nl/api/documents/get-document-results.md). Zo niet, dan
geeft dit endpoint `404` terug, niet `403`. De pagina toont de datum van de labtest, of de
uploaddatum als er nog geen waarde is uitgelezen. Zolang Aniva het document uitleest en nog
geen waarde heeft, vraagt elke pagina de gebruiker om deze over een paar minuten opnieuw te
openen.

**appearance** `object`

Het uiterlijk van de pagina. De API voegt dit als zoekparameters toe aan de URL.

**eigenschappen**

**theme** `string`

`light` of `dark`. Standaard: de systeeminstelling van het apparaat.

**primary\_color** `string`

Hexkleur van knoppen en links, 3 of 6 tekens, met of zonder `#`, bijvoorbeeld `0f766e`.
Standaard: de merkkleur van je profielgroep, anders Aniva-oranje. Knoppen houden witte tekst,
dus kies een donkere kleur.

**show\_logo** `boolean`

Toon het logo van je profielgroep boven de resultaten. Standaard: `true`.

> [!TIP]
>
> Je kunt de weergaveparameters ook zelf toevoegen aan een teruggegeven URL, vóór het
> `#token=`-fragment: `theme=light|dark`, `primary=<hex>` en `logo=0`. De pagina negeert een
> ongeldige waarde. De afbeelding van het logo komt altijd uit je profielgroep, nooit uit de URL.

## Respons

Bij succes geeft de API `201 Created` terug.

**url** `string` *required*

De URL van de pagina. Het starttoken staat in het `#token=`-fragment, zodat een browser het
nooit naar een server stuurt. Open de URL één keer.

**expires\_at** `string` *required*

ISO 8601-tijdstip waarna de URL niet meer kan worden geopend.

De sessie is niet aan één pagina gebonden. Binnen de embed kan de gebruiker van de Twin naar een biomarker gaan en schakelen tussen de lijst en de detailpagina's. De pagina toont alleen labresultaten: deze toont geen waarden die Aniva berekent, bestanden, chat of instellingen.

## Foutresponsen

| Status | Beschrijving |
| - | - |
| `400` | Validatiefout — ongeldig profiel-ID, onbekende `route.name`, ongeldig `biomarker_id`, ongeldige kleur of een `report` zonder precies één geldige UUID. |
| `403` | Geen toegang — je API-sleutel mist de scope `embed` of `results_view`, of de thuistestkit-scope voor een rapport van een thuistestkitbestelling, of het profiel valt buiten je toegangscontext. |
| `404` | Profiel niet gevonden, of geen enkele biomarker heeft dit `biomarker_id`, of het `report` is geen afspraak, thuistestkitbestelling of geüpload document van dit profiel, of het rapport valt buiten je toegang. Dit endpoint geeft `404` terug, niet `403`, zodat niet zichtbaar is dat het rapport bestaat. |
| `500` | Interne serverfout. |

```bash cURL theme={null}
curl --request POST \
  --url https://anivahealth.com/api/v1/profiles/a3f1c2d4-8b7e-4f2a-9c1d-2e3f4a5b6c7d/embed-sessions \
  --header 'x-api-key: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "language": "de",
    "route": { "name": "biomarker", "biomarker_id": 104 },
    "report": { "appointment_id": "8d2e4f6a-1b3c-4d5e-9f70-a1b2c3d4e5f6" },
    "appearance": { "theme": "light", "primary_color": "0f766e" }
  }'
```

```bash One uploaded document theme={null}
curl --request POST \
  --url https://anivahealth.com/api/v1/profiles/{id}/embed-sessions \
  --header 'Authorization: Bearer <api_key>' \
  --header 'Content-Type: application/json' \
  --data '{
    "report": { "document_id": "3f9a7c2e-5d4b-4e1a-8c6f-0b1d2e3f4a5b" }
  }'
```

```json 201 theme={null}
{
  "url": "https://anivahealth.com/de/embed/biomarkers/vitamin-d?theme=light&primary=0f766e#token=eyJwdXJwb3NlIjoiZW1iZWRfbGF1bmNoIi4uLn0.k7Qm2V0sZ1yH",
  "expires_at": "2026-11-19T20:17:43.000Z"
}
```

```json 400 theme={null}
{
  "error": "route.name: Invalid discriminator value. Expected 'biomarkers' | 'biomarker' | 'twin'"
}
```

```json 403 theme={null}
{
  "error": "Access denied: profile is outside your permission scope"
}
```

```json 404 theme={null}
{
  "error": "Appointment not found"
}
```

```json 404 document theme={null}
{
  "error": "Document not found"
}
```


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.