Get Providers

curl -H "Authorization: Bearer sk_workspace_test_..." \
  "https://sandbox.api.hopae.com/connect/v1/apps/HqTRDIYH/providers"

curl -H "Authorization: Bearer sk_workspace_test_..." \
  "https://sandbox.api.hopae.com/connect/v1/apps/HqTRDIYH/providers?include=activation"

[
  {
    "id": "mitid",
    "name": "MitID",
    "description": "Danish national eID",
    "logoUrl": "https://static.hopae.com/providers/mitid.png",
    "countries": ["DK"],
    "flowTypes": ["redirect"],
    "scopes": ["openid", "profile"],
    "loa": [3],
    "defaultLoa": 3,
    "type": 1,
    "verificationModel": "disclosure",
    "isActive": true,
    "needAction": false,
    "status": "activated",
    "activation": {
      "status": "activated",
      "id": "act_01HXYZ2KQ8M0E3J1N9V0P5T8YR",
      "requirements": [
        {
          "id": "legalCompanyName",
          "type": "text",
          "label": "Legal Company Name",
          "description": "The registered legal name of the company, as shown on official incorporation documents.",
          "example": "Acme Corporation B.V.",
          "required": true,
          "currentValue": "Acme Corp",
          "submittedValue": "Acme Corp"
        },
        {
          "id": "registrationNumber",
          "type": "text",
          "label": "Registration Number",
          "description": "The company registration number from your country's business registry (e.g., RCS Luxembourg, HRB Germany, CVR Denmark).",
          "example": "HRB 123456",
          "required": true,
          "currentValue": "12345678",
          "submittedValue": "12345678"
        }
      ],
      "requestedAt": "2026-04-20T02:20:27.521Z",
      "activatedAt": "2026-04-20T02:20:32.521Z"
    }
  },
  {
    "id": "ftn",
    "name": "FTN",
    "description": "Finnish Trust Network",
    "logoUrl": "https://static.hopae.com/providers/ftn.png",
    "countries": ["FI"],
    "flowTypes": ["redirect"],
    "scopes": ["openid", "profile"],
    "loa": [3],
    "defaultLoa": 3,
    "type": 1,
    "isActive": false,
    "needAction": true,
    "status": "not_activated",
    "activation": {
      "status": "not_activated",
      "requirements": [
        {
          "id": "supportContact",
          "type": "info",
          "label": "Activation Support Contact",
          "description": "Contact Hopae support to initiate FTN activation. We will guide you through signing the Customer Agreement and (optionally) Appendix A.",
          "value": "support@hopae.com"
        }
      ]
    }
  }
]

GET

apps

{client_id}

providers

curl -H "Authorization: Bearer sk_workspace_test_..." \
  "https://sandbox.api.hopae.com/connect/v1/apps/HqTRDIYH/providers"

curl -H "Authorization: Bearer sk_workspace_test_..." \
  "https://sandbox.api.hopae.com/connect/v1/apps/HqTRDIYH/providers?include=activation"

[
  {
    "id": "mitid",
    "name": "MitID",
    "description": "Danish national eID",
    "logoUrl": "https://static.hopae.com/providers/mitid.png",
    "countries": ["DK"],
    "flowTypes": ["redirect"],
    "scopes": ["openid", "profile"],
    "loa": [3],
    "defaultLoa": 3,
    "type": 1,
    "verificationModel": "disclosure",
    "isActive": true,
    "needAction": false,
    "status": "activated",
    "activation": {
      "status": "activated",
      "id": "act_01HXYZ2KQ8M0E3J1N9V0P5T8YR",
      "requirements": [
        {
          "id": "legalCompanyName",
          "type": "text",
          "label": "Legal Company Name",
          "description": "The registered legal name of the company, as shown on official incorporation documents.",
          "example": "Acme Corporation B.V.",
          "required": true,
          "currentValue": "Acme Corp",
          "submittedValue": "Acme Corp"
        },
        {
          "id": "registrationNumber",
          "type": "text",
          "label": "Registration Number",
          "description": "The company registration number from your country's business registry (e.g., RCS Luxembourg, HRB Germany, CVR Denmark).",
          "example": "HRB 123456",
          "required": true,
          "currentValue": "12345678",
          "submittedValue": "12345678"
        }
      ],
      "requestedAt": "2026-04-20T02:20:27.521Z",
      "activatedAt": "2026-04-20T02:20:32.521Z"
    }
  },
  {
    "id": "ftn",
    "name": "FTN",
    "description": "Finnish Trust Network",
    "logoUrl": "https://static.hopae.com/providers/ftn.png",
    "countries": ["FI"],
    "flowTypes": ["redirect"],
    "scopes": ["openid", "profile"],
    "loa": [3],
    "defaultLoa": 3,
    "type": 1,
    "isActive": false,
    "needAction": true,
    "status": "not_activated",
    "activation": {
      "status": "not_activated",
      "requirements": [
        {
          "id": "supportContact",
          "type": "info",
          "label": "Activation Support Contact",
          "description": "Contact Hopae support to initiate FTN activation. We will guide you through signing the Customer Agreement and (optionally) Appendix A.",
          "value": "support@hopae.com"
        }
      ]
    }
  }
]

