OVOK DOCS
Get startedOvokSignalsSDKsGuidesAPI referenceDeveloper resources
MeMe/Consent

Get medical consent

  • Sandbox: available
  • Staging: available
  • Production: unknown
GET
/v1/me/consent/medical

Returns the signed-in practitioner's medical settings notifications consent, or null when it is not given. Use it on app load to decide whether to show the medical notifications prompt.

Auth: Bearer token for a practitioner session (the profile must be a Practitioner). The caller's access policy must grant Consent:read and Consent:search (a project admin who holds no access policy skips this check). Scope: The caller's practitioner profile in the caller's project (from the token).

Behaviour

  • medical is null when the practitioner never gave the consent or withdrew it.
  • Only withdrawing ends it. Unlike GET /v1/slim/user/consents, a newly published version does not turn it off here.
  • acceptedAt is when it was given, null when that is not recorded.
  • Answers are cached for a rolling day. Any consent write by the practitioner refreshes them right away.

Example

curl -X GET 'https://api.sandbox.ovok.com/v1/me/consent/medical' \  -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpYXQiOjE3NjcyNjg4MDAsImV4cCI6MTc2NzI3MjQwMH0.Ql3B_ztDvctlyZ2z0vp4sl3ExXRQGkzmxdmTAqxNzZk'
{ "medical": { "consentId": "c3499c27-2973-0a7f-807e-fb8676a92dcb", "acceptedAt": "2026-09-02T07:30:00.000Z" } }

Authorization

bearer
headerAuthorizationBearer <JWT>

Response Body

Medical consent retrieved successfully.

application/json
  1. response
medical*
Example Request
curl -X GET 'https://api.sandbox.ovok.com/v1/me/consent/medical'
Example Response
{  "medical": {    "consentId": "string",    "acceptedAt": "string"  }}

Accept or withdraw the terms POST

Accepts or withdraws the terms for the signed-in practitioner and returns the resulting legal consent. **Auth:** Bearer token for a practitioner session (the profile must be a `Practitioner`). The caller's access policy must grant `Consent:read`, `Consent:search`, `Consent:create` and `Consent:update` (a project admin who holds no access policy skips this check). **Scope:** The caller's practitioner profile in the caller's project (from the token). ## Behaviour - `termsAndConditionsConsent: true` records acceptance of the currently published terms. It creates the legal consent, or re-activates a revoked one, with a link to the terms page of your project's practitioner app and the time of acceptance. - `termsAndConditionsConsent: false` revokes an active legal consent with `revokedReason: "withdrawn"`. With no active consent it changes nothing. - Accepting again on the same terms version writes nothing. - The terms value read by `GET /v1/slim/user/consents` changes in the same commit. Other consents are not changed. - The response has the shape of `GET /v1/me/consent/legal`. ## Example ```bash curl -X POST 'https://api.sandbox.ovok.com/v1/me/consent/legal' \ -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpYXQiOjE3NjcyNjg4MDAsImV4cCI6MTc2NzI3MjQwMH0.Ql3B_ztDvctlyZ2z0vp4sl3ExXRQGkzmxdmTAqxNzZk' \ -H 'Content-Type: application/json' \ -d '{ "termsAndConditionsConsent": true }' ```

Give or withdraw the medical consent POST

Gives or withdraws the medical settings notifications consent for the signed-in practitioner and returns the resulting medical consent. Other consents are not changed. **Auth:** Bearer token for a practitioner session (the profile must be a `Practitioner`). The caller's access policy must grant `Consent:read`, `Consent:search`, `Consent:create` and `Consent:update` (a project admin who holds no access policy skips this check). **Scope:** The caller's practitioner profile in the caller's project (from the token). ## Behaviour - `medicalSettingsNotificationsConsent: true` records the consent on the currently published version. `false` withdraws it. - Sending the current value again writes nothing. - The value read by `GET /v1/slim/user/consents` changes in the same commit. - The response has the shape of `GET /v1/me/consent/medical`: `medical` is `null` after a withdrawal. ## Example ```bash curl -X POST 'https://api.sandbox.ovok.com/v1/me/consent/medical' \ -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpYXQiOjE3NjcyNjg4MDAsImV4cCI6MTc2NzI3MjQwMH0.Ql3B_ztDvctlyZ2z0vp4sl3ExXRQGkzmxdmTAqxNzZk' \ -H 'Content-Type: application/json' \ -d '{ "medicalSettingsNotificationsConsent": true }' ```