Skip to main content

Create holder global configuration

POST 
/v2/config/digital-wallet/openid/holder/global-configuration

Creates a global configuration for the holder wallet. The configuration sets credential encryption support, the credential status refresh interval, and the redirect URL for OID4VCI and OpenID4VP flows.

The service ignores redirectUrl in a create request and stores an empty string. Use the update operation to set the redirect URL.

Request​

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

Body

required

Settings that the holder wallet applies to all OID4VCI and OpenID4VP flows.

    supportCredentialEncryption booleanrequired

    When true, the wallet accepts encrypted OID4VCI Credential Responses. You must give this field.

    refreshCredentialStatusInterval integer

    Interval in seconds between two credential revocation status checks. Use 0 to stop the automatic checks.

    redirectUrl string

    Redirect URL that the wallet sends in the OAuth 2.0 Authorization Request during OID4VCI credential issuance. The service ignores this field in a create request. Use the update operation to set it.

    requirePushedAuthorizationRequests boolean

    Default value: false

    When true, the wallet uses a Pushed Authorization Request (PAR) for the OID4VCI Authorization Code flow. The service uses false when you leave this field out.

Responses​

The wallet created the holder global configuration.

Response Headers
    Schema
      holderGlobalConfiguration object

      Global configuration of the holder wallet. It holds the settings that every OID4VCI and OpenID4VP flow of the organisation uses.

      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.

    Loading...
    Last updated on