Templates

OpenAPI documentation for the "Templates" module

Retrieve the templates the verifier is working with

get

Returns a collection of templates that the client can use and send to the verifier endpoints.Claim-based access control: Verifier_Admin, Verifier_Auditor, Verifier_User

Authorizations

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '../private/webapp/templates' \
  --header 'Authorization: Bearer JWT'

200

401

403

503

200

[
  {
    "definitionName": "Work Experience Credential",
    "definitionId": "workExperienceCredential",
    "definition": {
      "id": "6a1b440-f15a-4464-a9fc-47669eabe9f0",
      "name": "Work Experience Credential",
      "purpose": "Provide Work Experience Credential",
      "schema": [
        {
          "uri": "WorkExperienceCredential"
        }
      ]
    }
  }
]

Create a new dynamic presentation definition

post

Enables the use of dynamic presentation definitions. The presentation definition is a JSON object that defines the rules the clients need to follow in order to produce a valid verifiable presentation.Claim-based access control: Verifier_Admin, Verifier_User

Authorizations

Body

definitionNamestringrequired

Example: documentSignature

credentialsobject[]required

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '../private/webapp/presentation-definitions' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{
    "definitionName": "documentSignature",
    "credentials": [
      {
        "credentialId": "emailCredential",
        "fields": {
          "email": "[e-mail]"
        }
      }
    ]
  }'

200

401

403

503

200

{
  "definitionId": "emailCredential"
}

Returns a list of presentation definition templates and their required fields.

get

Returns a list of presentation definition templates and their required fields. The templates are used when creating a new presentation definition and checked against the required fields to ensure that the presentation definition is valid.Claim-based access control: Verifier_Admin, Verifier_User

Authorizations

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '../private/webapp/presentation-definitions/templates' \
  --header 'Authorization: Bearer JWT'

200

401

403

503

200

{
  "templates": [
    {
      "definitionName": "documentSignature",
      "credentials": [
        {
          "credentialId": "string",
          "fields": {
            "type": "object",
            "properties": {
              "email": {
                "type": "string"
              }
            },
            "required": [
              "email"
            ]
          }
        }
      ]
    }
  ]
}