Read wallet unit

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

Reads one wallet unit that the wallet provider manages. Give the wallet unit identifier in the path. 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.

Responses

200

The wallet provider returned the wallet unit.

Response Headers

application/json

Schema

Schema

walletUnit objectrequired

The wallet unit record.

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.

Example (from schema)

{
  "walletUnit": {
    "id": "string",
    "clientId": "string",
    "clientUrl": "string",
    "clientPublicKey": {},
    "isAuthorised": true,
    "assertionToken": "string",
    "assertionTokenType": "string",
    "createdAt": 0,
    "updatedAt": 0,
    "walletUnitDevicePlatform": "ios",
    "walletUnitIntegrityToken": "string",
    "walletUnitKeyId": "string",
    "walletUnitMetadata": {}
  }
}

400

The wallet unit does not exist, or the organisation is not a wallet provider.

Response Headers

application/json

Schema

Schema

errorCode integerrequired
errorDescription stringrequired

Example (from schema)

{
  "errorCode": 400,
  "errorDescription": "Bad input parameter"
}

401

Unauthorized

Response Headers

application/json

Schema

Schema

errorCode integerrequired
errorDescription stringrequired

Example (from schema)

{
  "errorCode": 400,
  "errorDescription": "Bad input parameter"
}

500

Internal server error

Response Headers

application/json

Schema

Schema

errorCode integerrequired
errorDescription stringrequired

Example (from schema)

{
  "errorCode": 400,
  "errorDescription": "Bad input parameter"
}

Loading...