List presentation definition templates

GET 
/v2/config/digital-wallet/openid/sdjwt/presentation-definition/templates

Lists the presentation definition templates of the platform schema repository. Use a template as the starting point for a new presentation definition.

The server returns one entry for each template, with the newest version only. The list holds the DCQL query templates and also older templates that the verifier no longer accepts. Read metadata.isDcqlQuery to tell them apart.

This endpoint always answers with HTTP 200. When the server cannot read the schema repository, it returns an empty templates array and no pagination object.

The pagination object of this endpoint is not the standard pagination object. It holds offset, limit, totalItems, hasPrevious and hasNext.

Read metadata.isDcqlQuery of a format entry to see which templates you can use. Only a template with isDcqlQuery set to true gives a DCQL query for the dcqlQuery of a presentation definition.

Request

Query Parameters

offset integerrequired

Default value: 0

Number of records to skip for pagination. A negative or unreadable value falls back to 0.

limit integerrequired

Default value: 10

Maximum number of records to return per page.

Responses

200

The server listed the presentation definition templates.

Response Headers

application/json

Schema

Schema

templates object[]required
Presentation definition templates for the current page. The array is empty when the server cannot read the schema repository.
Array [
name stringrequired
Identifier of the template in the schema repository.
version stringrequired
Semantic version of the template. The server returns the newest version that the repository holds.
dc+sd-jwt object
Template for the IETF SD-JWT VC credential format.
schema object
Credential query for this credential format. Use it as the dcqlQuery of a new presentation definition when metadata.isDcqlQuery is true. The value is null when the schema repository has no file for this format.
property name* any
Credential query for this credential format. Use it as the dcqlQuery of a new presentation definition when metadata.isDcqlQuery is true. The value is null when the schema repository has no file for this format.
metadata object
Descriptive metadata of the template for this credential format.
id string
Identifier of the template in the schema repository.
credentialType string
Credential type that this template asks for. Use it as the vct_values, the type_values or the doctype_value of the credential query.
name string
Human-readable name of the credential type.
purpose string
Human-readable purpose of the template. The dashboard shows this text in the template list.
isDcqlQuery boolean
true when the schema of this format entry is a DCQL query. Use only a template with true here for the dcqlQuery of a presentation definition.
isScaCredential boolean
true when the template asks for a Strong Customer Authentication (SCA) attestation. The server then writes the address of the platform in credentialType.
jwt_vc_json object
Template for the W3C VC JWT credential format.
schema object
Credential query for this credential format. The value is null when the schema repository has no file for this format.
property name* any
Credential query for this credential format. The value is null when the schema repository has no file for this format.
metadata object
Descriptive metadata of the template for this credential format.
id string
Identifier of the template in the schema repository.
credentialType string
Credential type that this template asks for. Use it as the vct_values, the type_values or the doctype_value of the credential query.
name string
Human-readable name of the credential type.
purpose string
Human-readable purpose of the template. The dashboard shows this text in the template list.
isDcqlQuery boolean
true when the schema of this format entry is a DCQL query. Use only a template with true here for the dcqlQuery of a presentation definition.
isScaCredential boolean
true when the template asks for a Strong Customer Authentication (SCA) attestation. The server then writes the address of the platform in credentialType.
mso_mdoc object
Template for the ISO 18013-5 mDoc credential format.
schema object
Credential query for this credential format. The value is null when the schema repository has no file for this format.
property name* any
Credential query for this credential format. The value is null when the schema repository has no file for this format.
metadata object
Descriptive metadata of the template for this credential format.
id string
Identifier of the template in the schema repository.
credentialType string
Credential type that this template asks for. Use it as the vct_values, the type_values or the doctype_value of the credential query.
name string
Human-readable name of the credential type.
purpose string
Human-readable purpose of the template. The dashboard shows this text in the template list.
isDcqlQuery boolean
true when the schema of this format entry is a DCQL query. Use only a template with true here for the dcqlQuery of a presentation definition.
isScaCredential boolean
true when the template asks for a Strong Customer Authentication (SCA) attestation. The server then writes the address of the platform in credentialType.
mso_mdoc_v1 object
Template for the version 1 variant of the ISO 18013-5 mDoc credential format. The server returns this property only for DCQL query templates.
schema object
DCQL query for this credential format. The value is null when the schema repository has no file for this format.
property name* any
DCQL query for this credential format. The value is null when the schema repository has no file for this format.
metadata object
Descriptive metadata of the template for this credential format.
id string
Identifier of the template in the schema repository.
credentialType string
Credential type that this template asks for. Use it as the vct_values, the type_values or the doctype_value of the credential query.
name string
Human-readable name of the credential type.
purpose string
Human-readable purpose of the template. The dashboard shows this text in the template list.
isDcqlQuery boolean
true when the schema of this format entry is a DCQL query. Use only a template with true here for the dcqlQuery of a presentation definition.
isScaCredential boolean
true when the template asks for a Strong Customer Authentication (SCA) attestation. The server then writes the address of the platform in credentialType.
]
pagination object

Page information for this list. The server leaves this property out when it cannot read the schema repository.

offset integerrequired

Number of templates that the server skipped. The default is 0. The server clamps a value that is larger than totalItems.

limit integerrequired

Maximum number of templates on one page. The default is 10.

totalItems integerrequired

Number of templates in the schema repository.

hasPrevious booleanrequired

true when offset is larger than 0.

hasNext booleanrequired

true when more templates follow this page.

Example (from schema)

{
  "templates": [
    {
      "name": "LegalPersonIdentificationData",
      "version": "1.0.0",
      "dc+sd-jwt": {
        "schema": {},
        "metadata": {
          "id": "WgWxqztrNooG92RXvxSTWv",
          "credentialType": "LegalPersonIdentificationData",
          "name": "Legal Person Identification Data (LPID)",
          "purpose": "string",
          "isDcqlQuery": true,
          "isScaCredential": false
        }
      },
      "jwt_vc_json": {
        "schema": {},
        "metadata": {
          "id": "WgWxqztrNooG92RXvxSTWv",
          "credentialType": "LegalPersonIdentificationData",
          "name": "Legal Person Identification Data (LPID)",
          "purpose": "string",
          "isDcqlQuery": true,
          "isScaCredential": false
        }
      },
      "mso_mdoc": {
        "schema": {},
        "metadata": {
          "id": "WgWxqztrNooG92RXvxSTWv",
          "credentialType": "LegalPersonIdentificationData",
          "name": "Legal Person Identification Data (LPID)",
          "purpose": "string",
          "isDcqlQuery": true,
          "isScaCredential": false
        }
      },
      "mso_mdoc_v1": {
        "schema": {},
        "metadata": {
          "id": "WgWxqztrNooG92RXvxSTWv",
          "credentialType": "LegalPersonIdentificationData",
          "name": "Legal Person Identification Data (LPID)",
          "purpose": "string",
          "isDcqlQuery": true,
          "isScaCredential": false
        }
      }
    }
  ],
  "pagination": {
    "offset": 0,
    "limit": 10,
    "totalItems": 24,
    "hasPrevious": false,
    "hasNext": true
  }
}

401

Unauthorized

Response Headers

application/json

Schema

Schema

errorCode integerrequired
errorDescription stringrequired

Example (from schema)

{
  "errorCode": 400,
  "errorDescription": "Bad input parameter"
}

500

Internal server error

Response Headers

application/json

Schema

Schema

errorCode integerrequired
errorDescription stringrequired

Example (from schema)

{
  "errorCode": 400,
  "errorDescription": "Bad input parameter"
}

Loading...