Skip to main content

List presentation definition

GET 
/v2/config/digital-wallet/openid/sdjwt/presentation-definitions

Lists the presentation definitions of the organisation. The server sorts them by updatedAt and uses sortOrder for the direction.

Each item holds the presentation definition and the verification counters for that presentation definition. In this list the id of each item equals its presentationDefinitionId.

The response also holds verificationHistoryStats. These counters cover every verification exchange record of the organisation, not only the current page.

Set skipCounts to true to skip the per item counters. The server then returns zero for every counter of every item, and the answer is faster.

search finds a presentation definition by its label or by its presentationDefinitionId. The search is not case-sensitive.

Request​

Query Parameters

    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.

    search stringrequired

    Search term to filter results by

    sortOrder stringrequired

    Possible values: [desc, asc]

    Default value: desc

    Sort order for the returned records (ascending or descending).

    transactionDataType stringrequired

    Possible values: [payment_data, payment, login_risk_transaction, login_risk_transaction_non_ts12, account_access, emandate, data_agreement_record, data_disclosure_agreement_record, qes_data]

    Filter by the transaction data type of the presentation definition. The server compares this value with transactionDataDefinitionType.

    skipCounts booleanrequired

    Default value: false

    Set to true to skip the per item verification counters. Every counter of every item is then zero. Use this option for a faster answer.

Responses​

The server listed the presentation definitions.

Response Headers
    Schema
      presentationDefinition object[]required

      Presentation definitions for the current page. The array is empty when the organisation has no presentation definition.

      pagination objectrequired
      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

      verificationHistoryStats objectrequired

      Counters for every verification exchange record of the organisation. The filters and the pagination do not change these values. A record can be in more than one counter, so the counters do not add up to total.

      total integerrequired

      Number of verification exchange records.

      presentationReceived integerrequired

      Number of records with status presentation_acked.

      requestPending integerrequired

      Number of records with status request_sent or request_received.

      verificationFailed integerrequired

      Number of records with status presentation_acked and verified equal to false.

      expired integerrequired

      Always 0.

    Loading...
    Last updated on