Compliance

This is the Compliance demo. Every visitor shares this company, and it resets every night.

What you change here, everyone sees until the next reset. Email, payments, and the AI models are switched off.

Start your own trial
  • EU GDPR (2016)
  • ISO 27001:2022
  • NIS2
  • NIS2 Netherlands (Cbw, 2026)

Nothing found that matches the search criteria.

Start your own trial
SV
Sam de Vries
sam.devries@tidewell-it.example

The reference

Every operation, with its fields and errors, is in the OpenAPI document:

https://demo.mvdm.io/compliance/openapi/v1.json

Scalar shows the same document as a page you can browse. You can sign in there and try calls. Those calls are real: on Production they change your real data.

This guide explains what the reference cannot show well. It lists no operations.

The base address

Every call goes to an address under:

https://demo.mvdm.io/compliance/api/v1/

Requests and answers are JSON, with camelCase field names.

Signing in

The API accepts only a bearer credential in the Authorization header. It never reads a browser cookie and never redirects to a sign-in page. There are two kinds of credential:

  • OAuth through Auth, the mvdm.io sign-in service. A call without a credential answers 401. Its WWW-Authenticate header points to the Protected Resource Metadata at https://demo.mvdm.io/compliance/.well-known/oauth-protected-resource/api. That names Auth, so a client can find it and sign in with the authorization code flow and PKCE. The consent page warns that the client gets all your power, and asks which Account it starts in.
  • A Personal token. Create one at API & Agent Access and send it on every call:
Authorization: Bearer <token>

Either way, the call acts as you, with everything you can do in Compliance. An ended or expired credential gets 401 on its next call.

One Account at a time

A credential is in one of your Accounts at a time, and every call acts in that Account. Every answer says which Account it acted in, in its account field. The Accounts calls in the reference list the Accounts you belong to and move the credential into another one. A move holds for every later call with that credential, from any client that uses it.

A call in an Account that has no current Compliance License answers 403 with type license-closed. A call with a credential in an Account you no longer belong to answers 403 with type no-account, listing the Accounts you can move to.

Browser handoff

Some acts need a person in the browser, such as anything that costs money or accepting the Legal terms. The API then answers 403 with type browser-handoff, a one-line detail, and a handoffUrl. Show that link to your person. The link enters the Account the call acted in and opens the page for the act, where they confirm it. If nobody opens the link, nothing happens.

Acts that lower spending, such as cancelling, run directly.

license.get reads the License and the Assistant allowance, for every member. Buying an Allowance pack (license.buy-allowance-pack), turning Auto-topup on, and raising its pack or Monthly spending limit (license.update-auto-topup) hand off to the browser. Turning Auto-topup off and lowering its pack or limit run directly.

Uploads

No operation takes a file in its body. A file travels through an Upload link, a one-time address for one file:

  1. Ask the API for an Upload link, naming what the file is for and its file name. The answer holds the link's url, an uploadId, the partSize, the largest file the link takes as maxBytes, and when the link expires.
  2. Send the bytes to the link. A file up to partSize bytes can go up whole, as one PUT to the link. A larger file goes up in parts of at most partSize bytes. Send each part as a PUT with ?offset= set to the bytes sent so far. Then POST the totalBytes to the link plus /finish.
  3. Pass the uploadId to the call that takes the file. The reference marks every such field with x-upload-target.

The link carries its own authority, so send no bearer to it, and it counts toward no rate limit. A GET on the link says how many bytes it holds, so a broken upload goes on from there. A part at the wrong offset answers 409 with bytesReceived. The first part must arrive within 15 minutes, and each part keeps the link open 15 minutes more. A person can also open the link in a browser and pick the file there.

A web page or a PDF with a public address needs no Upload link. POST /api/v1/attachments takes a webAddress instead of an uploadId, and exactly one of the two. When the address serves a PDF, Compliance fetches it and files a copy that keeps the address as its webAddress. Any other address is filed as a link: webAddress is set, and fileName, contentType, byteSize, sha256 and url are null.

Lists: queries and paging

A register's list takes OData query options, with camelCase field names:

Option What it does
$filter Keeps the rows that match, such as status eq 'Open'.
$select The fields to return. Without it: id, code, and url.
$orderby Sorts by a field, or a field and desc. Separate keys with commas.
$expand Includes related records.
$top The page size: 50 by default, at most 200.
$skip The rows to skip.

A list answers items, the total, and nextOffset. To get the next page, send nextOffset as $skip. On the last page, nextOffset is null. Enum values are their member names, such as Open, both in answers and in $filter.

The Course library

Compliance ships a Course library of training courses, in English and Dutch. course-library.list lists them in your UI language, with each course's slug, version, lessonCount, questionCount, and passMarkPercent. course-library.get adds the Lessons and never the Quiz questions. training-courses.add-from-library takes a slug and adds the course to the Account as a Library course: 201 with the new course, or 200 with the course the Account already holds.

A Library course's title, descriptionHtml, and category come from the library in your UI language, and its librarySlug and libraryVersion are set (null on the Account's own courses). Only repeats and audience can be changed on it: training-courses.update answers 422 for any other field. Each assignment of the course carries the trainee's score as a percent, finishedAt, and libraryVersion once they have passed or finished it. Following a course and answering its Quiz happen only on the Task page, so the API cannot complete a Library course's training Task.

Requirement coverage on a Training Course

A Training Course covers Requirements like the other registers. training-courses.link-requirements replaces the Requirements a course covers with requirements (each frameworkId and code); [] clears them, and a Library course links the same way. The course answers them under linkedRequirements, and a Requirement read lists its Training Courses under coverage.trainingCourses.

Errors

Every error is ProblemDetails (RFC 9457), as application/problem+json. Its type is a stable token a client can match on. title and detail follow your UI language, English or Dutch.

  • 401 unauthorized: no credential, or one that is unknown, ended, or expired.
  • 402 allowance-exhausted: the Assistant allowance is empty.
  • 403 no-account: the credential is in an Account you no longer belong to.
  • 403 license-closed: the Account has no current License.
  • 403 browser-handoff: a person must finish the act in the browser.
  • 403 forbidden: only an Owner may do this.
  • 404 not-found: no such record in this Account.
  • 409 conflict: the act clashes with the record's state.
  • 422 validation: the input was refused. errors names the fields, or detail gives the reason.
  • 429 rate-limited: over the rate limit.
  • 500 about:blank: an unexpected failure.

Rate limit

Each User has a limit on calls in a fixed time window, shared by every credential, Agent, and script of that User. A call over the limit answers 429 with a Retry-After header, in seconds. Wait that long and try again.

v1 only grows

New operations and new optional fields can appear, but nothing in v1 is removed or renamed, and no optional field becomes required. A breaking change ships as /api/v2/ beside v1.

Other ways in

Agents that speak MCP can connect to the MCP server at https://demo.mvdm.io/compliance/mcp. See the guides for each Agent. For scripts in a terminal, see the CLI guide.

Are you sure?

This action cannot be reverted.

Leave this page?

Your changes on this form are not saved. If you leave, they are lost.