Skip to main content
GET
Returns the connections your app’s environment offers: the ones activated for your app first, then the ones you have not activated. Each item carries the connection’s catalog connectionId and its connectionInstanceId (either one starts a verification with Create Verification), the connection’s userInputJsonSchema (what to send in userInput), the claims it can return, and whether it is enabled in the resolved workflow.
A connection that is not activated, including one that is requested, processing, or rejected in the Console, appears with activated: false and connectionInstanceId: null. Activate it before you start a verification with it. Activation happens in the Console under Configuration → Connections. See Connection Activation.

Headers

string
required
Basic <base64(appId:appSecret)>. See Authentication.

Query Parameters

string
The workflow whose enabled set and claim curation apply. Defaults to the app’s default workflow. An unknown id returns 404 RESOURCE_NOT_FOUND. There is no silent fallback.
string
default:"all"
  • all: every connection your app’s environment offers, activated first, then not activated.
  • enabled: only the activated connections that can be started in the resolved workflow, exactly what POST /verifications will accept.

Response

Returns an array of connection objects.
string | null
required
Your app’s activated instance of this connection. Format conn_… (connections activated before August 2026 carry cred_…). null when the connection is not activated. Accepted by Create Verification as an alternative to connectionId. Also reported as provenance._metadata.connection_instance_id in userinfo.
string
required
The catalog connection id (for example smart-id, cz-bankid-identify, google-wallet-us-mdl). This is the id you pass to Create Verification and to ui_connection_id on OIDC. Human-readable but opaque. Read provider.id and credential.id instead of parsing it.
object
required
Catalog provider with required id, name, and logoUrl. Use provider.id as the providerId start key.
object
required
Catalog credential with required id, name, logoUrl, countries (lowercase ISO country codes, every country the credential covers), loa (the Hopae Level of Assurance levels this credential can reach, 1 to 4), types (presentation types 1, 2, 3), and verificationModel (disclosure or match).Optional fields: displayName, displayGroupId, and matchGranularity (per_field or aggregate). Use credential.displayName ?? credential.name for the label, and credential.displayGroupId ?? connectionId for the display group. Use credential.id with providerId to select a specific credential.
string[]
The countries this connection covers, as lowercase ISO country codes. Present only when the connection covers fewer countries than its credential. Absent means the connection covers every country in credential.countries. Read a connection’s countries as countries ?? credential.countries.For example, the EUDI PID credential lists all 27 EU member states. The Danish AltID wallet presents it for Denmark only, so altid-eudi-pid returns countries: ["dk"].
string[]
required
Supported delivery mechanics, primary first: redirect, qr, push, dc, or query. See Flow Types.
boolean
required
Whether you can ask this connection’s provider for a Level of Assurance. If true, you can request any level up to the highest in credential.loa, with requestedLoa in Create Verification or acr_values on OIDC, and Hopae passes it to the provider. A higher level isn’t supported. If false, Create Verification returns 422 VALIDATION_UNPROCESSABLE for requestedLoa, and OIDC doesn’t offer the connection when acr_values requests a level. See Request a target LoA.
object
What this connection needs in userInput at creation time, as a JSON Schema (draft 2020-12) object. Absent when the connection needs no input. See User Input.
object
deprecated
Deprecated: use userInputJsonSchema instead. userInputSchema will be removed on Mar 31, 2027.The earlier per-field form of the same contract. It can’t express cross-field rules, and a connection added after userInputJsonSchema was introduced doesn’t include it. The response itself doesn’t mark the field as deprecated. To migrate, see Deprecated userInputSchema.
string[]
required
Every claim this connection can return for your app. For a connection that is not activated, the catalog’s claims. Includes source_id when the connection can derive a stable per-person identifier.
object
Present only when availableClaims contains source_id. The claims Hopae requests from the provider so it can derive source_id when you select it. primary is used first, fallback only when a primary value is missing; both are requested together. Data Hopae gets without asking, such as the provider’s own sub or a value you send in userInput, isn’t listed, even when the connection falls back to it. Both empty means selecting source_id requests nothing extra. See Source ID.
string[]
required
The claims the resolved workflow requests specifically for this connection (the workflow’s Claims tab in the Console). Empty when the workflow does not curate this connection.
boolean
required
Whether the resolved workflow enables this connection. An activated connection with enabled: false cannot be started in that workflow. POST /verifications answers 403 PROVIDER_DISABLED_IN_WORKFLOW. Always false when the connection is not activated.
boolean
required
Whether the connection is activated for your app.
provider, credential, countries, flowTypes, acceptsRequestedLoa, and userInputJsonSchema are read live from the catalog. availableClaims belongs to your activated instance, or comes from the catalog when the connection is not activated. connectionClaims and enabled come from the resolved workflow. Refresh cached lists when configuration or catalog data changes.

Authorizations

Authorization
string
header
required

Basic base64(appId:appSecret). See Authentication.

Query Parameters

workflowId
string

Workflow to resolve against. Defaults to the app's default workflow. An unknown id returns 404 RESOURCE_NOT_FOUND.

status
enum<string>
default:all

all (default) returns every connection your app's environment offers, activated first. enabled returns only the activated connections the workflow can start.

Available options:
all,
enabled

Response

Connections.

connectionInstanceId
string | null
required

Your app's activated instance: conn_…, or cred_… for older instances. null when the connection is not activated.

connectionId
string
required

Opaque catalog connection id. Use provider.id and credential.id instead of parsing it.

provider
object
required
credential
object
required
flowTypes
enum<string>[]
required

Supported flows, primary first.

Available options:
redirect,
qr,
push,
dc,
query
acceptsRequestedLoa
boolean
required

Whether you can ask this connection's provider for a Level of Assurance. If true, you can request any level up to the highest in credential.loa. If false, Create Verification returns 422 VALIDATION_UNPROCESSABLE for requestedLoa, and OIDC doesn't offer the connection when acr_values requests a level.

availableClaims
string[]
required
connectionClaims
string[]
required
enabled
boolean
required

Whether the resolved workflow enables this connection. Always false when the connection is not activated.

activated
boolean
required

Whether the connection is activated for your app.

countries
string[]

Countries this connection covers, lowercase ISO 3166-1 alpha-2. Present only when the connection covers fewer countries than its credential. Read a connection's countries as countries ?? credential.countries.

userInputJsonSchema
object

What to send as userInput, as a JSON Schema (draft 2020-12) object: properties, required, and the cross-field rules oneOf, anyOf, and dependentRequired. Absent when no input is needed.

userInputSchema
object
deprecated

Deprecated: use userInputJsonSchema instead. userInputSchema will be removed on Mar 31, 2027. The earlier per-field form of the same contract, without the cross-field rules.

sourceIdBackedBy
object

Present only when availableClaims contains source_id. The claims Hopae requests from the provider so it can derive source_id when you select it. primary is used first, fallback only when a primary value is missing; both are requested together. Data Hopae gets without asking, such as the provider's own sub or a value you send in userInput, isn't listed. Both empty means selecting source_id requests nothing extra.