Individual wallet units

List individual wallet units

GET/v4/config/ows/wallet-provider/individual-wallet-units

Lists the individual wallet units of the wallet provider, newest first, one page at a time. Filter by device platform, by authorisation or by client id (holderDid). A deleted wallet unit is not listed. Each wallet unit has the number of its rows in the wallet unit attestation issuance history.

A bad offset or limit counts as not sent (0 and 10). An offset after the last wallet unit starts the page at the last one.

Language of the request sample

curl 'https://demo-api.igrant.io/v4/config/ows/wallet-provider/individual-wallet-units?platform=ios&isAuthorised=true' \
  -H 'Authorization: ApiKey <your-api-key>'

{
  "individualWalletUnit": [
    {
      "id": "6bf3bd97-50ba-4fec-9a78-1076b5627b5a",
      "clientId": "wallet-unit-4f2a9c71",
      "clientUrl": "https://wallet.example.com/app",
      "clientPublicKey": {
        "kty": "EC",
        "crv": "P-256",
        "x": "Nbii9ohvDybKefFdAx4QfqqUAKPyZnihqOHDp3Z2jEA",
        "y": "DeBO5yAoahfS3HqfDmvrVsXvCzDrco4WLJ5wVIvTZ5s"
      },
      "isAuthorised": true,
      "clientMetadata": null,
      "attestationStatus": "authorised",
      "attestationExpiresAt": 0,
      "createdAt": 1794149364,
      "updatedAt": 1794149365,
      "devicePlatform": "android",
      "deviceIntegrityToken": "",
      "deviceKeyId": "",
      "assertionToken": "",
      "assertionTokenType": "",
      "totalCountOfCredentialHistory": 0
    },
    {
      "id": "90f0aa4e-c570-4147-973b-3a642573a0ae",
      "clientId": "urn:ietf:params:oauth:jwk-thumbprint:sha-256:NzbLsXh8uDCcd-6MNwXF4W_7noWXFZAfHkxZsRGC9Xs",
      "clientUrl": "",
      "clientPublicKey": {
        "kty": "EC",
        "crv": "P-256",
        "x": "TBAyLHPlOAO3G0CJOeC7d-qQFtwpevvqizOjtjUEbLE",
        "y": "4d_a0oRgxHvU3d3LaQaskdTPRBe5xX3O25mwzjSxzKY"
      },
      "isAuthorised": true,
      "clientMetadata": {},
      "attestationStatus": "active",
      "attestationExpiresAt": 1794181014,
      "createdAt": 1794086995,
      "updatedAt": 1794137814,
      "devicePlatform": "android",
      "deviceIntegrityToken": "<device-integrity-token>",
      "deviceKeyId": "",
      "assertionToken": "<client-assertion>",
      "assertionTokenType": "urn:ietf:params:oauth:client-assertion-type:jwt-bearer",
      "totalCountOfCredentialHistory": 2
    }
  ],
  "pagination": {
    "currentPage": 1,
    "totalItems": 14,
    "totalPages": 7,
    "limit": 2,
    "hasPrevious": false,
    "hasNext": true
  }
}

Authorizations

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

Query parameters

platformenum<string>
Gives only the individual wallet units of this device platform. Not sent: no filter.
Available options:ios,android
Example:"ios"
isAuthorisedboolean
true gives only the authorised wallet units, false only the wallet units that are not authorised. Another value or not sent: no filter.
Example:true
holderDidstring
Gives only the individual wallet unit with this clientId (exact match), usually the DID of the wallet. Not sent: no filter.
offsetinteger
Number of records to skip for pagination. A negative or unreadable value falls back to 0.
At least 0.
Default:0
limitinteger
Maximum number of records to return per page.
Default:10

Response

application/json

A page of individual wallet units.

individualWalletUnitobject[] | null
The individual wallet units of the page. An empty array when no wallet unit matches.
paginationobject
The position of the page in the list.