VP Query

get

Retrieves all VP query configurations.

Authorizations
Responses
200
Found
application/json
get
GET /v1/verifier/vp-queries HTTP/1.1
Host: api
x-client-secret: YOUR_API_KEY
Accept: */*
[
  {
    "id": "text",
    "queryBody": [
      {
        "fields": [
          {
            "filter": "[Circular Reference]",
            "path": [
              "text"
            ]
          }
        ]
      }
    ],
    "createdAt": 1
  }
]
post

Creates a new VP query configuration.

Authorizations
Body
  • Contains the query parameters for verifiable presentation verification The query property should contain an array of VP query configurations that define what credentials and claims are required for successful verification.
Responses
201
Created
application/json
post
POST /v1/verifier/vp-queries HTTP/1.1
Host: api
x-client-secret: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 1208

{
  "query": [
    {
      "fields": [
        {
          "filter": {
            "$id": "text",
            "$ref": "text",
            "$schema": "text",
            "$comment": "text",
            "$defs": "[Circular Reference]",
            "type": "string",
            "enum": "[Circular Reference]",
            "const": "[Circular Reference]",
            "multipleOf": 1,
            "maximum": 1,
            "exclusiveMaximum": 1,
            "minimum": 1,
            "exclusiveMinimum": 1,
            "maxLength": 1,
            "minLength": 1,
            "pattern": "text",
            "items": "[Circular Reference]",
            "additionalItems": "[Circular Reference]",
            "maxItems": 1,
            "minItems": 1,
            "uniqueItems": true,
            "contains": "[Circular Reference]",
            "maxProperties": 1,
            "minProperties": 1,
            "required": [
              "text"
            ],
            "properties": "[Circular Reference]",
            "patternProperties": "[Circular Reference]",
            "additionalProperties": "[Circular Reference]",
            "dependencies": "[Circular Reference]",
            "propertyNames": "[Circular Reference]",
            "if": "[Circular Reference]",
            "then": "[Circular Reference]",
            "else": "[Circular Reference]",
            "allOf": "[Circular Reference]",
            "anyOf": "[Circular Reference]",
            "oneOf": "[Circular Reference]",
            "not": "[Circular Reference]",
            "format": "text",
            "contentMediaType": "text",
            "contentEncoding": "text",
            "definitions": "[Circular Reference]",
            "title": "text",
            "description": "text",
            "default": "[Circular Reference]",
            "readOnly": true,
            "writeOnly": true,
            "examples": "[Circular Reference]"
          },
          "path": [
            "text"
          ]
        }
      ]
    }
  ]
}
{
  "id": "text",
  "queryBody": [
    {
      "fields": [
        {
          "filter": {
            "$id": "text",
            "$ref": "text",
            "$schema": "text",
            "$comment": "text",
            "$defs": "[Circular Reference]",
            "type": "string",
            "enum": "[Circular Reference]",
            "const": "[Circular Reference]",
            "multipleOf": 1,
            "maximum": 1,
            "exclusiveMaximum": 1,
            "minimum": 1,
            "exclusiveMinimum": 1,
            "maxLength": 1,
            "minLength": 1,
            "pattern": "text",
            "items": "[Circular Reference]",
            "additionalItems": "[Circular Reference]",
            "maxItems": 1,
            "minItems": 1,
            "uniqueItems": true,
            "contains": "[Circular Reference]",
            "maxProperties": 1,
            "minProperties": 1,
            "required": [
              "text"
            ],
            "properties": "[Circular Reference]",
            "patternProperties": "[Circular Reference]",
            "additionalProperties": "[Circular Reference]",
            "dependencies": "[Circular Reference]",
            "propertyNames": "[Circular Reference]",
            "if": "[Circular Reference]",
            "then": "[Circular Reference]",
            "else": "[Circular Reference]",
            "allOf": "[Circular Reference]",
            "anyOf": "[Circular Reference]",
            "oneOf": "[Circular Reference]",
            "not": "[Circular Reference]",
            "format": "text",
            "contentMediaType": "text",
            "contentEncoding": "text",
            "definitions": "[Circular Reference]",
            "title": "text",
            "description": "text",
            "default": "[Circular Reference]",
            "readOnly": true,
            "writeOnly": true,
            "examples": "[Circular Reference]"
          },
          "path": [
            "text"
          ]
        }
      ]
    }
  ],
  "createdAt": 1
}
get

Retrieves a VP query configuration by its ID.

Authorizations
Path parameters
idstringRequired
Responses
200
Found
application/json
get
GET /v1/verifier/vp-queries/{id} HTTP/1.1
Host: api
x-client-secret: YOUR_API_KEY
Accept: */*
{
  "id": "text",
  "queryBody": [
    {
      "fields": [
        {
          "filter": {
            "$id": "text",
            "$ref": "text",
            "$schema": "text",
            "$comment": "text",
            "$defs": "[Circular Reference]",
            "type": "string",
            "enum": "[Circular Reference]",
            "const": "[Circular Reference]",
            "multipleOf": 1,
            "maximum": 1,
            "exclusiveMaximum": 1,
            "minimum": 1,
            "exclusiveMinimum": 1,
            "maxLength": 1,
            "minLength": 1,
            "pattern": "text",
            "items": "[Circular Reference]",
            "additionalItems": "[Circular Reference]",
            "maxItems": 1,
            "minItems": 1,
            "uniqueItems": true,
            "contains": "[Circular Reference]",
            "maxProperties": 1,
            "minProperties": 1,
            "required": [
              "text"
            ],
            "properties": "[Circular Reference]",
            "patternProperties": "[Circular Reference]",
            "additionalProperties": "[Circular Reference]",
            "dependencies": "[Circular Reference]",
            "propertyNames": "[Circular Reference]",
            "if": "[Circular Reference]",
            "then": "[Circular Reference]",
            "else": "[Circular Reference]",
            "allOf": "[Circular Reference]",
            "anyOf": "[Circular Reference]",
            "oneOf": "[Circular Reference]",
            "not": "[Circular Reference]",
            "format": "text",
            "contentMediaType": "text",
            "contentEncoding": "text",
            "definitions": "[Circular Reference]",
            "title": "text",
            "description": "text",
            "default": "[Circular Reference]",
            "readOnly": true,
            "writeOnly": true,
            "examples": "[Circular Reference]"
          },
          "path": [
            "text"
          ]
        }
      ]
    }
  ],
  "createdAt": 1
}
delete

