SWswiyu
Verfifier OID4VP API

Receive Verification Presentation (from e.g. Wallet)

Changed on

Handles various types of verification presentations including standard presentations, rejections, DCQL presentations, and encrypted DCQL presentations. The method automatically determines the request type based on the provided parameters.

post/oid4vp/api/request-object/{request_id}/response-data

Request

  • Base URL
    http://localhost:8080
  • Auth
    none declared

Path parameters

request_idstring uuid required

The unique identifier of the verification request

Headers

SWIYU-API-Version'2'

Optional API version. Supported values: 2 (DEFAULT) - This supports OID4VP 1.0

Request body application/x-www-form-urlencoded

error'invalid_scope' | 'invalid_request' | 'invalid_client' | 'vp_formats_not_supported' | 'invalid_presentation_definition_uri' | 'invalid_presentation_definition_reference' | 'client_rejected' | 'access_denied'

Error code for rejection (used for REJECTION)

error_descriptionstring

Error description for rejection (used for REJECTION)

responsestring

Encrypted response JWE string (used for DCQLE)

statestring

The OAuth State is an opaque value used by the client to maintain state between the request and callback.<br> If provided in the request object the state string <em>MUST</em> be returned in the response.

Example request

{
  "error": "client_rejected",
  "error_description": "The owner has declined the verification request.",
  "response": "eyJhbGciOiJSU0ExXzUiLCJlbmMiOiJBMjU2R0NNIiwidHlwIjoiSldFIn0..."
}

Response

Verification Presentation received and processed successfully

redirect_uristring uri

[EXPERIMENTAL] Optional: Only provided if set in the initial request. It is used to route the response back to the business verifier's endpoint.

Example response

{
  "redirect_uri": "https://shop.ch/callback?session_nonce=123&response_code=xyz"
}

Changes

  • 5f1b8453a957Revision changes
    • info

      removed the non-success response with the status

  • de5537059318Revision changes
    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status