Get Providers

curl --request GET \
  --url 'https://sandbox.api.hopae.com/connect/v1/providers' \
  --user '{clientId}:{clientSecret}'

[
  {
    "id": "bankidse",
    "logoUrl": "https://static.hopae.com/images/wallets/bankidse.png",
    "name": "BankID Sweden",
    "countries": ["se"],
    "isActive": true,
    "needAction": false,
    "flowTypes": ["redirect"],
    "scopes": [
      "name",
      "family_name",
      "given_name",
      "ssn",
      "ssn_issuing_country",
      "auth_device_ip"
    ],
    "loa": [3]
  },
  {
    "id": "mitid",
    "logoUrl": "https://static.hopae.com/images/wallets/mitid.png",
    "name": "MitID",
    "countries": ["dk"],
    "isActive": true,
    "needAction": false,
    "flowTypes": ["redirect"],
    "scopes": ["name", "birthdate", "ssn", "dk_ssn"],
    "loa": [3, 4]
  }
]

GET

providers

curl --request GET \
  --url 'https://sandbox.api.hopae.com/connect/v1/providers' \
  --user '{clientId}:{clientSecret}'

[
  {
    "id": "bankidse",
    "logoUrl": "https://static.hopae.com/images/wallets/bankidse.png",
    "name": "BankID Sweden",
    "countries": ["se"],
    "isActive": true,
    "needAction": false,
    "flowTypes": ["redirect"],
    "scopes": [
      "name",
      "family_name",
      "given_name",
      "ssn",
      "ssn_issuing_country",
      "auth_device_ip"
    ],
    "loa": [3]
  },
  {
    "id": "mitid",
    "logoUrl": "https://static.hopae.com/images/wallets/mitid.png",
    "name": "MitID",
    "countries": ["dk"],
    "isActive": true,
    "needAction": false,
    "flowTypes": ["redirect"],
    "scopes": ["name", "birthdate", "ssn", "dk_ssn"],
    "loa": [3, 4]
  }
]

Retrieves a list of available eID providers.

Headers

Basic authentication: set Authorization.username to your Client ID (client_id) and Authorization.password to your Client Secret (client_secret). The interface builds the header automatically.

Authorization

string

required

Direct API format: Basic <base64(client_id:client_secret)>.

Query Parameters

status

string

The status of the provider. Possible values: enabled, disabled

Response

Returns an array of provider objects.

string

The unique identifier for the eID provider (e.g., bankidse, mitid, singpass)

logoUrl

string

The URL of the eID provider’s logo

name

string

The display name of the eID provider

countries

string[]

ISO 3166-1 alpha-2 country codes (lowercase) supported by the eID provider

isActive

boolean

Whether the provider is currently active and available for use

needAction

boolean

Whether the provider requires additional action or configuration from the user

flowTypes

string[]

The authentication flow types supported by this provider. Possible values: qr, redirect, push, dc

scopes

string[]

The identity attributes (scopes) that can be retrieved from this provider (e.g., name, birthdate, nationality, email)

loa

number[]

The Levels of Assurance (LoA) supported by this provider

curl --request GET \
  --url 'https://sandbox.api.hopae.com/connect/v1/providers' \
  --user '{clientId}:{clientSecret}'

[
  {
    "id": "bankidse",
    "logoUrl": "https://static.hopae.com/images/wallets/bankidse.png",
    "name": "BankID Sweden",
    "countries": ["se"],
    "isActive": true,
    "needAction": false,
    "flowTypes": ["redirect"],
    "scopes": [
      "name",
      "family_name",
      "given_name",
      "ssn",
      "ssn_issuing_country",
      "auth_device_ip"
    ],
    "loa": [3]
  },
  {
    "id": "mitid",
    "logoUrl": "https://static.hopae.com/images/wallets/mitid.png",
    "name": "MitID",
    "countries": ["dk"],
    "isActive": true,
    "needAction": false,
    "flowTypes": ["redirect"],
    "scopes": ["name", "birthdate", "ssn", "dk_ssn"],
    "loa": [3, 4]
  }
]

JWKS Create Verification

Overview

OIDC

REST API

Headers

Query Parameters

Response

​Headers

​Query Parameters

​Response

Headers

Query Parameters

Response