Returns the full provider catalog available in the current environment for the given app. By default the response is the plain Provider catalog (no per-app activation data). Pass include=activation to upgrade each entry with the app’s status and an activation block describing where the provider is in the activation flow and what (if anything) is still required.

Request

string

required

Bearer <API_KEY> from Console > Developers > Workspace API Keys.

Path parameters

string

required

Client identifier of the app.

Query parameters

string

Set to activation to include the per-app activation state alongside each provider.Accepted as a single value (?include=activation) or repeated (?include=activation&include=...). Unknown values are ignored; passing nothing (or omitting the parameter) returns the plain catalog.

Response

The response is a plain JSON array. Each entry is a Provider. With ?include=activation, each entry is a Provider plus the status and activation fields below.

Provider (always present)

string

Provider identifier (e.g., mitid, bankidse, ftn, passport).

string

Human-readable provider name.

string

Provider description.

string

URL of the provider logo.

string[]

ISO country codes the provider serves.

string[]

Verification flow types the provider supports (qr, redirect, push, dc).

string[]

Available OIDC scopes for the provider.

number[]

Levels of Assurance the provider can issue.

number

Default LoA when the upstream IDP does not return one. 0 means unspecified.

number

Digital ID type: 1 (Centralized IdP), 2 (Chip-based), 3 (Decentralized Wallet).

string

disclosure (provider returns IDP-derived attribute claims) or match (provider verifies caller-supplied identity values). Omitted when not applicable.

string

For match-model providers: per_field (one outcome per matched field) or aggregate (single verdict). Omitted for disclosure providers.

boolean

true iff the provider’s derived activation status is activated — equivalent to status === 'activated'. false for every other status, including providers that have never been added to the app.

boolean

true when the provider is activated but its stored provider config fails the provider’s configSchema validation (missing or malformed credentials, etc.). Use it to surface a “finish setup” nudge in the UI.

Added by `?include=activation`

string

Per-app provider status, derived from the latest activation ticket.One of:

not_activated — never submitted, or the provider has not been added to the app.
activation_requested — a registration-type submission has been received and is waiting for operator review.
activation_processing — operator review is in progress, or (sandbox demo: true) the brief auto-approve window is still open.
rejected — the latest submission failed validation or was rejected by operator review. Resubmit via Submit Activation.
activated — provider is ready for live verifications.

object

Activation block. Always present when include=activation is set, even when nothing has been submitted (in that case status is not_activated and id, requestedAt, etc. are omitted).

Show activation

string

Latest activation ticket status, or not_activated when no ticket exists. Mirrors the top-level status.

string

Ticket identifier (act_<ulid>). Present once a ticket exists.

object[]

Inputs the customer must (or did) submit, derived from the provider’s activation spec.For direct providers (e.g., passport, most chip-based IDs) this is always [] — no inputs needed.For registration providers, one entry per required field. Common fields include legalCompanyName, registrationNumber, serviceDescription, displayName, contactEmail, userDataLevel — see Submit Activation for the catalog.For contract providers (e.g., ftn, uaepass, idin), a single synthetic info-type entry exposes the Hopae support contact — the activation itself happens off-API.

Show requirement

string

Field identifier (or supportContact for contract providers).

string

Input type: text, email, url, checkbox, select, or info. Drives the UI control to render.

string

Human-readable label.

string

Short guidance shown to the customer.

string

Short sample value to render as the input placeholder (e.g., DE123456789 for vatNumber). Present on free-text fields (text, email, url); omitted for select, checkbox, info, and the logo upload.

boolean

true for every input listed by a registration spec. Omitted for info entries.

number

Maximum allowed string length, when the field declares one.

string

Advisory regex hint. Not enforced server-side.

object[]

Allowed values for select / checkbox fields. Each option is { value, description }.

string | boolean | null

Cached value from the app’s companyInfo (or matching per-provider requirements). Use this to prefill the form.

