Overview
The MaxConf Virtual Conferencing API is a gateway to interface with Maximus Canada’s Pexip Infinity video conferencing platform. It provides functionality to create, retrieve information about, and delete virtual meeting rooms (VMRs).
What it does
Section titled “What it does”- Creates VMRs on demand when a citizen initiates a video verification session
- Returns room details (alias, PINs, connection info) to the calling application
- Deletes VMRs after sessions end
- Reports health status for monitoring
Who consumes it
Section titled “Who consumes it”The primary consumer is the IDIM server infrastructure (Identity Information Management) at the Government of BC. When a citizen initiates a video verification session via the BC Services Card mobile app, the IDIM server calls the MaxConf API to provision a room, then provides the connection details back to the BCSC app. The BCSC app itself connects directly to the Pexip conference node - it does not call the MaxConf API.
Maximus also uses the API internally for testing and operational purposes.
Technology
Section titled “Technology”- Runtime: Azure Functions v2 (Python)
- Framework: FastAPI with Pydantic models
- Authentication: Microsoft Entra ID OAuth2.0 (client credentials flow)
- Gateway: Azure API Management with managed TLS certificates
- Backend: Pexip Infinity Management API (on Azure VMs)
Interactive API documentation
Section titled “Interactive API documentation”When running locally (func host start), FastAPI auto-generates interactive Swagger UI docs at:
http://localhost:7071/docsUse this to explore endpoints, view schemas, and test requests without authentication. The raw OpenAPI spec is also available at http://localhost:7071/openapi.json.
A snapshot of the OpenAPI spec is published with this docs site at /openapi-spec.json.