Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.hopae.com/llms.txt

Use this file to discover all available pages before exploring further.

​
What is a workspace?

A workspace is your Hopae Connect account — it corresponds 1:1 with your Console organization. There is no separate “create workspace” API call: signing up for Hopae Connect through the Console provisions your workspace automatically. Inside a workspace you manage one or more Apps (typically one per end-customer or per product surface), each of which can activate any combination of eID providers.

​
API Key

Create and manage keys in the Console under Developers → Workspace API Keys. Keys are environment-specific (sandbox, production) and begin with sk_workspace_. Workspace API key issuance UI showing key creation and copy controls

​
Authentication

Workspace API requests use Authorization: Bearer <API_KEY>. 
Authorization: Bearer sk_workspace_...
Content-Type: application/json

​
Credential Types

CredentialFormatUsed for
App clientId + clientSecretclientId: 8-char alphanumeric, clientSecret: 64-char hexVerification API (Basic Auth), OIDC flow (client_id parameter)
Workspace API keysk_workspace_...Workspace API (Bearer Auth) — manage apps, providers, webhooks
Do not confuse the two. App credentials authenticate verification requests from end-users. Workspace API keys authenticate management operations.

​
Base URLs

https://api.hopae.com/connect/v1