OpenAPI reference
These are the OpenAPI documents the platform's services generate from their own code at build time (rule API-004). CI regenerates each one and fails when the committed document no longer matches the code, so a document here describes what that service's code registers.
This is where the API reference lives. Do not rely on a Swagger UI on the fleet. Most services serve their Swagger UI only when they run as Development, and the fleet is moving to Production.
A service appears here once it opts into the build-time export. If a service is not listed, it has not opted in yet. That does not mean it has no API.
| Service | Title | Version | Operations | Document |
|---|---|---|---|---|
ApiKeyManagement | Essence API Key Management | v1 | 18 | JSON |
Auth | Essence Authentication Service API | v1.0 | 323 | JSON |
Billing | Essence Payment & Billing API | v1.0 | 368 | JSON |
Consent | Essence Consent Management API | v1 | 636 | JSON |
DeveloperMarketplace | Essence Developer Marketplace API | v1 | 52 | JSON |
DeveloperPortal | Essence Developer Portal API | v1 | 175 | JSON |
DeveloperSandbox | Essence Developer Sandbox API | v1 | 44 | JSON |
Encryption | Essence Encryption API | v1 | 3 | JSON |
IdP | Essence Identity Provider API | v1 | 159 | JSON |
Instance | Essence Instance Service API | v1.0 | 266 | JSON |
MultiDeviceSync | Multi-Device Sync API | v1.0 | 135 | JSON |
Notifications | Essence Notification Service API | v1 | 120 | JSON |
PartnerProgramme | Essence Partner Programme API | v1 | 106 | JSON |
PublicKeyDirectory | Essence.Directory.PublicKey.Api | 1.0 | 5 | JSON |
Schema | Essence Schema Service API | v1 | 41 | JSON |
ShamirRecovery | Shamir Recovery Service API | v1.0 | 37 | JSON |
Supplier | Essence Supplier Management API | v1 | 227 | JSON |
Vault | Essence Vault API | v1.0 | 264 | JSON |
Verification | Essence Verification Hub Service | v1 | 123 | JSON |
WebhookManagement | Essence Webhook Management API | v1 | 11 | JSON |