Event Notification API Specification - TPP Endpoints

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/open-banking-uk/refs/heads/main/json-schema/event-notifications.json",
  "title": "Event Notification API Specification - TPP Endpoints",
  "description": "Swagger for Event Notification API Specification - TPP Endpoints.\n\n**Please Note**: There are no optional fields, if a field is not marked as \u201cRequired\u201d it is a Conditional field.\n",
  "version": "4.0.1",
  "$defs": {
    "OBEvent1": {
      "description": "Events.",
      "type": "object",
      "properties": {
        "urn:uk:org:openbanking:events:resource-update": {
          "$ref": "#/components/schemas/OBEventResourceUpdate1"
        }
      },
      "required": [
        "urn:uk:org:openbanking:events:resource-update"
      ],
      "additionalProperties": false
    },
    "OBEventLink1": {
      "description": "Resource links to other available versions of the resource.",
      "type": "object",
      "properties": {
        "version": {
          "description": "Resource version.",
          "type": "string",
          "minLength": 1,
          "maxLength": 10
        },
        "link": {
          "description": "Resource link.",
          "type": "string"
        }
      },
      "required": [
        "version",
        "link"
      ],
      "additionalProperties": false,
      "minProperties": 1
    },
    "OBEventNotification1": {
      "description": "The resource-update event.",
      "type": "object",
      "properties": {
        "iss": {
          "description": "Issuer.",
          "type": "string"
        },
        "iat": {
          "description": "Issued At. ",
          "type": "integer",
          "format": "int32",
          "minimum": 0
        },
        "jti": {
          "description": "JWT ID.",
          "type": "string",
          "minLength": 1,
          "maxLength": 128
        },
        "aud": {
          "description": "Audience.",
          "type": "string",
          "minLength": 1,
          "maxLength": 128
        },
        "sub": {
          "description": "Subject",
          "type": "string",
          "format": "uri"
        },
        "txn": {
          "description": "Transaction Identifier.",
          "type": "string",
          "minLength": 1,
          "maxLength": 128
        },
        "toe": {
          "description": "Time of Event.",
          "type": "integer",
          "format": "int32",
          "minimum": 0
        },
        "events": {
          "$ref": "#/components/schemas/OBEvent1"
        }
      },
      "required": [
        "iss",
        "iat",
        "jti",
        "aud",
        "sub",
        "txn",
        "toe",
        "events"
      ],
      "additionalProperties": false
    },
    "OBEventResourceUpdate1": {
      "description": "Resource-Update Event.",
      "type": "object",
      "properties": {
        "subject": {
          "$ref": "#/components/schemas/OBEventSubject1"
        }
      },
      "required": [
        "subject"
      ],
      "additionalProperties": false
    },
    "OBEventSubject1": {
      "description": "The resource-update event.",
      "type": "object",
      "properties": {
        "subject_type": {
          "description": "Subject type for the updated resource. ",
          "type": "string",
          "minLength": 1,
          "maxLength": 128
        },
        "http://openbanking.org.uk/rid": {
          "description": "Resource Id for the updated resource.",
          "type": "string",
          "minLength": 1,
          "maxLength": 128
        },
        "http://openbanking.org.uk/rty": {
          "description": "Resource Type for the updated resource.",
          "type": "string",
          "minLength": 1,
          "maxLength": 128
        },
        "http://openbanking.org.uk/rlk": {
          "items": {
            "$ref": "#/components/schemas/OBEventLink1"
          },
          "type": "array",
          "description": "Resource links to other available versions of the resource.",
          "minItems": 1
        }
      },
      "required": [
        "subject_type",
        "http://openbanking.org.uk/rid",
        "http://openbanking.org.uk/rty",
        "http://openbanking.org.uk/rlk"
      ],
      "additionalProperties": false
    }
  }
}