List verification history
Lists the verification history of the organisation, one page at a time, by updatedAt (newest first by default). The answer also has verificationHistoryStats, the counters of every verification request of the organisation, whatever the filters.
The filters combine (AND). The shortcuts presentationReceived, requestPending and verificationFailed replace the status filter; send one of them or status. search matches a part of holder.name or of presentationExchangeId, in any letter case.
A deleted verification, and the verifications of a deleted presentation definition, are not in the list.
Authorizations
AuthorizationstringheaderrequiredYour API key with the prefix
ApiKey:ApiKey <your-api-key>. Get an API key.Scope:
verifications: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:
10statusenum<string>[]Only the verifications with one of these statuses. Repeat the parameter, or give the values as one comma-separated list. An unknown value matches nothing.
presentationReceived,requestPendingandverificationFailedreplace this filter.Available options:
request_sent,request_received,presentation_pending,presentation_ackedExample:
["presentation_acked"]presentationDefinition Id stringOnly the verifications of this presentation definition (its
presentationDefinitionId). A value that is not a UUID matches nothing.individualId stringGives only the records of this individual (the
individualIdof the request that made them).mapperId stringGives only the records of the individual with this mapper id (the
mapperIdof the request that made them).holderDid stringOnly the verifications whose
holder.nameis exactly this value, for example the DID of the holder.searchstringText 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:
descresponseCode stringOnly the verification whose
requestStateis this value. Use it to find the verification of one response of a wallet.presentationReceived booleantrue: only the verifications with statuspresentation_acked(answered). Replaces thestatusfilter. Only the exact valuetruecounts.requestPending booleantrue: only the verifications with statusrequest_sentorrequest_received(no answer yet, expired requests too). Replaces thestatusfilter.verificationFailed booleantrue: only the answered verifications withisVerifiedfalse. Replaces thestatusfilter.
Response
One page of the verification history with the counters of the organisation.
verificationHistory object[]The verifications 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.