API & SDKs
API Overview

API Reference

The Optare ID API is documented using the OpenAPI 3.0 specification.

OpenAPI Specification

You can download the raw OpenAPI specification file here: Download openapi.yaml

Interactive Documentation

For interactive documentation, please import the openapi.yaml file into tools like Swagger UI (opens in a new tab) or Postman (opens in a new tab).

Endpoints Overview

User Management

  • GET /api/v1/users/me - Get current user profile
  • PATCH /api/v1/users/me - Update user profile
  • DELETE /api/v1/users/me - Delete account

Subscriptions

  • GET /api/v1/subscriptions - List subscriptions
  • POST /api/v1/subscriptions - Create subscription

API Keys

  • GET /api/v1/api-keys - List API keys
  • POST /api/v1/api-keys - Create API key
  • DELETE /api/v1/api-keys - Revoke API key

OAuth Clients

  • POST /api/v1/oauth-clients - Register OAuth client

Licenses

  • GET /api/v1/licenses/check - Check feature entitlement
  • GET /api/v1/licenses/entitlements - List all entitlements
ReadmeAuthentication API