SWswiyu
Verfifier OID4VP API

Get Request Object

Changed on

Can return a RequestObjectDto as JSON Object or a SignedJWT String depending on JAR (JWT secured authorization request) flag in verifier management

get/oid4vp/api/request-object/{request_id}

Request

  • Base URL
    https://astra-vz-verifier-service-d.apps.p-szb-ros-shrd-npr-01.cloud.admin.ch
  • Auth
    none declared

Path parameters

request_idstring uuid required

Response

Request object either as plaintext or signed JWT

client_idstring
client_id_schemestring
response_typestring
response_mode'direct_post' | 'direct_post.jwt'

Supported response_mode as defined in OID4VP

response_uristring
noncestring
versionstring
statestring

Example response

{
  "presentation_definition": {
    "id": "00000000-0000-0000-0000-000000000000",
    "name": "Test Verification",
    "purpose": "We want to test a new Verifier",
    "format": {
      "vc+sd-jwt": {
        "sd-jwt_alg_values": [
          "ES256"
        ],
        "kb-jwt_alg_values": [
          "ES256"
        ]
      }
    },
    "input_descriptors": [
      {
        "id": "11111111-1111-1111-1111-111111111111",
        "name": "Example Data Request",
        "purpose": "We collect this data to test our verifier",
        "format": {
          "vc+sd-jwt": {
            "sd-jwt_alg_values": [
              "ES256"
            ],
            "kb-jwt_alg_values": [
              "ES256"
            ]
          }
        },
        "constraints": {
          "fields": [
            {
              "path": [
                "$.vct"
              ],
              "filter": {
                "type": "string",
                "const": "test-sdjwt"
              }
            },
            {
              "path": [
                "$.dateOfBirth"
              ]
            }
          ]
        }
      }
    ]
  },
  "dcql_query": {
    "credentials": [
      {
        "id": "identity_credential_dcql",
        "format": "dc+sd-jwt",
        "meta": {
          "vct_values": [
            "https://credentials.example.com/identity_credential"
          ]
        },
        "claims": [
          {
            "path": [
              "given_name"
            ]
          },
          {
            "path": [
              "family_name"
            ]
          },
          {
            "path": [
              "address",
              "street_address"
            ]
          }
        ],
        "require_cryptographic_holder_binding": true
      },
      {
        "id": "university_degree_dcql",
        "format": "dc+sd-jwt",
        "meta": {
          "vct_values": [
            "https://credentials.example.com/university_degree"
          ]
        },
        "claims": [
          {
            "path": [
              "degree_name"
            ]
          },
          {
            "path": [
              "graduation_year"
            ]
          }
        ]
      }
    ],
    "credential_sets": [
      {
        "options": [
          [
            "identity_credential_dcql"
          ],
          [
            "university_degree_dcql"
          ]
        ],
        "required": true
      }
    ]
  }
}

Changes

  • 07f55530c3bcRevision changes
    • warning

      removed the optional property / from the response with the status (media type: application/oauth-authz-req+jwt)

    • warning

      removed the optional property / from the response with the status (media type: application/json)

  • 09f9d38e5544Revision changes
    • breaking

      the response property became optional for the status (media type: application/oauth-authz-req+jwt)

    • breaking

      the response property became optional for the status (media type: application/json)

    • breaking

      the // response's property type changed from object to no type for status (media type: application/oauth-authz-req+jwt)

    • breaking

      the // response's property type changed from object to no type for status (media type: application/json)

    • warning

      removed the optional property from the response with the status (media type: application/oauth-authz-req+jwt)

    • warning

      removed the optional property from the response with the status (media type: application/json)

    • warning

      added the new direct_post enum value to the response property for the response status (media type: application/oauth-authz-req+jwt)

    • warning

      added the new direct_post enum value to the response property for the response status (media type: application/json)

    • warning

      added the new direct_post.jwt enum value to the response property for the response status (media type: application/oauth-authz-req+jwt)

    • warning

      added the new direct_post.jwt enum value to the response property for the response status (media type: application/json)

    • info

      added the optional property / to the response with the status (media type: application/oauth-authz-req+jwt)

    • info

      added the optional property / to the response with the status (media type: application/json)

    • info

      added the optional property / to the response with the status (media type: application/oauth-authz-req+jwt)

    • info

      added the optional property / to the response with the status (media type: application/json)

    • info

      added the optional property / to the response with the status (media type: application/oauth-authz-req+jwt)

    • info

      added the optional property / to the response with the status (media type: application/json)

    • info

      added the optional property to the response with the status (media type: application/oauth-authz-req+jwt)

    • info

      added the optional property to the response with the status (media type: application/json)

    • info

      added the optional property to the response with the status (media type: application/oauth-authz-req+jwt)

    • info

      added the optional property to the response with the status (media type: application/json)

    • info

      response property client_metadata/vp_formats deprecated (media type: application/oauth-authz-req+jwt)

    • info

      response property client_metadata/vp_formats deprecated (media type: application/json)

    • info

      removed the invalid_credential enum value from the response property for the response status (media type: application/oauth-authz-req+jwt)

    • info

      removed the invalid_credential enum value from the response property for the response status (media type: application/json)

    • info

      removed the invalid_request enum value from the response property for the response status (media type: application/oauth-authz-req+jwt)

    • info

      removed the invalid_request enum value from the response property for the response status (media type: application/json)

    • info

      removed the server_error enum value from the response property for the response status (media type: application/oauth-authz-req+jwt)

    • info

      removed the server_error enum value from the response property for the response status (media type: application/json)