Deletes a VP query configuration by its ID.

Authorizations
Path parameters
idstringRequired
  • The UUID of the VP query configuration to delete
Responses
204
No Content
delete
DELETE /v1/verifier/vp-queries/{id} HTTP/1.1
Host: api
x-client-secret: YOUR_API_KEY
Accept: */*

No content

post

Handles the creation of an authorization request using a VP Query. Retrieves the presentation definition from the specified VP query and creates an authorization request.

Authorizations
Path parameters
idstringRequired
Body

Request body for creating an authorization request using a VP query

redirect_uristringRequired

Redirect URI to which the response will be sent

Example: http://example.com
validitynumber · doubleOptional

Validity of the authorization request in seconds

Example: 600
Responses
201
Created
application/json
post
POST /v1/verifier/vp-queries/{id}/authorization-request HTTP/1.1
Host: api
x-client-secret: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 52

{
  "redirect_uri": "http://example.com",
  "validity": 600
}
{
  "request_uri": "http://127.0.0.1:9004/api/v1/verifier/authorization-request/a0b2e682-d92f-4767-a83a-d60d196da792",
  "qr_code_url": "http://127.0.0.1:9004/api/v1/verifier/qr-code/a0b2e682-d92f-4767-a83a-d60d196da792",
  "state": "abcdef12345678901234567890abcdef",
  "nonce": "1234567890abcdef1234567890abcdef",
  "validity": 600
}