Skip to main content
Presentation definitions

List presentation definitions

GET/v4/config/ows/verifier/presentation-definitions

Lists the presentation definitions of the organisation, one page at a time, by updatedAt (newest first by default). Each item has the presentation definition and the counters of its verification requests. The answer also has verificationHistoryStats, the counters of every verification request of the organisation.

search matches a part of the label or of the presentationDefinitionId, in any letter case. transactionDataType keeps the definitions of one transaction data template. Set skipCounts=true for a faster answer when you do not need the counters of each item.

Authorizations

  • Authorizationstringheaderrequired

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

    Scope:presentation-definitions:read

Query parameters

  • 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

  • searchstring

    Text to search for. The description of the operation says which fields it searches.

  • sortOrderenum<string>

    Sort order: desc (default, newest first) or asc (oldest first). Any other value is desc.

    Available options:desc,asc

    Default:desc

  • transactionDataTypeenum<string>

    Only the presentation definitions with this transactionDataDefinitionType.

    Available options:payment_data,payment,login_risk_transaction,login_risk_transaction_non_ts12,account_access,emandate,data_agreement_record,data_disclosure_agreement_record,qes_data

  • skipCountsboolean

    true: the server does not count the verification requests of each item, and every counter of the items is 0. verificationHistoryStats is still counted. Default false.

    Default:false

Response

application/json

One page of presentation definitions with their counters.

  • presentationDefinitionobject[]

    The presentation definitions of the page. Empty when none matches.

  • paginationobject
  • verificationHistoryStatsobject

    The counters of every verification request of the organisation, without the requests of deleted presentation definitions. The filters and the page do not change them. verificationFailed is a part of presentationReceived, so the counters do not add up to total. Zero counters when the server cannot count.