Users

Get terms and conditions consent

Get terms and conditions consent using Ovok’s Slim API.

MethodPath
GET/v1/slim/user/terms-and-conditions-consent

Authentication · Access policies

Returns whether the signed-in practitioner has accepted the current terms and conditions. Use it to decide whether to show the terms 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 (project admins skip this check). Scope: The caller's practitioner profile in the caller's project (from the token).

Request

No parameters.

Behaviour

  • termsAndConditionsConsent is true only when an acceptance is on file and either matches the currently published terms version or no version has been published yet.
  • Publishing new terms turns it false for everyone until they accept again.
  • The published version is the one of the root project of your project tree: a child project follows its parent's terms. Without one, the platform-wide version applies.
  • GET /v1/me/consent/legal returns the same acceptance with its dates and terms link.

Example

curl -X GET 'https://api.sandbox.ovok.com/v1/slim/user/terms-and-conditions-consent' \
  -H "Authorization: Bearer ${OVOK_TOKEN}"

Successful response

200 — Terms and conditions consent status retrieved successfully.

{
  "termsAndConditionsConsent": true
}
FieldTypeDescription
termsAndConditionsConsentbooleantrue when the practitioner has accepted the current terms and conditions. Never null: no acceptance on file reads false.

Errors

StatusMeaning
401The bearer token is missing or invalid.
403The session is not a practitioner session, has no project, or its access policy lacks Consent:read or Consent:search.
503Your access policy could not be read, or the service is temporarily over capacity. Retry shortly, and honour Retry-After when it is present.

Last updated on

On this page