GET 
https://api-conformance.ebsi.eu/trusted-schemas-registry/v2/schemas/:schemaId/revisions/:schemaRevisionId

Returns a trusted schema revision identified by its ID.

Request

Path Parameters

schemaId stringrequiredExamples:

schemaId

Description: Valid Conformance schemaId

Example: zGr1f1vZz3bk4PDAsYjM3eA76eMGdZ4XiQysU2HJjadc4

schemaRevisionId stringrequiredExamples:

schemaRevisionId

Description: Valid Conformance schemaRevisionId

Example: 0xf41f87656d579ee72ee2e10107c769255d9e41483501d6ab42b0fe312fa40062

Responses

200

Success

application/json

Schema

Schema

object

Example (from schema)

{}

Success

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "EBSI Verifiable Attestation",
  "description": "Schema of an EBSI Verifiable Attestation",
  "type": "object",
  "properties": {
    "@context": {
      "description": "Defines semantic context of the Verifiable Attestation",
      "type": "array",
      "items": {
        "type": "string",
        "format": "uri"
      }
    },
    "id": {
      "description": "Defines unique identifier of the Verifiable Attestation",
      "type": "string",
      "format": "uri"
    },
    "type": {
      "description": "Defines the Verifiable Credential type",
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "issuer": {
      "description": "Defines the issuer of the Verifiable Attestation",
      "type": "string",
      "format": "uri"
    },
    "issuanceDate": {
      "description": "Defines the date and time, when the Verifiable Attestation becomes valid",
      "type": "string",
      "format": "date-time"
    },
    "issued": {
      "description": "Defines when the Verifiable Attestation was issued",
      "type": "string",
      "format": "date-time"
    },
    "validFrom": {
      "description": "Defines the date and time, when the Verifiable Attestation becomes valid",
      "type": "string",
      "format": "date-time"
    },
    "validUntil": {
      "description": "Defines the date and time, when the Verifiable Attestation expires",
      "type": "string",
      "format": "date-time"
    },
    "expirationDate": {
      "description": "Defines the date and time, when the Verifiable Attestation expires",
      "type": "string",
      "format": "date-time"
    },
    "credentialSubject": {
      "description": "Defines information about the subject that is described by the Verifiable Attestation",
      "type": "object",
      "properties": {
        "id": {
          "description": "Defines the DID of the subject that is described by the Verifiable Attestation",
          "type": "string",
          "format": "uri"
        }
      }
    },
    "credentialStatus": {
      "description": "Contains information about how to verify the status of the Verifiable Attestation (via the Revocation and Endorsement Registry, RER)",
      "type": "object",
      "properties": {
        "id": {
          "description": "References record in the Revocation and Endorsement Registry (RER) to enable verification of a Verifiable Attestation’s validity",
          "type": "string",
          "format": "uri"
        },
        "type": {
          "description": "Defines the Verifiable Credential status type",
          "type": "string"
        },
        "statusPurpose": {
          "description": "Purpose of the status entry",
          "type": "string",
          "enum": [
            "revocation",
            "suspension"
          ]
        },
        "statusListIndex": {
          "description": "Integer expressed as a string. The zero based index value identifies the bit position of the status",
          "type": "string"
        },
        "statusListCredential": {
          "description": "URL referencing the StatusList2021Credential",
          "type": "string",
          "format": "uri"
        }
      },
      "required": [
        "id",
        "type"
      ]
    },
    "credentialSchema": {
      "description": "Contains information about the credential schema (template) on which the Verifiable Authorisation is based",
      "type": "object",
      "properties": {
        "id": {
          "description": "References the credential schema (template) stored on the (relevant) Trusted Schemas Registry (TSR) on which the Verifiable Authorisation is based",
          "type": "string",
          "format": "uri"
        },
        "type": {
          "description": "Defines credential schema type",
          "type": "string",
          "enum": [
            "FullJsonSchemaValidator2021"
          ]
        }
      },
      "required": [
        "id",
        "type"
      ]
    },
    "evidence": {
      "description": "Contains information about the process which resulted in the issuance of the Verifiable Attestation",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "description": "If present, it MUST contain a URL that points to where more information about this instance of evidence can be found.",
            "type": "string"
          },
          "type": {
            "description": "Defines the evidence type",
            "type": "array",
            "items": {
              "type": "string"
            }
          }
        },
        "required": [
          "id",
          "type"
        ]
      }
    },
    "proof": {
      "description": "Contains information about the proof",
      "type": "object",
      "properties": {
        "type": {
          "description": "Defines the proof type",
          "type": "string"
        },
        "proofPurpose": {
          "description": "Defines the purpose of the proof",
          "type": "string"
        },
        "created": {
          "description": "Defines the date and time, when the proof has been created",
          "type": "string",
          "format": "date-time"
        },
        "verificationMethod": {
          "description": "Contains information about the verification method / proof mechanisms",
          "type": "string"
        },
        "jws": {
          "description": "Defines the proof value in JWS format",
          "type": "string"
        }
      },
      "required": [
        "type",
        "proofPurpose",
        "created",
        "verificationMethod",
        "jws"
      ]
    }
  },
  "required": [
    "@context",
    "id",
    "type",
    "issuer",
    "issuanceDate",
    "issued",
    "validFrom",
    "credentialSubject",
    "credentialSchema"
  ]
}

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"
}

Invalid {schemaId} Parameter

{
  "title": "Bad Request",
  "status": 400,
  "detail": "The format of {schemaId} parameter is not valid"
}

404

Not found

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"
}

Schema Not Found

{
  "title": "Not found",
  "status": 404,
  "detail": "Not found"
}

Revision Not Found

{
  "title": "Not found",
  "status": 404,
  "detail": "Not found"
}

500

Internal Server Error

application/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"
}

Request Collapse all

Base URL

https://api-conformance.ebsi.eu

Parameters

schemaId — pathrequired

schemaRevisionId — pathrequired

ResponseClear

Click the Send API Request button above and see the response here!

• curl
• nodejs
• python
• go
• php
• java

• CURL

curl -L 'https://api-conformance.ebsi.eu/trusted-schemas-registry/v2/schemas/:schemaId/revisions/:schemaRevisionId' \
-H 'Accept: application/json'