> ## Documentation Index
> Fetch the complete documentation index at: https://docs.hopae.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Get Providers

Retrieves a list of available eID providers.

## Headers

<Info>
  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.
</Info>

<ParamField header="Authorization" type="string" required>
  Direct API format: `Basic <base64(client_id:client_secret)>`.
</ParamField>

## Query Parameters

<ParamField query="status" type="string">
  The status of the provider. Possible values: `enabled`, `disabled`
</ParamField>

## Response

Returns an array of provider objects.

<ResponseField name="id" type="string">
  The unique identifier for the eID provider (e.g., `bankidse`, `mitid`, `singpass`)
</ResponseField>

<ResponseField name="logoUrl" type="string">
  The URL of the eID provider's logo
</ResponseField>

<ResponseField name="name" type="string">
  The display name of the eID provider
</ResponseField>

<ResponseField name="countries" type="string[]">
  ISO 3166-1 alpha-2 country codes (lowercase) supported by the eID provider
</ResponseField>

<ResponseField name="isActive" type="boolean">
  Whether the provider is currently active and available for use
</ResponseField>

<ResponseField name="needAction" type="boolean">
  Whether the provider requires additional action or configuration from the user
</ResponseField>

<ResponseField name="flowTypes" type="string[]">
  The authentication flow types supported by this provider. Possible values: `qr`, `redirect`, `push`
</ResponseField>

<ResponseField name="scopes" type="string[]">
  The identity attributes (scopes) that can be retrieved from this provider (e.g., `name`, `birthdate`, `nationality`, `email`)
</ResponseField>

<ResponseField name="loa" type="number[]">
  The [Levels of Assurance (LoA)](/guides/concepts/assurance) supported by this provider
</ResponseField>

<RequestExample>
  ```bash theme={null}
  curl --request GET \
    --url 'https://sandbox.api.hopae.com/connect/v1/providers' \
    --user '{clientId}:{clientSecret}'
  ```
</RequestExample>

<ResponseExample>
  ```json theme={null}
  [
    {
      "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]
    }
  ]
  ```
</ResponseExample>