Skip to main content
Holder configuration

Update holder configuration

PATCH/v4/config/ows/holder/configuration

Changes the holder configuration of the organisation wallet. Send only the fields to change: a field that you leave out keeps its stored value, and a sent list replaces the stored list. A new credentialStatusRefreshIntervalSeconds also sets the time of the next automatic status check of the held credentials (now plus the interval). The trust settings apply to the next credentials and presentation requests that the wallet receives. With requiresTrustedRelyingParty on, the wallet also refuses to answer a stored request whose recorded relyingPartyTrustedListCheck is not trusted.

Authorizations

  • Authorizationstringheaderrequired

    Your API key with the prefix ApiKey: ApiKey <your-api-key>. Get an API key.

    Scope:wallet:update

Body

application/json

The fields to change.

  • isCredentialEncryptionEnabledboolean

    true: the wallet asks the issuers for encrypted Credential Responses. A JSON boolean; null gives HTTP 400.

    Example:true

  • credentialStatusRefreshIntervalSecondsinteger

    Seconds between two automatic revocation status checks of the held credentials. 0 stops the automatic checks; null is 0.

    At least 0.

    Example:3600

  • redirectUrlstring

    The redirect URL that the wallet sends in the OpenID4VCI Authorization Request. An absolute URL, or "" (also null) for the callback URL of the wallet.

    Example:"https://wallet.example.com/callback"

  • requiresPushedAuthorisationRequestsboolean

    true: the wallet sends the Authorization Request of the Authorization Code Flow as a Pushed Authorization Request (PAR, RFC 9126). null is false.

  • requiresTrustedCredentialSignerboolean

    true: the wallet does not keep a received credential when no trust source of acceptedCredentialSigners has its issuer. Needs acceptedCredentialSigners. null is false.

  • acceptedCredentialSignersstring (uuid)[]

    The accepted issuers: the id of each trust source that the issuer must come from. Get the ids with List trust sources. Required when requiresTrustedCredentialSigner is true.

  • requiresTrustedIssuerboolean

    true: the wallet refuses a credential when no trust source of acceptedIssuers has the signer of the signed issuer metadata. An issuer that does not sign its metadata is refused too. Off: the wallet does not fetch or check the signed metadata. Needs acceptedIssuers. null is false.

  • acceptedIssuersstring (uuid)[]

    The accepted signers of the signed issuer metadata: the id of each trust source used for access_certificate_provider. Required when requiresTrustedIssuer is true.

  • requiresTrustedStatusIssuerboolean

    true: the wallet does not accept a received credential when the signer of its status list does not pass. The credential signer passes when acceptCredentialSignerAsStatusIssuer is true; any other signer must come from a trust source of acceptedStatusIssuers. null is false.

  • acceptCredentialSignerAsStatusIssuerboolean

    true: the credential signer may also sign the status list of the credential, with no list lookup. null is true.

  • acceptedStatusIssuersstring (uuid)[]

    The accepted status issuers: the id of each trust source used for status_issuer. Required when requiresTrustedStatusIssuer is true and acceptCredentialSignerAsStatusIssuer is false.

  • requiresTrustedRelyingPartyboolean

    true: the wallet does not answer a presentation request when no trust source of acceptedRelyingParties has its signer, or when acceptedClientIds is set and does not have the client_id. An unsigned request has no signer, so it is refused. Needs acceptedRelyingParties. null is false.

  • acceptedRelyingPartiesstring (uuid)[]

    The accepted verifiers: the id of each trust source that the access certificate of the verifier must come from. Required when requiresTrustedRelyingParty is true.

  • acceptedClientIdsstring[]

    The accepted client IDs of the verifiers, each with the prefix x509_san_dns: or x509_hash:. An optional narrowing of acceptedRelyingParties: an empty list does not narrow. Effect only with requiresTrustedRelyingParty true.

  • acceptedEtsiTrustedListsstring (uuid)[]

    The ETSI list trust sources that an etsi_tl item of a DCQL request may name (kind etsi_trusted_list or etsi_lote). It has no switch. An item with no accepted URL rejects the request, with access_denied and the reason to the verifier.

Response

application/json

The holder configuration after the change.

  • globalConfigurationobject

    The holder configuration after the change.