Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Hopae, Inc. Providers API

eID provider discovery

Hopae, Inc. Providers API is one of 9 APIs that Hopae, Inc. publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Providers. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 2 operations across 2 paths, and defines 3 schemas. It is described by OpenAPI 3.0.0, at version 1.0.0.

Requests are made against a single base URL, https://sandbox.api.hopae.com/connect.

2 operations 2 paths 3 schemas 2 GET

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
1.0.0
Base URL
https://sandbox.api.hopae.com/connect
Authentication
HTTP Basic, HTTP Bearer, HTTP Bearer, HTTP Bearer, HTTP Basic
Resource Areas
1

Authentication & Security 5

Hopae, Inc. Providers API declares 5 security schemes for authenticating requests. It accepts HTTP basic authentication (basicAuth). It accepts HTTP bearer tokens (API Key) (workspaceApiKey). It accepts HTTP bearer tokens (JWT) (consoleJwt). It accepts HTTP bearer tokens (JWT) (workspace-api-key). It accepts HTTP basic authentication (app-basic).

  • basicAuth — Basic authentication using clientId and clientSecret. For direct API calls, format the Authorization header as Authorization: Basic . In the Mintlify playgroun…
  • workspaceApiKey — Workspace API key authentication. Pass your workspace API key as Authorization: Bearer skworkspace....
  • consoleJwt — Console JWT authentication. Issued by Clerk after Console login.

Paths & Operations 2

Across 2 paths, the API surfaces 2 operations — 2 GET. Each is listed below with its method, path, parameters, and response codes.

Providers 2

eID provider discovery

GET
/v1/providers
Get Providers
getProviders 1 param → 200400401
GET
/v1/providers/{providerId}/configuration
Get provider configuration
ProvidersController_getProviderConfiguration 1 param → 200

Schemas 3

The contract defines 3 schemas that model the data the API accepts and returns. The most detailed are UserDataFieldDto (7 properties), ProviderConfigurationDto (5 properties), UserDataOptionDto (2 properties). Each schema is shown below with its type and property counts.

UserDataFieldDto
object
7 properties 4 required
ProviderConfigurationDto
object
5 properties 3 required
UserDataOptionDto
object
2 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

hopae-inc-providers-api-openapi.yml Raw ↑

Other APIs Hopae, Inc. publishes across the network.

Hopae, Inc. Console - API Keys API
Hopae, Inc. Token API
Hopae, Inc. Verifications API
Hopae, Inc. Workspace API - Activation API
Hopae, Inc. Workspace API - Apps API
Hopae, Inc. Workspace API - Production Tests API
Hopae, Inc. Workspace API - Workflows API
Hopae, Inc. Workspace API - Workspace API