string | boolean | null

Value most recently submitted on the ticket, or null when no submission has been made.

string

(info entries only) The exposed value — for contract providers this is the support email.

string

ISO 8601 timestamp of the latest submission. Omitted when no ticket exists.

string

ISO 8601 timestamp of activation completion. Omitted until the provider becomes activated.

string

ISO 8601 timestamp of the most recent rejection. Omitted unless status is rejected.

object

Present only when status is rejected.

Show rejection

string

missing_required_fields, invalid_value, provider_rejected, or other.

string[]

Field ids that triggered a missing_required_fields rejection.

string

Free-form message from the operator (e.g., the rejection reason).

Sandbox behavior

Sandbox runs the same activation flow as production and writes real tickets, so activation.id is present and statuses are real:

Providers that have never been added to the app (no entry in apps.providers) are omitted from the response.
By default, statuses match production: direct providers read as activated, registration providers stay at activation_requested until an operator reviews them, and contract providers read as not_activated.
When the activation was submitted with demo: true (see Submit Activation), registration and contract providers read as activation_processing, then flip to activated about 1 second later.

Errors

Status	Body	When
`401`	`INVALID_API_KEY`	Missing or malformed `Authorization` header.
`403`	`RESOURCE_FORBIDDEN`	The API key’s organization does not own `client_id`.
`404`	`RESOURCE_NOT_FOUND`	No app matches `client_id`.

curl -H "Authorization: Bearer sk_workspace_test_..." \
  "https://sandbox.api.hopae.com/connect/v1/apps/HqTRDIYH/providers"

curl -H "Authorization: Bearer sk_workspace_test_..." \
  "https://sandbox.api.hopae.com/connect/v1/apps/HqTRDIYH/providers?include=activation"

[
  {
    "id": "mitid",
    "name": "MitID",
    "description": "Danish national eID",
    "logoUrl": "https://static.hopae.com/providers/mitid.png",
    "countries": ["DK"],
    "flowTypes": ["redirect"],
    "scopes": ["openid", "profile"],
    "loa": [3],
    "defaultLoa": 3,
    "type": 1,
    "verificationModel": "disclosure",
    "isActive": true,
    "needAction": false,
    "status": "activated",
    "activation": {
      "status": "activated",
      "id": "act_01HXYZ2KQ8M0E3J1N9V0P5T8YR",
      "requirements": [
        {
          "id": "legalCompanyName",
          "type": "text",
          "label": "Legal Company Name",
          "description": "The registered legal name of the company, as shown on official incorporation documents.",
          "example": "Acme Corporation B.V.",
          "required": true,
          "currentValue": "Acme Corp",
          "submittedValue": "Acme Corp"
        },
        {
          "id": "registrationNumber",
          "type": "text",
          "label": "Registration Number",
          "description": "The company registration number from your country's business registry (e.g., RCS Luxembourg, HRB Germany, CVR Denmark).",
          "example": "HRB 123456",
          "required": true,
          "currentValue": "12345678",
          "submittedValue": "12345678"
        }
      ],
      "requestedAt": "2026-04-20T02:20:27.521Z",
      "activatedAt": "2026-04-20T02:20:32.521Z"
    }
  },
  {
    "id": "ftn",
    "name": "FTN",
    "description": "Finnish Trust Network",
    "logoUrl": "https://static.hopae.com/providers/ftn.png",
    "countries": ["FI"],
    "flowTypes": ["redirect"],
    "scopes": ["openid", "profile"],
    "loa": [3],
    "defaultLoa": 3,
    "type": 1,
    "isActive": false,
    "needAction": true,
    "status": "not_activated",
    "activation": {
      "status": "not_activated",
      "requirements": [
        {
          "id": "supportContact",
          "type": "info",
          "label": "Activation Support Contact",
          "description": "Contact Hopae support to initiate FTN activation. We will guide you through signing the Customer Agreement and (optionally) Appendix A.",
          "value": "support@hopae.com"
        }
      ]
    }
  }
]

Overview

Workspace

Apps

Providers

Provider Activation

Redirect URIs

Webhooks

Custom Domain

Workflows

Production Tests

Request

Path parameters

Query parameters

Response

Provider (always present)

Added by `?include=activation`

Sandbox behavior

Errors

​Request

​Path parameters

​Query parameters

​Response

​Provider (always present)

​Added by ?include=activation

​Sandbox behavior

​Errors

Request

Path parameters

Query parameters

Response

Provider (always present)

Added by `?include=activation`

Sandbox behavior

Errors