GET 
/authorisation/v4/presentation-definitions

Get presentation definition requirements

Request

Query Parameters

scope string

Possible values: [openid didr_write, openid didr_invite, openid tir_write, openid tir_invite]

OIDC scope

Examples:

didr_write

Write to DID Registry

Example: openid didr_write

didr_invite

Register DID into DID Registry

Example: openid didr_invite

tir_write

Write to TIR Registry

Example: openid tir_write

tir_invite

Register VC into Trusted Issuers Registry

Example: openid tir_invite

Responses

200

Success

application/json

Schema

Schema

id string
name string
purpose string
format object

DIF - Presentation Definition Claim Format Designations

jwt_vc object

alg string[]

Possible values: >= 1

jwt_vp object

alg string[]

Possible values: >= 1

Example (from schema)

{
  "id": "didr_write_credential",
  "name": "Accreditation to write to the DID Registry",
  "purpose": "Please present a valid VerifiableAuthorisationToOnboard issued by Root TAO or TAO",
  "format": {
    "jwt_vc": {
      "alg": [
        "ES256"
      ]
    },
    "jwt_vp": {
      "alg": [
        "ES256"
      ]
    }
  }
}

didr_invite

DIDR invite

{
  "id": "didr_invite_presentation",
  "input_descriptors": [
    {
      "id": "didr_invite_credential",
      "name": "Accreditation to write to the DID Registry",
      "purpose": "Please present a valid VerifiableAuthorisationToOnboard issued by Root TAO or TAO",
      "constraints": {
        "fields": [
          {
            "path": [
              "$.type"
            ],
            "filter": {
              "type": "array",
              "contains": {
                "const": "VerifiableAuthorisationToOnboard"
              }
            }
          }
        ]
      }
    }
  ],
  "format": {
    "jwt_vc": {
      "alg": [
        "ES256"
      ]
    },
    "jwt_vp": {
      "alg": [
        "ES256"
      ]
    }
  }
}

tir_invite

TIR invite

{
  "id": "tir_invite_presentation",
  "input_descriptors": [
    {
      "id": "tir_invite_credential",
      "name": "Accreditation to write to the Trusted Issuers Registry",
      "purpose": "Please present a valid VerifiableAuthorisationForTrustChain from EBSI TO, or a Verifiable Accreditation (VerifiableAccreditationToAttest, VerifiableAccreditationToAccredit) issued by Root TAO or TAO.",
      "constraints": {
        "fields": [
          {
            "path": [
              "$.type"
            ],
            "filter": {
              "type": "array",
              "contains": {
                "anyOf": [
                  {
                    "const": "VerifiableAuthorisationForTrustChain"
                  },
                  {
                    "const": "VerifiableAccreditationToAttest"
                  },
                  {
                    "const": "VerifiableAccreditationToAccredit"
                  }
                ]
              }
            }
          }
        ]
      }
    }
  ],
  "format": {
    "jwt_vc": {
      "alg": [
        "ES256"
      ]
    },
    "jwt_vp": {
      "alg": [
        "ES256"
      ]
    }
  }
}

didr_write

DIDR write

{
  "id": "didr_write_presentation",
  "name": "Any type of Verifiable Attestation",
  "purpose": "Please present a valid Presentation signed by a registered Legal Entity.",
  "input_descriptors": [],
  "format": {
    "jwt_vc": {
      "alg": [
        "ES256"
      ]
    },
    "jwt_vp": {
      "alg": [
        "ES256"
      ]
    }
  }
}

tir_write

TIR write

{
  "id": "tir_write_presentation",
  "name": "Any type of Verifiable Attestation",
  "purpose": "Please present a valid Presentation signed by a Trusted Issuer.",
  "input_descriptors": [],
  "format": {
    "jwt_vc": {
      "alg": [
        "ES256"
      ]
    },
    "jwt_vp": {
      "alg": [
        "ES256"
      ]
    }
  }
}

400

Bad Request

application/problem+json

Schema

Schema

type uri

Default value: about:blank

An absolute URI that identifies the problem type. When dereferenced, it SHOULD provide human-readable documentation for the problem type.

title string

A short summary of the problem type.

status int32

Possible values: >= 400 and <= 600

The HTTP status code generated by the origin server for this occurrence of the problem.

detail string

A human readable explanation specific to this occurrence of the problem.

instance uri

An absolute URI that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.

Example (from schema)

{
  "type": "about:blank",
  "title": "Internal Server Error",
  "status": 500,
  "detail": "Connection timeout",
  "instance": "string"
}

Bad Request

{
  "title": "Bad Request",
  "status": 400,
  "detail": "[\"scope must be a combination of 'openid' and one of the supported scopes ('did_write', 'tir_write')\"]",
  "type": "about:blank"
}

500

Internal Server Error

application/problem+json

Schema

Schema

type uri

Default value: about:blank

An absolute URI that identifies the problem type. When dereferenced, it SHOULD provide human-readable documentation for the problem type.

title string

A short summary of the problem type.

status int32

Possible values: >= 400 and <= 600

The HTTP status code generated by the origin server for this occurrence of the problem.

detail string

A human readable explanation specific to this occurrence of the problem.

instance uri

An absolute URI that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.

Example (from schema)

{
  "type": "about:blank",
  "title": "Internal Server Error",
  "status": 500,
  "detail": "Connection timeout",
  "instance": "string"
}

Internal Server Error

{
  "title": "Internal error",
  "status": 500,
  "detail": "Internal error"
}

Loading...