Skip to main content
Wallet unit history

Read organisation wallet unit history

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

Reads the Wallet Unit History of an organisation wallet unit: the events that the wallet provider recorded for the wallet unit, newest first, one page at a time. The events are the registration, the authorisation, the refills of the WIA pool of each day (wias_issued, actor system for the scheduled refill), the key attestations of the holder keys, the revocation with its actor and reason, the revocation of a keystore type of its key attestations, and the delete with the scheduled deletion of the wallet of the holder organisation. An event holds no token, no key, no certificate and no claim value.

Filter with eventType (one event type, or a comma-separated list). eventTypeCounts has the number of events of each event type of the wallet unit, counted without the filter. To read the next page, send the nextCursor of the answer as cursor. With includeTotal=true the answer also has total and totalCapped, counted with the filter. The history keeps about 4 months of events: the events of a month go 120 days after the end of the month (by default, the 90 days of the status maintenance and 30 days more). A deleted organisation wallet unit has its history while it is in the list of the organisation wallet units, that is until the purge of its holder organisation.

The pages are the cursor pages of the other lists of the API, for example List issuance history: limit (default 20), cursor, and offset (up to 10000, only without cursor) to jump to a page of a pager.

Authorizations

  • Authorizationstringheaderrequired

    Your API key with the prefix ApiKey: ApiKey <your-api-key>. Get an API key.

    Scope:organisation-wallet-units:read

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 individual wallet unit also gives 404. A deleted organisation wallet unit stays in its list until the purge of its holder organisation: until then its read and its Wallet Unit History answer, and its other operations give 404.

Query parameters

  • eventTypestring

    Gives only the events of these event types: one value, or a comma-separated list (eventType=keyAttestationIssued,revoked). The event types are registered, wiasIssued, keyAttestationIssued, requestRefused, revocationCodeIssued, devicePropertiesChanged, authorised, revoked, keystoreTypeRevoked and deleted. The service reads only the first eventType parameter: a repeated parameter is not a list. An unknown value is ignored, and a list with no known value is no filter. Not sent: all events. The filter does not change eventTypeCounts.

    Example:"keyAttestationIssued,revoked"

  • limitinteger

    The most items in the page: 1 to 100, default 20. Another value gives HTTP 400.

    From 1 to 100.

    Default:20

  • cursorstring

    The nextCursor of the page before, to read the next page. Leave it out for the first page. Use it as it is: a changed cursor gives HTTP 400. Do not send it with offset (HTTP 400).

  • offsetinteger

    How many items come before the page: 0 to 10000. Use it only to jump to a page of a pager, then continue with the nextCursor of the answer. Do not send it with cursor (HTTP 400). Another value gives HTTP 400.

    From 0 to 10000.

  • includeTotalboolean

    true: the answer also has total and totalCapped, the number of items of the filtered list. Send it on the first page only, for a pager. Default false. Another value gives HTTP 400.

    Default:false

Response

application/json

A page of the events of the wallet unit, newest first.

  • itemsobject[]

    The events of the page, newest first (occurredAt, then id). Empty when no event matches.

  • nextCursorstring | null

    The cursor of the next page, or null on the last page.

    Example:"eyJjIjoiMjAyNi0xMS0xNlQwODowNTowMVoiLCJpIjoiNDBhYSJ9"

  • totalinteger

    The number of items of the filtered list, at most 10000. Only with includeTotal=true. When the list has more items, the value is 10000 and totalCapped is true.

    From 0 to 10000.

    Example:137

  • totalCappedboolean

    true when the filtered list has more than 10000 items: total then shows 10000. Only with includeTotal=true.

    Example:false

  • eventTypeCountsobject

    The number of events of each event type of the wallet unit, counted without the eventType filter: the counts do not change when you filter. Each event type is a member, also with 0. A daily summary is one event, so wiasIssued counts the days with WIAs: the number of WIAs is the count fact of each summary. The sum of the counts is the number of all events of the wallet unit.