TransactionAccountAddressAddedV1

v1.0.0

{
  "$id": "https://example.com/TransactionAccountAddressV1.json",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "TransactionAccountAddressAddedV1",
  "description": "An event raised when a transaction account address is added",
  "type": "object",
  "properties": {
    "metadata": {
      "type": "object",
      "properties": {
       
        "occurredAtUtc": {
          "type": "string",
          "description": "The date and time when event occurred in UTC. Date should be represented in ISO 8601 format e.g 2023-09-08T12:00:00Z"
        },
        "typeName": {
          "type": "string",
          "description": "The name of the event. E.g TransactionAccountAddressAddedV1"
        },
        "source": {
          "type": "string",
          "description": "The source of the event like was it genereated by Client using Web or WeChat"
        },
        "applicationBreadcrumb": {
          "type": "string",
          "description": "Th application path which is describing the chain of applications. For e.g my-christies-web-ui;3.0.1:follows-api;v1.1.0"
        },
        "version":{
          "type": "string",
          "description": "The version of the message in semantic versioning format ideally V{major.minor.patch}. E.g V1.0.0 or just V{majorVersion}"
        },
        "sentAtUtc": {
          "type": "string",
          "description":  "When event was sent by the publishers in ISO 8601 "
        },
        "isTransactionalAccountAvailableForClient": {
          "type": "boolean",
          "description":  "Indicates if the transaction account for a client is available"
        }                 
      },
      "required": [ "occurredAtUtc", "typeName", "sentAtUtc", "version", "isTransactionalAccountAvailableForClient"]
    },
    "data": {
      "type": "object",
      "properties": {
        "globalTransactionAccountId": {
          "type": "string",
          "description": "The GUID of transaction account"
        },
        "accountNumber": {
          "type": "string",
          "description": "The account number of the transaction account"
        },
        "address":{
          "type": "object",
          "properties": {
              "globalClientAddressId": {
                "type": "string",
                "description": "The GUID of the address of the client"
              },
              "addressNumber": {
                "type": "number",
                "description": "The address number of the client"
              },
              "mailingNameLine1": {
                "type": "string",
                "description": "First line of the mailing name"
              },
              "mailingNameLine2": {
                "type": "string",
                "description": "Second line of the mailing name"
              },
              "line1": {
                "type": "string",
                "description": "First line of the address"
              },
              "line2": {
                "type": "string",
                "description": "Second line of the address"
              },
              "line3": {
                "type": "string",
                "description": "Third line of the address"
              },
              "city": {
                "type": "string",
                "description": "City of the address"
              },
              "state": {
                "type": "string",
                "description": "State"
              },
              "county": {
                "type": "string",
                "description": "County name"
              },
              "postalCode": {
                "type": "string",
                "description": "Postal code"
              },
              "country": {
                "type": "string",
                "description": "Country"
              },
              "status": {
                "type": "string",
                "description": "Address Status. Allowed values: Current, Do Not Use, Incorrect, Old"
              },
              "type": {
                "type": "string",
                "description": "Address Type. Allowed values: Business, Holiday Home, Home, Other Home, Registered, Residential, Temporary"
              }
          }
        },
        "alternativeLanguageAddress":{
          "type": "object",
          "properties": {
              "language": {
                "type": "string",
                "description": "Alternative language"
              },
              "mailingNameLine1": {
                "type": "string",
                "description": "First line of the mailing name in alternative language"
              },
              "mailingNameLine2": {
                "type": "string",
                "description": "Second line of the mailing name in alternative language"
              },
              "line1": {
                "type": "string",
                "description": "First line of the address in alternative language"
              },
              "line2": {
                "type": "string",
                "description": "Second line of the address in alternative language"
              },
              "line3": {
                "type": "string",
                "description": "Third line of the address in alternative language"
              },
              "city": {
                "type": "string",
                "description": "City in alternative language"
              },
              "state": {
                "type": "string",
                "description": "State in alternative language"
              },
              "county": {
                "type": "string",
                "description": "County in alternative language"
              },
              "postalCode": {
                "type": "string",
                "description": "Postal code in alternative language"
              },
              "country": {
                "type": "string",
                "description": "Country in alternative language"
              }
          }
        }

      }
    }
  }
}