Skip to main content
Presentations

Receive presentation request

POST/v4/config/ows/holder/presentations

Receives an OpenID4VP 1.0 Authorization Request of a verifier and makes a presentation record in the organisation wallet. The wallet resolves the request (also by reference with request_uri), checks its signature against the client identifier, runs the trusted list check of the signer when requiresTrustedRelyingParty is on, and stores the DCQL query, the transaction data and the response encryption parameters. It accepts only the response type vp_token. Each call makes a new record in presentation_pending, with the holder event ows.holder.presentation.request_received.

The wallet refuses a request locally when it cannot authenticate the verifier (OpenID4VP 1.0 section 5.9.2): a client_id prefix that it does not support, or a request of OpenID4VP draft 18. It sends nothing to the response_uri, and the answer is the record in request_refused with refusalReason. A request without dcql_query is refused the same way; the verifier gets the error response invalid_request only when the wallet verified its signed request object. A refused record cannot be filtered or sent.

Then:

  1. Show the verifier (clientMetadata, relyingPartyTrustedListCheck) and the requested claims (dcqlQuery, transactionDataDecoded) to the user.
  2. Find the matching held credentials with List matching credentials.
  3. Answer with Send presentation, or decline with Delete presentation.

With requiresTrustedRelyingParty on in the holder configuration, the wallet refuses a request whose signer is not trusted, and makes no record. An etsi_tl item of the DCQL query must name a list of acceptedEtsiTrustedLists: when no URL of an item is accepted, the wallet rejects the request with access_denied and the reason, and the call gives presentation.etsi_list_not_accepted.

Authorizations

  • Authorizationstringheaderrequired

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

    Scope:presentations:receive

Body

application/json

The Authorization Request of the verifier.

  • requestUrlstringrequired

    Required. The Authorization Request URI of the verifier, from its QR code or deep link (for example openid4vp://?client_id=...&request_uri=...).

    Example:"openid4vp://?client_id=x509_hash%3AUvRWsFzWB2aL6mJq0YxT3cK9dP4eN8hG1iA5bC7fE2s&request_uri=https%3A%2F%2Fverifier.example.com%2Frequest%2F8f2b1c9e"

Response

application/json

The new presentation record.

  • presentationobject

    The presentation record, in presentation_pending, or in request_refused when the wallet refused the request. Its presentationId is the path value of the next calls.