Overview
Hopae Connect organizes everything into a three-level hierarchy. Each level nests inside the one above it: Organization → Application → Workflow
Most day-to-day setup happens at the workflow level. The sections below walk down the hierarchy, then detail what a workflow controls.
The three levels
Organization — your company
An organization is your company’s tenant in Hopae Connect, the top of the hierarchy. It owns everything beneath it — applications, members, billing, and the organization-level API keys used to call the Workspace API. One organization can hold many applications.Application — a product
An application (often shortened to “app”) represents a single product or integration. It is the hub where most setup lives:- OIDC credentials — client ID, client secret, and redirect URIs.
- Provider activation — turning each eID provider on for the app. See Provider Activation.
- Company information — legal details used to prefill provider activation requests.
- Custom domain — serve the verification UI from your own domain. See Custom Domain.
- Default branding — the app name and logo that workflows can inherit.
- Webhooks — where Hopae notifies your system of events.
Workflow — a verification
A workflow is a single verification configuration — the leaf of the hierarchy and the unit you run when you start a verification. It decides what a verification asks for and how it behaves, which is covered next.What a workflow configures
Each workflow bundles the settings for one verification experience:Providers are gated twice. A provider must first be activated for the application — a one-time setup, see Provider Activation. Every activated provider is then offered by every workflow by default; a workflow can opt a provider out so it is not shown in that particular flow. The workflow setting controls visibility, not activation.
Branding here is a display name and logo (or inheriting the app’s). The domain that serves the verification UI is set at the app level — see Custom Domain.
The default workflow
Every application is created with a ready-to-run default workflow — a straightrequest → verification → response path that requests name, given_name, family_name, and birthdate. You can start verifications immediately, without building anything.
When you start a verification without naming a workflow, the app runs its default. Create or customize workflows only when you need different data, providers, branding, or logic. Change which workflow is the default in the Console.
Decision graph (advanced)
By default a workflow runs a single straight line — request the verification, return the result. When you need conditional behavior, a workflow is also a small graph of nodes: you insert steps between the verification and the response to gate or branch the flow. Each node has anid, a type, an optional next (the id of the following node — or, for an if node, a list of conditional routes), and a type-specific config.
The
verification node carries the channel, claims, providers, and branding from the section above. The other node types are optional — add them only when you need an assurance gate, a required-claim check, or branching.
How a workflow runs
When a verification session starts, Hopae Connect runs the chosen workflow — or the app’s default — from itsrequest node to a response node. The verification node produces the UserInfo payload described in Return Data; any downstream nodes read that payload to gate or branch the flow before it reaches response.
Next Steps
Provider Activation
Turn eID providers on for your app
Level of Assurance
Understand the LoA values used by check-min-loa