Skip to main content

Update wallet unit

PUT 

/v2/config/digital-wallet/openid/wallet-provider/wallet-unit/:walletUnitId

Updates one wallet unit that the wallet provider manages. Every field is optional, and a field that you leave out keeps the stored value. isAuthorised: false on an authorised wallet unit revokes every active Wallet Unit Attestation of that unit in the same change: issuers that check the status list then refuse the unit, and the unit gets no new attestation until you set isAuthorised: true again. The organisation must have the wallet provider capability enabled.

Request​

Path Parameters

    walletUnitId stringrequired

    Unique identifier of a wallet unit registration managed by the Wallet Provider.

Body

required

New values for the wallet unit.

    clientId string

    Client identifier of the wallet instance. This is a DID or a URL. The wallet provider uses it to identify the wallet during OID4VCI and OpenID4VP flows. The service keeps the stored value when you send an empty string.

    clientUrl string

    URL endpoint of the wallet instance.

    clientPublicKey object

    Public key of the wallet instance in JWK format. The wallet provider uses this key to verify the Wallet Unit Attestation Proof of Possession.

    property name* any

    Public key of the wallet instance in JWK format. The wallet provider uses this key to verify the Wallet Unit Attestation Proof of Possession.

    isAuthorised boolean

    true authorises the wallet unit, so that it can get a Wallet Unit Attestation. false stops the unit and revokes its active Wallet Unit Attestations. Leave it out to keep the stored value.

Responses​

The wallet provider updated the wallet unit.

Response Headers
    Schema
      walletUnit objectrequired

      The wallet unit record after the update.

      id stringrequired

      Unique identifier for the wallet unit record. Use this value as the walletUnitId path parameter.

      clientId stringrequired

      Client identifier of the wallet instance, typically a DID or URL. Used to identify the wallet during OID4VCI and OpenID4VP protocol interactions.

      clientUrl stringrequired

      URL endpoint of the wallet instance, used for direct communication.

      clientPublicKey objectnullablerequired

      Public key JWK of the wallet instance, used to verify Wallet Unit Attestation Proof of Possession.

      property name* anynullable

      Public key JWK of the wallet instance, used to verify Wallet Unit Attestation Proof of Possession.

      isAuthorised booleanrequired

      When true, this wallet unit is authorized to interact with the Wallet Provider's services.

      assertionToken stringrequired

      Client assertion JWT of the wallet unit, used for OAuth 2.0 client authentication. This value is secret. Treat it as a credential and do not write it to logs.

      assertionTokenType stringrequired

      Type of the client assertion token.

      createdAt int64required

      Unix timestamp (in seconds) when this wallet unit was registered.

      updatedAt int64required

      Unix timestamp (in seconds) when this wallet unit record was last modified.

      walletUnitDevicePlatform stringrequired

      Device platform of the wallet unit. The known values are ios, android and organisation. The service does not check the value.

      walletUnitIntegrityToken stringrequired

      Device integrity token supplied by the wallet unit during registration, for example an App Attest or Play Integrity token.

      walletUnitKeyId stringrequired

      Identifier of the cryptographic key that the wallet unit registered for attestation.

      walletUnitMetadata objectnullablerequired

      Additional metadata that the wallet unit supplied during registration.

      property name* anynullable

      Additional metadata that the wallet unit supplied during registration.

    Loading...