TransactionalAccountAuthorisedUserAddedV1

v1.0.0

{
  "$id": "https://example.com/TransactionalAccountAuthorisedUserAddedV1.json",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "TransactionalAccountAuthorisedUserAddedV1",
  "description": "An event raised when a authorised user is added to a transactional account",
  "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 TransactionalAccountAuthorisedUserAddedV1"
        },
        "source": {
          "type": "string",
          "description": "The source of the event like was it genereated by Client using Web or WeChat, CRM"
        },
        "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"
        },
        "authorisedUserDetails":{
          "type": "object",
          "properties": {
            "client": {
              "type": "object",
              "properties": {
                "globalClientId": {
                  "type": "string",
                  "description": "The GUID of client"
                },
                "clientNumber": {
                  "type": "number",
                  "description": "The CRM number of the client"
                },
                "type": {
                  "type": "string",
                  "description": "The type of client, e.g. Person or Organisation"
                },
                "fullName": {
                  "type": "string",
                  "description": "The full name of the client"  
                }
              }
            },
            "type": {
                "type": "string",
                "description": "Authorised user type. Allowed values: AU-All: Bid, Collect, AU-One Sale: One Off, AU-Only Bidding, AU-Only Collecting, Account Holder, Created in Error."
            },
            "level": {
              "type": "string",
              "description": "The level of the authorised user. Allowed values 0, 1, 2. Values description 0- Standard Authorised User, 1- Authorised User Plus, 2- Super Authorised User"
            },
            "startAt": {
              "type": "string",
              "description": "The start date and time of the authorised user in ISO 8601 format"
            },
            "expiryAt": {
              "type": "string",
              "description": "The expiry date and time of the authorised user in ISO 8601 format"
            }
          }
        }
      }
    }
  }
}