Create an OpenID4VP authorization request.

POST

/vp/authorize

Code sample: Shell / cURL

curl --request POST \
  --url https://auth.example.com/vp/authorize \
  --header 'Content-Type: application/json' \
  --data '{ "client_id": "client_123", "client_id_scheme": "pre-registered", "presentation_definition": { "id": "pd_identity", "input_descriptors": [] }, "state": "state_123" }'

Request Body ^required

Media type application/json

object

tenant_id

string

Example

tenant_123

client_id

required

string

Example

client_123

client_id_scheme

string

Allowed values: pre-registered redirect_uri entity_id did x509_san_dns x509_san_uri

Example

pre-registered

presentation_definition_id

string

Example

identity-v1

presentation_definition

Presentation Exchange definition requested from the wallet.

object

dcql_query

Digital Credentials Query Language query.

object

response_uri

string format: uri

Example

https://auth.example.com/vp/response

state

string

Example

state_123

user_id

string

Example

user_123

Example

{
  "client_id": "client_123",
  "client_id_scheme": "pre-registered",
  "presentation_definition": {
    "id": "pd_identity",
    "input_descriptors": []
  },
  "state": "state_123"
}

Responses

200

Created OpenID4VP authorization request.

Media type application/json

object

request_id

required

string

request_uri

required

string format: uri

nonce

required

string

expires_in

required

integer

authorization_request

required

object

response_type

required

string

client_id

required

string

client_id_scheme

required

string

response_mode

required

string

response_uri

required

string format: uri

nonce

required

string

state

string

presentation_definition

object

dcql_query

object

Example

{
  "request_id": "g1:apac:3:vp_550e8400-e29b-41d4-a716-446655440000",
  "request_uri": "https://auth.example.com/vp/request/g1:apac:3:vp_550e8400-e29b-41d4-a716-446655440000",
  "nonce": "nonce_123",
  "expires_in": 300,
  "authorization_request": {
    "response_type": "vp_token",
    "client_id": "client_123",
    "client_id_scheme": "pre-registered",
    "response_mode": "direct_post",
    "response_uri": "https://auth.example.com/vp/response",
    "nonce": "nonce_123",
    "state": "state_123"
  }
}

400

Error response.

Media type application/json

object

error

required

string

error_description

required

string

Example

{
  "error": "invalid_request",
  "error_description": "The request is invalid."
}

500

Error response.

Media type application/json

object

error

required

string

error_description

required

string

Example

{
  "error": "invalid_request",
  "error_description": "The request is invalid."
}