Core Concepts

The API is organized around tenants, devices, certificates, signing workflows, tunneled local requests, webhooks, and operational diagnostics.

Tenant

A tenant is the security and configuration boundary for API keys, devices, webhooks, branding, and operational settings.

Most environments use one logical tenant by default. Larger organizations can use multiple tenants when they need separate workflows, providers, or operational boundaries.

Device

A device represents a connected desktop environment that can execute local operations such as XML signing, certificate discovery, tunneling, and diagnostics.

QES certificate

A QES certificate is certificate metadata discovered through a connected device or signing provider. The API uses certificate information to route and validate signing workflows.

Signing request

A signing request is a server-side API call that asks the platform to sign XML or execute a signing-related operation.

Webhook subscription

A webhook subscription defines where the platform sends event notifications such as device state changes, QES state changes, and delivery logs.