Skip to main content
Organisation wallet units

List organisation wallet units

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

Lists the organisation wallet units of the wallet provider, the last changed first, one page at a time. Each row has the state of the wallet unit and of its Wallet Unit Attestations, and the EBWOID (European Business Wallet Organisation Identifier) state and the usage counts of the holder organisation from the daily usage reports of the wallet unit (see Read organisation wallet unit statistics). A deleted wallet unit is not listed.

The wallet provider registers a wallet unit, not authorised, for each new organisation wallet: authorise it with Update organisation wallet unit. All the filters of a query apply together. A bad offset or limit counts as not sent (0 and 10).

Authorizations

  • Authorizationstringheaderrequired

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

    Scope:organisation-wallet-units:read

Query parameters

  • wuaStatusenum<string>

    Gives only the organisation wallet units with this wuaStatus: unauthorised (no Wallet Unit Attestation yet), authorised, active or revoked. Not sent: no filter.

    Available options:unauthorised,authorised,active,revoked

  • ebwoidStatusenum<string>

    Gives only the organisation wallet units whose holder organisation has this EBWOID (European Business Wallet Organisation Identifier) status in the last daily usage report: inactive (no EBWOID), active, expired or revoked. A unit without a usage report has no status and matches no value. Not sent: no filter.

    Available options:inactive,active,expired,revoked

  • organisationNamestring

    Gives only the organisation wallet units whose holder organisation name contains this text, without regard to case. Not sent: no filter.

  • 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

  • holderOrganisationIdsstring

    Gives only the organisation wallet units of these holder organisations: a comma-separated list of at most 100 holder organisation IDs (UUIDs, the holderOrganisationId of a row). An ID without a wallet unit gives no row. When you send the parameter more than once, the API uses the IDs of every value. A part that is not a UUID, or more than 100 different IDs, gives 400. Not sent or empty: no filter.

    Example:"5a1f6c2e-8d3b-4f70-9c21-3e4b5d6a7f80,b8e2d4c6-1a3f-4e5d-8b7c-9f0a1b2c3d4e"

  • 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 organisation wallet units.

  • organisationWalletUnitobject[] | null

    The organisation wallet units of the page. An empty array when no wallet unit matches.

  • paginationobject

    The position of the page in the list.