Reference
Parameters
Every script tag attribute and JS API property of the Symptom & Illness Check App.
HTML attributes are used with the script embed, JS properties with the JS API. A dash means the option is not available in that method.
| HTML attribute | JS property | Type | Required | Description |
|---|---|---|---|---|
client-id | clientId | string | yes | Your Client Id. |
webapp-code | webappCode | string | yes | Your Web App Code. |
auth-code | authCode | string | yes | A fresh auth code for each page load — see Authentication. |
| — | targetContainerId | string | yes (JS API) | The id of the element the app is rendered into. |
state | state | string (UUID) | no | Your own identifier, returned in the webhook. It only arrives there when your server signed the auth code with the same value and scope=state — see Webhooks and your own identifier. |
check-id | checkId | string (UUID) | no | Opens an existing check by its id instead of starting a new one. |
app-language | appLanguage | string | no | The app's language — see Language. |
birth | customization.birth | string (YYYY-MM-DD) | no | Prefilled date of birth — see Profile data. |
gender | customization.gender | male | female | no | Prefilled gender — see Profile data. |
direct-check | customization.directCheck | SYMPTOM_CHECK | ILLNESS_CHECK | no | Skips the choice of check type — see Start with a check. |
direct-check-main-symptom-id | customization.directCheckMainSymptomId | string (UUID) | no | Starts a symptom check with this main symptom — see Start with a symptom. |
onboarding | customization.onboarding | boolean | no | Shows an onboarding page first — see Onboarding. |
compact-mode | customization.compactMode | boolean | no | Hides the logo and side-menu button in the header — see Compact mode. |
color-scheme | customization.colorScheme | light | dark | auto | no | The colour scheme — see Colour scheme. |
| — | customization.colors | object | no | Your own colours for the light and dark scheme — see Your own colours and Colour keys. |
| — | customization.onReportShown | function | no | Called with { reportData, checkId } when the report is shown — see Report data. |
| — | customization.checkReport.actionButton | object | boolean | null | no | The report's action button — see Report action button. |
webapp-base-url | webappBaseUrl | string | no | Only when XUND gives you a different app URL. Must be a *.xund.solutions URL; otherwise the default is used. |
auth-base-url | authBaseUrl | string | no | Only when XUND gives you a different auth URL. Must be a *.xund.solutions URL; otherwise the default https://login.xund.solutions/api is used. |
In HTML attributes, boolean options take the string "true" or "false".
Last updated on