Overview


Introduction

Flow overview

Requirements

Versioning


Authentication

Server authentication


Incoming APIs

Overview

Provision user

Create encounter

Refresh encounter URL

Manage user status


Outgoing APIs

Overview

Callback authentication

Response protocol

Callback types


Reference

Changelog

Versioning

When backwards-incompatible changes are made to the API, a new, dated version is released. The latest version is 2026-04-24.

See Versioning for how to target a specific version in requests.


2026-08-12

Added

Changed

Deprecated


2026-04-24

Added

Changed


2026-03-23

Added

Changed


2026-02-13

Breaking changes

Features

Bug fixes

Misc. changes