ClientAddressRemovedV1

v1.0.0

{
  "$id": "https://example.com/ClientAddressRemovedV1.json",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "ClientAddressRemovedV1",
  "description": "An event raised when a client removes an address from their account",
  "type": "object",
  "properties": {
    "metadata": {
      "type": "object",
      "properties": {
        "occurredAtUtc": {
          "type": "string",
          "description": "The date and time when the address removal event occurred in UTC (ISO 8601 format e.g., 2023-09-08T12:00:00Z)"
        },
        "typeName": {
          "type": "string",
          "description": "The name of the event. E.g., ClientAddressRemovedV1",
          "const": "ClientAddressRemovedV1"
        },
        "source": {
          "type": "string",
          "description": "The source of the event indicating where the removal was initiated (e.g., Internet, Mobile App)"
        },
        "version": {
          "type": "number",
          "description": "The version of the event schema"
        },
        "sentAtUtc": {
          "type": "string",
          "description": "The date and time when the event was sent by the publisher in ISO 8601 format"
        }
      },
      "required": [ "occurredAtUtc", "typeName", "sentAtUtc", "version" ]
    },
    "data": {
      "type": "object",
      "properties": {
        "clientId": {
          "type": "string",
          "description": "The GUID of the client"
        },
        "clientNumber": {
          "type": "number",
          "description": "The COS number of the client"
        },
        "accountNumber": {
          "type": "string",
          "description": "The transactional account number of the client"
        },
        "addressRemoved": {
          "type": "object",
          "properties": {
            "addressId": {
              "type": "string",
              "description": "The GUID of the address that was removed"
            },
            "firstLineOfAddress": {
              "type": "string",
              "description": "The first line of the address (e.g., street name and number)"
            },
            "city": {
              "type": "string",
              "description": "The city of the address"
            },
            "postalCode": {
              "type": "string",
              "description": "The postal code of the address"
            },
            "countryCode": {
              "type": "string",
              "description": "The country code associated with the address (e.g., US for United States)"
            }
          },
          "required": [ "addressId", "firstLineOfAddress", "countryCode" ]
        },
        "removedBySource": {
          "type": "string",
          "description": "Indicates the source that performed the deletion (e.g., My Christies)"
        },
        "removedAtUtc": {
          "type": "string",
          "description": "The date and time when the address was marked for removal (ISO 8601 format)"
        }
      },
      "required": [ "clientId", "accountNumber", "addressRemoved", "removedBySource", "removedAtUtc" ]
    }
  },
  "required": [ "metadata", "data" ]
}