Skip to main content
Verification

List verification history

GET/v4/config/ows/verifier/verifications

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

  • Authorizationstringheaderrequired

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

    Scope:verifications: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

  • statusenum<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, requestPending and verificationFailed replace this filter.

    Available options:request_sent,request_received,presentation_pending,presentation_acked

    Example:["presentation_acked"]

  • presentationDefinitionIdstring

    Only the verifications of this presentation definition (its presentationDefinitionId). A value that is not a UUID matches nothing.

  • individualIdstring

    Gives only the records of this individual (the individualId of the request that made them).

  • mapperIdstring

    Gives only the records of the individual with this mapper id (the mapperId of the request that made them).

  • holderDidstring

    Only the verifications whose holder.name is exactly this value, for example the DID of the holder.

  • 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

  • responseCodestring

    Only the verification whose requestState is this value. Use it to find the verification of one response of a wallet.

  • presentationReceivedboolean

    true: only the verifications with status presentation_acked (answered). Replaces the status filter. Only the exact value true counts.

  • requestPendingboolean

    true: only the verifications with status request_sent or request_received (no answer yet, expired requests too). Replaces the status filter.

  • verificationFailedboolean

    true: only the answered verifications with isVerified false. Replaces the status filter.

Response

application/json

One page of the verification history with the counters of the organisation.

  • verificationHistoryobject[]

    The verifications 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.