--- title: "Get Request Object" method: GET path: "/oid4vp/api/request-object/{request_id}" tags: ["Verfifier OID4VP API"] --- # Get Request Object `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` - URL: `https://astra-vz-verifier-service-d.apps.p-szb-ros-shrd-npr-01.cloud.admin.ch/oid4vp/api/request-object/{request_id}` - Auth: none declared Can return a RequestObjectDto as JSON Object or a SignedJWT String depending on JAR (JWT secured authorization request) flag in verifier management ## Path parameters - `request_id` string, uuid, required ## Response `200` Request object either as plaintext or signed JWT - RequestObject: OID4VP Request Object sent to the Wallet as response after receiving an Authorization Request. Contains either a Presentation Exchange (PE) presentation_definition or a DCQL query (dcql_query), depending on the verification request format. - If the verification was initiated using the older PE format, the presentation_definition field is used. - If the verification was initiated using the new DCQL format, the dcql_query field is used. - `client_id` string - `client_id_scheme` string - `response_type` string - `response_mode` 'direct_post' | 'direct_post.jwt': Supported response_mode as defined in OID4VP - `response_uri` string - `nonce` string - `version` string - `presentation_definition` PresentationDefinition - `id` string: A unique ID for the desired context. Can be any String, but using a UUID is recommended. - `name` string: (Optional) If present human-friendly string intended to constitute a distinctive designation of the Presentation Definition - `purpose` string: (Optional) Purpose for which the presentation definition is requested and used for - `format` object: (Optional) If present object with one or more properties matching the registered Claim Format. - `input_descriptors` InputDescriptor[], required: Input Descriptors are objects used to describe the information a Verifier requires of a Holder - `id` string, required: (Mandatory) unique string with no conflict with another id in the Presentation Definition - `name` string: (Optional) If present human-friendly name which describes the target field - `purpose` string: (Optional) Purpose for which the data is requested - `format` object: (Optional) If present object with one or more properties matching the registered Claim Format - `constraints` Constraint, required - `id` string: (Optional) unique string with no conflict with another id in the Presentation Definition - `name` string: (Optional) If present human-friendly name which describes the target field - `purpose` string: (Optional) Purpose for which the data is requested - `format` object: (Optional) If present object with one or more properties matching the registered Claim Format - `fields` Field[], required: Selection which properties are requested of the holder - `path` string[], required: (Mandatory) Array of one or more JSONPath string expressions - `id` string: (Optional) If present value MUST be a string that is unique - `name` string: (Optional) If present human-friendly name which describes the target field - `purpose` string: (Optional) If present describes purpose for which the field is requested - `filter` Filter - `type` string: (Optional) If present value MUST be 'string' - `const` string: (Optional) If present value MUST be a string / no pattern - `dcql_query` DcqlQueryDto: Represents the Digital Credentials Query Language (DCQL) query according to https://openid.net/specs/openid-4-verifiable-presentations-1_0.html#section-6 **⚠️ Not yet implemented** - `credentials` DcqlCredentialDto[], required: A non-empty array of Credential Queries that specify the requested Credentials. According to OpenID for Verifiable Presentations 1.0, Section 6, property 'credentials'. - `id` string, required: A string identifying the Credential in the response and, if provided, the constraints in credential_sets. The value MUST be a non-empty string consisting of alphanumeric, underscore (_) or hyphen (-) characters. Within the Authorization Request, the same id MUST NOT be present more than once. According to OpenID for Verifiable Presentations 1.0, Section 6.1, property 'id'. - `format` string, required: A string that specifies the format of the requested Credential. Valid Credential Format Identifier values are defined in Appendix B. According to OpenID for Verifiable Presentations 1.0, Section 6.1, property 'format'. - `multiple` boolean: A boolean which indicates whether multiple Credentials can be returned for this Credential Query. If omitted, the default value is false. According to OpenID for Verifiable Presentations 1.0, Section 6.1, property 'multiple'. - `meta` DcqlCredentialMetaDto, required: Represents metadata parameters within a Credential Query according to https://openid.net/specs/openid-4-verifiable-presentations-1_0.html#section-6.1 - `type_values` array[]: For W3C Verifiable Credentials: A non-empty array of arrays of strings that specifies allowed values for the 'type' of the requested Verifiable Credential. According to OpenID for Verifiable Presentations 1.0, Appendix B.1.1, property 'type_values'. - string[] - `vct_values` string[]: For IETF SD-JWT VC: A non-empty array of strings that specifies allowed values for the type of the requested Verifiable Credential. According to OpenID for Verifiable Presentations 1.0, Appendix B.3.5, property 'vct_values'. - `doctype_value` string: For ISO mdoc: A string that specifies an allowed value for the 'doctype' of the requested Verifiable Credential. It MUST be a valid doctype identifier. According to OpenID for Verifiable Presentations 1.0, Appendix B.2.3, property 'doctype_value'. - `claims` DcqlClaimDto[]: An optional non-empty array of Claims Query objects, specifying individual claims. According to OpenID for Verifiable Presentations 1.0, Section 6.1, property 'claims'. - `id` string: REQUIRED if claim_sets is present in the Credential Query; OPTIONAL otherwise. A string identifying the particular claim. The value MUST be a non-empty string consisting of alphanumeric, underscore (_), or hyphen (-) characters. Within the particular claims array, the same id MUST NOT be present more than once. - `path` unknown[], required: The path to the claim within the credential. According to OpenID for Verifiable Presentations 1.0, Section 6.3, property 'path'.https://openid.net/specs/openid-4-verifiable-presentations-1_0.html#claims_path_pointer - unknown - `values` unknown[]: OPTIONAL. A non-empty array of strings, integers or boolean values that specifies the expected values of the claim. If the values property is present, the Wallet SHOULD return the claim only if the type and value of the claim both match exactly for at least one of the elements in the array. Details of the processing rules are defined in Section 6.4.1. - unknown - `claim_sets` array[]: An optional non-empty array containing arrays of identifiers for elements in claims that specifies which combinations of claims for the Credential are requested. According to OpenID for Verifiable Presentations 1.0, Section 6.1, property 'claim_sets'. - string[] - `require_cryptographic_holder_binding` boolean: A boolean indicating if cryptographic holder binding is required. If true, the Wallet MUST return a Verifiable Presentation of a Verifiable Credential. If false, a Verifiable Credential without Holder Binding MAY be returned. If omitted, the default is to require cryptographic holder binding. According to OpenID for Verifiable Presentations 1.0, Section 6.1, property 'require_cryptographic_holder_binding'. Also referenced in Appendix B.1. See Section 6.1 and Appendix B.1. - `trusted_authorities` DcqlTrustedAuthoritiesDto[]: An optional non-empty array of Trusted Authorities Query objects. According to OpenID for Verifiable Presentations 1.0, Section 6.1, property 'trusted_authorities'. - `type` string, required: A string uniquely identifying the type of information about the issuer trust framework. According to OpenID for Verifiable Presentations 1.0, Section 6.1.1, property 'type'. - `values` string[], required: A non-empty array of strings, where each string (value) contains information specific to the used Trusted Authorities Query type that allows the identification of an issuer, a trust framework, or a federation that an issuer belongs to. According to OpenID for Verifiable Presentations 1.0, Section 6.1.1, property 'values'. - `credential_sets` DcqlCredentialSetDto[]: An optional non-empty array of Credential Set Queries that specifies additional constraints on which of the requested Credentials to return. According to OpenID for Verifiable Presentations 1.0, Section 6, property 'credential_sets'. - `options` array[], required: A non-empty array, where each value in the array is a list of Credential Query identifiers representing one set of Credentials that satisfies the use case. According to OpenID for Verifiable Presentations 1.0, 6.2 Credential Set Query, property 'options'. - string[] - `required` boolean: A boolean indicating if this credential set is required. (default is true)According to OpenID for Verifiable Presentations 1.0, 6.2. Credential Set Query, property 'required'. - `client_metadata` OpenidClientMetadataDto: Verifier metadata values. Additional Verifier metadata parameters MAY be defined and used, as described in [RFC7591]. The Wallet MUST ignore any unrecognized parameters. - `additionalProperties` object - `client_id` string, required - `vp_formats` OpenIdClientMetadataVpFormat, required - `jwt_vp` OpenIdClientMetadataVpFormatAlg, required - `alg` string[], required - `jwks` JWKSet - `keys` JsonWebKey[] - `kty` string - `kid` string - `use` string - `alg` string - `n` string - `e` string - `crv` string - `x` string - `y` string - `encrypted_response_enc_values_supported` string[]: If present, should be non-empty array of JWE algorithms as in RFC7516. When a response_mode requiring encryption of the Response (such as direct_post.jwt) is specified, one of the specified algorithms is to be used. - `vp_formats_supported` OpenIdClientMetadataVpFormatsSupported - `dc+sd-jwt` OpenIdClientMetadataVpFormatSdJwt - `sd-jwt_alg_values` string[] - `kb-jwt_alg_values` string[] - `state` string ## Other responses - `400`: Bad Request - `404`: Request Object not found ## Changes - **2026-04-17** `07f55530c3bc`: 2 warning - removed the optional property `client_metadata/version` from the response with the `200` status (media type: application/oauth-authz-req+jwt) - removed the optional property `client_metadata/version` from the response with the `200` status (media type: application/json) - **2026-04-17** `09f9d38e5544`: 4 breaking, 6 warning, 18 info - the response property `error` became optional for the status `404` (media type: application/oauth-authz-req+jwt) - the response property `error` became optional for the status `404` (media type: application/json) - the `client_metadata/additionalProperties/additionalProperties/` response's property type changed from `object` to no type for status `200` (media type: application/oauth-authz-req+jwt) - the `client_metadata/additionalProperties/additionalProperties/` response's property type changed from `object` to no type for status `200` (media type: application/json) - …24 more [Operation history](https://skmtc.dev/swiyu/apis/verifier-api-2/changes/oid4vp/api/request-object/:request_id/get.md) --- [API](https://skmtc.dev/swiyu/apis/verifier-api-2.md) - [All operations](https://skmtc.dev/swiyu/apis/verifier-api-2/llms.txt) - [OpenAPI document](https://skmtc.dev/swiyu/apis/verifier-api-2/revisions/07f55530c3bc?raw)