> For the complete documentation index, see [llms.txt](https://docs.meeco.me/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.meeco.me/svx-v3/guides/api-guides/openid-connect/oidc4vp.md). # For Verifiable Presentation Below is a list of endpoints that assist a Holder wallet and a Verifier to participate in the [OpenID for Verifiable Presentations](https://openid.net/specs/openid-4-verifiable-presentations-1_0.html) protocol. Built on top of OAuth 2.0, it allows a client (wallet) to present claims in the form of [W3C Verifiable Credentials](https://www.w3.org/TR/vc-data-model/). Currently, credentials and presentations in JWT format (vc-jwt, vp-jwt) are supported. The endpoints provided are to support the following high-level verification flow: ```mermaid sequenceDiagram autonumber participant H as End User participant W as Wallet/SIOP participant V as Verifier/RP V->>V: Create Request object V->>V: Generates and displays
QR Code with `request_uri` H-->>W: Opens app W-->>V: Scans QR Code W->>W: Obtains `request_uri`
from QR Code W->>V: Retrieve Request object
(signed JWT) W->>W: Verify Request W->>W: Identify VCs required
in the Request object W->>W: Generates a VP W->>W: Create Response object W->>V: Post Response to /redirect_uri V->>V: Verify Response V-->>W: Acknowledgement ``` The flow centres around the creation and exchange of a Request and a Response object, by the Verifier and Holder (wallet) respectively. The endpoints are categorised under these two headings. ## Prerequisites * [DID](/svx-v3/guides/api-guides/dids/did-methods.md) * [Presentation](/svx-v3/guides/api-guides/credentials/presentations.md) ## Who can undertake this operation? Organisations (Verifiers) and users (Holders) in a verification flow using the OpenID Connect protocol. ## Request List of endpoints to help create and verify the [Request](https://openid.net/specs/openid-4-verifiable-presentations-1_0.html#name-request) part of the verification flow. ### Create Presentation Requests Creation of a presentation request. **Endpoint** ```bash POST /oidc/presentations/requests ``` **Request** * Organisation (header, optional) * Name – Title string * Description – Explains the purpose for which the request is created * Verifier * [DID](/svx-v3/guides/api-guides/dids/did-methods.md) * Name * Expiration Date – Timestamp the request token expires * Redirect Base URI * [Presentation Definition](/svx-v3/guides/api-guides/credentials/presentation-definitions.md) **Response** The presentation request object that includes an unsigned JWT. The client calling this endpoint (e.g. verifier system) is responsible for adding the signature. ### Update Presentation Request Update an existing presentation request by ID. One of the options is to use the platform to host the (signed) request (see [here](#read-presentation-request-jwt)). The request parameters can't be updated, only the signed request JWT. **Endpoint** ```bash PUT /oidc/presentations/requests/{id} ``` **Request** * Request ID * Organisation (header, optional) * Signed request JWT **Response** The updated presentation request object. ### Read Presentation Request JWT A public endpoint that returns the (signed) presentation request JWT. **Endpoint** ```bash GET /oidc/presentations/requests/{id}/jwt ``` **Request** * Request ID **Response** Signed presentation request JWT token. ### Verify Presentation Request Verification of the SIOP token. The steps performed during this verification are: 1. Resolve Verifier DID 2. Verify request signature 3. Extract the presentation definition URI * Verify presentation definition structure **Endpoint** ```bash POST /oidc/presentations/requests/verify ``` **Request** * Signed presentation request JWT **Responses** The result of the verification, either true or false. ## Response List of endpoints to help create and verify the [Response](https://openid.net/specs/openid-4-verifiable-presentations-1_0.html#name-response) part of the verification flow. ### Create Presentation Response Generate id\_token for request submission based on the wallet information and the verifiable presentation token. **Endpoint** ```bash POST /oidc/presentations/token ``` **Request** * Presentation Request JWT **Response** The presentation response object that includes two unsigned JWTs, `id_token` and `vp_token`. The client calling this endpoint (e.g. Holder wallet) is responsible for adding the signatures for each token. ### Verify Presentation Response Verify the presentation response to a given request. The steps performed are: 1. Verify ID Token 2. Verify VP Token * [Verify presentation](/svx-v3/guides/api-guides/credentials/presentations.md) 3. Verify if the response is valid for the given request, i.e. if it matches the presentation definition from the request **Endpoint** ```bash POST /oidc/presentations/response/verify ``` **Request** * Presentation Request JWT * Signed ID Token * Signed VP Token **Response** The result of the verification, either true or false. In case of false, all errors are provided, with an explanation. ## Detailed Sequence Diagram of the Flow (API integration) ```mermaid sequenceDiagram title Verify Credentials with API only autonumber participant W as Wallet participant V as Verifier System participant API as SVX API %% %% Terms: %% VP - Verifiable presentation %% VP token - wrapping structure over a verifiable presentation. %% opt RESTful-API call to fetch details of organisation %% Get the DID for the organisation V-->>+API: GET /me MEECO_ORGANISATION_ID={org_id) API-->-V: 200 OK and me object (did_external_id, private_dek_external_id) %% Get the private key associated with DID for the organisation V->>+API: GET /keypairs/{did_external_id} API-->>-V: 200 OK and did signing keypair end %% Create presentation definition opt RESTful-API call to create or retrieve presentation definition V->>+API: POST /presentation_definitions API-->>-V: 200 and presentation definitions created V->>+API: GET /presentation_definitions/{id} API-->>-V: 200 and presentation definitions created end %% Create a presentation request V->>+API: POST /oidc/presentations/request API-->>-V: 201 OK and OIDC request string %% Sign request JWT V->>V: Sign request JWT with did signing keypair %% Update the request V-->>+API: PUT /oidc/presentations/requests/{id} API-->-V: 201 OK and presentation request object
(signed request jwt) V->>W: Show Presentation request as a QR-code or DL W->>W: Scan QR-code, or
open DL W->>API: GET /oidc/presentations/requests/{id}/JWT (public endpoint) API-->>W: 200 OK opt verifiy request signature W->>API: verify OIDC presentation request API-->>W: 200 OK end W->>W: Select credentials %% Build verifiable presentation W->>V: POST /presentations/generate [VC] V-->>W: return unsigned verifiable presentation (VP) W->>W: Sign VP %% Generate id_token for request submission based on the Wallet information and the verifiable presentation token W->>API: POST /oidc/presentations/token API-->>W: 201 OK and unsigned id_token W->>W: Sign id_token %% Submit VP token to the redirect_uri W->>+V: POST "presentation_request.redirect_uri" %% Validate VP token and its content V->>API: POST /oidc/presentations/response/verify API->>API: Verify SIOP token signature and
extract the verifiable presentation API->>API: Verify verifiable presentation structure, signatures and
if data provided match presentation definition API-->>V: 204 OK / 201 OK and parsed token information alt Verify presentation Note right of V: This endpoint will check everything
(signatures, structure, status list information)
and might be an expensive call. V->>API: POST /presentations/verify API-->>V: 204 OK end V-->>W: 201 Submission is valid ``` --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter: ``` GET https://docs.meeco.me/svx-v3/guides/api-guides/openid-connect/oidc4vp.md?ask= ``` The question should be specific, self-contained, and written in natural language. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.