List wallet units

GET 
/v2/config/digital-wallet/openid/wallet-provider/wallet-units

Lists the wallet units that the wallet provider manages. Use the query parameters to filter by holder DID or by device platform, and to page through the results. 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

holderDid string

Filter by the holder's Decentralized Identifier (DID).

platform stringrequired
Filter by the device platform of the wallet unit. The known values are ios, android and organisation. The service does not check the value, so an unknown value matches no wallet unit.
Example: ios
offset integerrequired

Default value: 0

Number of records to skip for pagination. A negative or unreadable value falls back to 0.

limit integerrequired

Default value: 10

Maximum number of records to return per page.

Responses

200

The wallet provider returned the wallet units.

Response Headers

application/json

Schema

Schema

walletUnit object[]required

The wallet units on the current page. The list is empty if no wallet unit agrees with the filters.

pagination objectrequired

Page details for the result set.

currentPage integer

Current page number

totalItems integer

Total number of items available

totalPages integer

Total number of pages based on limit

limit integer

Number of items per page

hasPrevious boolean

Indicates if there's a previous page

hasNext boolean

Indicates if there's a next page

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": {},
      "totalCountOfCredentialHistory": 3
    }
  ],
  "pagination": {
    "currentPage": 1,
    "totalItems": 25,
    "totalPages": 3,
    "limit": 10,
    "hasPrevious": false,
    "hasNext": true
  }
}

400

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...