Skip to main content

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

    lpidStatus stringrequired

    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.

    wuaStatus stringrequired

    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.

    organisationName stringrequired

    Filter by organisation name.

    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.

Header Parameters

    X-SandboxOrgId stringrequired

    Optional. Unique identifier of the sandbox organisation to use for this request. When you send this header, the service runs the operation in the context of the named sandbox organisation, that is, against the wallet of that sandbox organisation and not against the main wallet of the organisation. Leave the header out to use the main wallet.

    The service reads this header only when you authenticate with a bearer access token. When you authenticate with an API key, the service takes the sandbox organisation from the API key and ignores this header. To run an API-key call in a sandbox organisation, bind the key to the sandbox organisation with PUT /v2/config/admin/apikey/{apiKeyId}/sandbox-org instead.

    X-SubwalletId is the deprecated name of this header. The service continues to accept it, but X-SandboxOrgId wins if you send both headers.

    The sandbox organisation must exist, must belong to your organisation and must be deployed. An unknown identifier, an identifier of a sandbox organisation that is not deployed, and an identifier that belongs to a different organisation all make the call fail with HTTP 400.

    Example: 6889e1a4c5b2f30001a3d710

Responses​

The wallet provider returned the organisation wallet units.

Response Headers
    Schema
      organisationWalletUnit object[]required

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

    • Array [
      • organisationName stringrequired

      Name of the organisation.

      lpidStatus stringrequired

      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.

      lpidExpiry integerrequired

      Unix timestamp (in seconds) when the LPID credential expires. The value is 0 when the organisation has no LPID credential.

      wuaStatus stringrequired

      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.

      wuaExpiry integerrequired

      Unix timestamp (in seconds) when the Wallet Unit Attestation expires. The value is 0 when the organisation has no Wallet Unit Attestation.

      issuedCredentials int64required

      Total number of credentials that the organisation issued.

      verifications int64required

      Total number of verifications that the organisation performed.

      lastActivity stringrequired

      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.

      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

    Loading...
    Last updated on