List 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
AuthorizationstringheaderrequiredYour API key with the prefix
ApiKey:ApiKey <your-api-key>. Get an API key.Scope:
presentation-definitions:read
Query parameters
offsetintegerNumber of records to skip for pagination. A negative or unreadable value falls back to
0.At least 0.
Default:
0limitintegerMaximum number of records to return per page.
Default:
10searchstringText to search for. The description of the operation says which fields it searches.
sortOrder enum<string>Sort order:
desc(default, newest first) orasc(oldest first). Any other value isdesc.Available options:
desc,ascDefault:
desctransactionData Type enum<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_dataskipCounts booleantrue: the server does not count the verification requests of each item, and every counter of the items is0.verificationHistoryStatsis still counted. Defaultfalse.Default:
false
Response
One page of presentation definitions with their counters.
presentationDefinition object[]The presentation definitions of the page. Empty when none matches.
paginationobjectverificationHistory Stats objectThe counters of every verification request of the organisation, without the requests of deleted presentation definitions. The filters and the page do not change them.
verificationFailedis a part ofpresentationReceived, so the counters do not add up tototal. Zero counters when the server cannot count.