VP Query

get

Retrieves all VP query configurations.

Authorizations

x-client-secretstringRequired

Responses

200

Found

application/json

Entity representing a Verifiable Presentation (VP) query configuration.

VP queries define what credentials a verifier is requesting from a user. These configurations can be reused across multiple authorization requests, allowing for standardized verification processes.

idstringRequired

Unique identifier for the VP query configuration. Automatically generated as a UUID.

createdAtnumber · doubleOptional

Timestamp when this VP query configuration was created. Stored as a bigint representing milliseconds since the Unix epoch.

400

Bad Request

application/json

get/api/v1/verifier/vp-queries

GET /api/v1/verifier/vp-queries HTTP/1.1
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

x-client-secretstringRequired

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

Entity representing a Verifiable Presentation (VP) query configuration.

VP queries define what credentials a verifier is requesting from a user. These configurations can be reused across multiple authorization requests, allowing for standardized verification processes.

idstringRequired

Unique identifier for the VP query configuration. Automatically generated as a UUID.

createdAtnumber · doubleOptional

Timestamp when this VP query configuration was created. Stored as a bigint representing milliseconds since the Unix epoch.

400

Bad Request

application/json

post/api/v1/verifier/vp-queries

POST /api/v1/verifier/vp-queries HTTP/1.1
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

x-client-secretstringRequired

Path parameters

idstringRequired

Responses

200

Found

application/json

Entity representing a Verifiable Presentation (VP) query configuration.

VP queries define what credentials a verifier is requesting from a user. These configurations can be reused across multiple authorization requests, allowing for standardized verification processes.

idstringRequired

Unique identifier for the VP query configuration. Automatically generated as a UUID.

createdAtnumber · doubleOptional

Timestamp when this VP query configuration was created. Stored as a bigint representing milliseconds since the Unix epoch.

400

Bad Request

application/json

404

Not Found

get/api/v1/verifier/vp-queries/{id}

GET /api/v1/verifier/vp-queries/{id} HTTP/1.1
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

x-client-secretstringRequired

Path parameters

idstringRequired

The UUID of the VP query configuration to delete

Responses

204

No Content

No content

400

Bad Request

application/json

delete/api/v1/verifier/vp-queries/{id}

DELETE /api/v1/verifier/vp-queries/{id} HTTP/1.1
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

x-client-secretstringRequired

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

Response for a successful authorization request creation

request_uristringRequired

Request URI that can be used to create a QR code

Example: http://127.0.0.1:9004/api/v1/verifier/authorization-request/a0b2e682-d92f-4767-a83a-d60d196da792

qr_code_urlstringRequired

URL of the QR code that can be scanned by wallets

Example: http://127.0.0.1:9004/api/v1/verifier/qr-code/a0b2e682-d92f-4767-a83a-d60d196da792

statestringRequired

Random string to prevent CSRF attacks

Example: abcdef12345678901234567890abcdef

noncestringRequired

Random string to ensure request uniqueness

Example: 1234567890abcdef1234567890abcdef

validitynumber · doubleRequired

Validity of the authorization request in seconds

Example: 600

400

Bad Request

application/json

post/api/v1/verifier/vp-queries/{id}/authorization-request

POST /api/v1/verifier/vp-queries/{id}/authorization-request HTTP/1.1
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
}

PreviousVerify Credential

NextQR Code

Last updated 1 year ago