Organisation wallet units

Update organisation wallet unit

PUT/v4/config/ows/wallet-provider/organisation-wallet-units/{walletUnitId}

Authorises an organisation wallet unit, or stops it. Only isAuthorised changes: the wallet makes the other members from the holder organisation. After true, the wallet provider fills the WUA pool of the wallet unit on its schedule; to fill it at once, use Issue organisation wallet unit attestations.

false on an authorised wallet unit is the kill switch. In the same change, the wallet provider revokes (Revoked) every active Wallet Unit Attestation (WUA) of the wallet unit on its status list, and the copies that the holder organisation keeps, so an issuer that checks the status refuses the organisation wallet at once. The key attestations do not change. When you authorise a revoked wallet unit again, its revoked WUAs stay revoked and the scheduled refill skips it: fill its pool with Issue organisation wallet unit attestations.

Language of the request sample

curl -X PUT 'https://demo-api.igrant.io/v4/config/ows/wallet-provider/organisation-wallet-units/{walletUnitId}' \
  -H 'Authorization: ApiKey <your-api-key>' \
  -H 'Content-Type: application/json' \
  -d '{
  "isAuthorised": true
}'

{
  "organisationWalletUnit": {
    "id": "02333e97-a67a-4bf0-9edc-9b11c6268ee8",
    "clientId": "urn:ietf:params:oauth:jwk-thumbprint:sha-256:NzbLsXh8uDCcd-6MNwXF4W_7noWXFZAfHkxZsRGC9Xs",
    "clientUrl": "https://demo-api.igrant.io/organisation/60905277-d953-4ef7-aa4c-cec413d00d93/service/credential-offer",
    "clientPublicKey": {
      "alg": "ES256",
      "crv": "P-256",
      "kid": "31abbd863614476e96567f844d8c8d12",
      "kty": "EC",
      "x": "2y902PApygdv1kXHW8zbOnN9yJ-EDrarHLezRwRvQRs",
      "y": "O2vBdXln5fi2Fk8wNgq5f4rKk6Fb6_CiylbKNESmIws"
    },
    "isAuthorised": true,
    "clientMetadata": {
      "client_name": "Example Bank AB",
      "logo_uri": "https://demo-api.igrant.io/v2/onboard/image/6ae2bf741c3dadfeb27982ee/web",
      "location": "Location 1",
      "cover_uri": "https://demo-api.igrant.io/v2/onboard/image/6ae2bf741c3dadfeb27982ed/web",
      "description": "Test organization 1"
    },
    "attestationStatus": "active",
    "attestationExpiresAt": 1794192362,
    "createdAt": 1793245044,
    "updatedAt": 1794149162,
    "holderOrganisationId": "60905277-d953-4ef7-aa4c-cec413d00d93",
    "holderOrganisationName": "Example Bank AB"
  }
}

Authorizations

Authorizationstringheaderrequired
Your API key with the prefix ApiKey: ApiKey <your-api-key>. Get an API key.
Scope:organisation-wallet-units:update

Path parameters

walletUnitIdstring<uuid>required
The id of the wallet unit, from the list of the wallet units of its kind. The routes of each kind read only their kind: the id of an organisation wallet unit gives 404 on an individual wallet unit route, and the other way round. A deleted wallet unit also gives 404.

Body

application/json

The new authorisation of the wallet unit.

isAuthorisedbooleanrequired
Required. true authorises the organisation wallet unit, so that it gets Wallet Unit Attestations. false on an authorised wallet unit is the kill switch: the wallet provider also revokes every active WUA of the wallet unit and the copies that its holder organisation keeps, in the same change.
Example:false

Response

application/json

The organisation wallet unit after the change.

organisationWalletUnitobject
The organisation wallet unit after the change.