Skip to main content

List holder global configuration

GET 

/v2/config/digital-wallet/openid/holder/global-configurations

Lists the holder global configurations for OID4VCI and OpenID4VP flows. The wallet sorts the configurations by last update time, newest first.

Request

Query Parameters

    offset integerrequired

    Default value: 0

    Number of records to skip for pagination. A negative or unreadable value falls back to 0.

    limit integerrequired

    Default value: 10

    Maximum number of records to return per page.

Header Parameters

    X-SandboxOrgId stringrequired

    Optional. Unique identifier of the sandbox organisation to use for this request. When you send this header, the service runs the operation in the context of the named sandbox organisation, that is, against the wallet of that sandbox organisation and not against the main wallet of the organisation. Leave the header out to use the main wallet.

    The service reads this header only when you authenticate with a bearer access token. When you authenticate with an API key, the service takes the sandbox organisation from the API key and ignores this header. To run an API-key call in a sandbox organisation, bind the key to the sandbox organisation with PUT /v2/config/admin/apikey/{apiKeyId}/sandbox-org instead.

    X-SubwalletId is the deprecated name of this header. The service continues to accept it, but X-SandboxOrgId wins if you send both headers.

    The sandbox organisation must exist, must belong to your organisation and must be deployed. An unknown identifier, an identifier of a sandbox organisation that is not deployed, and an identifier that belongs to a different organisation all make the call fail with HTTP 400.

    Example: 6889e1a4c5b2f30001a3d710

Responses

The wallet returns the holder global configurations.

Response Headers
    Schema
      holderGlobalConfiguration object[]required

      Holder global configurations on the requested page. The array is empty when the wallet holds no configurations.

    • Array [
    • id stringrequired

      Record identifier of the holder global configuration. The service makes this value when it saves the record. It is not the same value as holderGlobalConfigurationId.

      holderGlobalConfigurationId stringrequired

      Unique identifier of the holder global configuration. Give this value in the path of the read, update and delete operations.

      openIdOrganisationId stringrequired

      Identifier of the digital wallet deployment that holds this configuration.

      supportCredentialEncryption booleanrequired

      When true, the wallet accepts encrypted OID4VCI Credential Responses.

      refreshCredentialStatusInterval integerrequired

      Interval in seconds between two credential revocation status checks.

      redirectUrl stringrequired

      Redirect URL that the wallet sends in the OAuth 2.0 Authorization Request during OID4VCI credential issuance. The create operation always returns an empty string, because the service sets this value only through the update operation.

      requirePushedAuthorizationRequests booleanrequired

      When true, the wallet uses a Pushed Authorization Request (PAR, RFC 9126) for the OID4VCI Authorization Code flow. The read, update and list operations can return the value from before the last update. See the update operation.

      createdAt numberrequired

      Unix timestamp (in seconds) when this configuration was created.

      updatedAt numberrequired

      Unix timestamp (in seconds) when this configuration was last modified.

    • ]
    • pagination object
      currentPage integer

      Current page number

      totalItems integer

      Total number of items available

      totalPages integer

      Total number of pages based on limit

      limit integer

      Number of items per page

      hasPrevious boolean

      Indicates if there's a previous page

      hasNext boolean

      Indicates if there's a next page

    Loading...