List organisation wallet units
GET/v2/config/digital-wallet/openid/wallet-provider/organisation-wallet-units
Lists the organisation wallet units that the wallet provider manages. For each organisation, the response gives the status of the Legal Person Identification Data (LPID) credential, the status of the Wallet Unit Attestation (WUA), and usage counts. The organisation must have the wallet provider capability enabled.
The service replaces an offset that is less than 0 and a limit that is 0 or less with the default value. If offset is larger than the number of results, the service returns the last page.
Request
Query Parameters
Possible values: [inactive, active, expired, revoked]
Filter by Legal Person Identification Data (LPID) credential status. The service compares the value exactly, so an unknown value matches no organisation.
Possible values: [unauthorised, authorised, active, expired, revoked]
Filter by Wallet Unit Attestation (WUA) lifecycle status. The service compares the value exactly, so an unknown value matches no organisation.
Filter by organisation name.
Default value: 0
Number of records to skip for pagination. A negative or unreadable value falls back to 0.
Default value: 10
Maximum number of records to return per page.
Responses
- 200
- 400
- 401
- 500
The wallet provider returned the organisation wallet units.
Response Headers
- application/json
- Schema
- Example (from schema)
Schema
- Array [
- ]
organisationWalletUnit object[]required
The organisation wallet units on the current page. The list is empty if no organisation wallet unit agrees with the filters.
Name of the organisation.
Possible values: [``, inactive, active, expired, revoked]
Status of the Legal Person Identification Data (LPID) credential. The value is an empty string when the lookup fails.
Unix timestamp (in seconds) when the LPID credential expires. The value is 0 when the organisation has no LPID credential.
Possible values: [``, unauthorised, authorised, active, expired, revoked]
Lifecycle status of the Wallet Unit Attestation (WUA). unauthorised means the wallet unit is not authorised. authorised means the wallet unit is authorised but has no Wallet Unit Attestation yet. The value is an empty string when the lookup fails.
Unix timestamp (in seconds) when the Wallet Unit Attestation expires. The value is 0 when the organisation has no Wallet Unit Attestation.
Total number of credentials that the organisation issued.
Total number of verifications that the organisation performed.
Time of the last issuance or verification activity of the organisation. The value is an empty string when the service recorded no activity.
pagination objectrequired
Page details for the result set.
Current page number
Total number of items available
Total number of pages based on limit
Number of items per page
Indicates if there's a previous page
Indicates if there's a next page
{
"organisationWalletUnit": [
{
"organisationName": "string",
"lpidStatus": "active",
"lpidExpiry": 0,
"wuaStatus": "active",
"wuaExpiry": 0,
"issuedCredentials": 0,
"verifications": 0,
"lastActivity": "string"
}
],
"pagination": {
"currentPage": 1,
"totalItems": 25,
"totalPages": 3,
"limit": 10,
"hasPrevious": false,
"hasNext": true
}
}
The organisation is not a wallet provider.
Response Headers
- application/json
- Schema
- Example (from schema)
Schema
{
"errorCode": 400,
"errorDescription": "Bad input parameter"
}
Unauthorized
Response Headers
- application/json
- Schema
- Example (from schema)
Schema
{
"errorCode": 400,
"errorDescription": "Bad input parameter"
}
Internal server error
Response Headers
- application/json
- Schema
- Example (from schema)
Schema
{
"errorCode": 400,
"errorDescription": "Bad input parameter"
}